From 63b3bc61b292b8e9744e3fba2dea626b6fc6925c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Kocsis=20M=C3=A1t=C3=A9?= Date: Tue, 3 Feb 2015 21:06:53 +0100 Subject: [PATCH] Added docs for bin-compat --- doc/04-schema.md | 6 ++++++ res/composer-schema.json | 4 ++++ 2 files changed, 10 insertions(+) diff --git a/doc/04-schema.md b/doc/04-schema.md index e422d5c38..4ff9b0c59 100644 --- a/doc/04-schema.md +++ b/doc/04-schema.md @@ -783,6 +783,12 @@ The following options are supported: dist (zip, tar, ..) packages that it downloads. When the garbage collection is periodically ran, this is the maximum size the cache will be able to use. Older (less used) files will be removed first until the cache fits. +* **bin-compat:** Defaults to `auto`. Determines the compatibility of the binaries + to be installed. If it is `auto` then Composer tries to automatically guess + which compatibility mode to use. If it is `nosymlink` then the binaries will be + compatible with Unix-based operating systems (useful for cases when symlinks are + not available). If its value is `full` then both .bat files for Windows and scripts + for Unix-based operating systems will be installed for each binary. * **prepend-autoloader:** Defaults to `true`. If false, the composer autoloader will not be prepended to existing autoloaders. This is sometimes required to fix interoperability issues with other autoloaders. diff --git a/res/composer-schema.json b/res/composer-schema.json index 4c40bdfb2..4fad42ce9 100644 --- a/res/composer-schema.json +++ b/res/composer-schema.json @@ -181,6 +181,10 @@ "type": ["string", "integer"], "description": "The cache max size for the files cache, defaults to \"300MiB\"." }, + "bin-compat": { + "type": "string", + "description": "The compatibility of the binaries, defaults to \"auto\" (automatically guessed) and can be \"nosymlink\" (compatible with Unix-based systems) or \"full\" (compatible with both Windows and Unix-based systems)." + }, "discard-changes": { "type": ["string", "boolean"], "description": "The default style of handling dirty updates, defaults to false and can be any of true, false or \"stash\"."