From 7023767501baf7863e4d9dd4edaa15ae2a40dfdd Mon Sep 17 00:00:00 2001 From: Jordi Boggiano Date: Sat, 8 Sep 2012 00:44:19 +0200 Subject: [PATCH] Update docs and schema for new config option --- doc/04-schema.md | 3 +++ res/composer-schema.json | 15 +++++++++++++++ 2 files changed, 18 insertions(+) diff --git a/doc/04-schema.md b/doc/04-schema.md index fe5428adb..a8b75b10e 100644 --- a/doc/04-schema.md +++ b/doc/04-schema.md @@ -567,6 +567,9 @@ The following options are supported: * **process-timeout:** Defaults to `300`. The duration processes like git clones can run before Composer assumes they died out. You may need to make this higher if you have a slow connection or huge vendors. +* **github-protocols:** Defaults to `["git", "https", "http"]`. A list of + protocols to use for github.com clones, in priority order. Use this if you are + behind a proxy or have somehow bad performances with the git protocol. * **notify-on-install:** Defaults to `true`. Composer allows repositories to define a notification URL, so that they get notified whenever a package from that repository is installed. This option allows you to disable that behaviour. diff --git a/res/composer-schema.json b/res/composer-schema.json index 285b01cee..23c70c88e 100644 --- a/res/composer-schema.json +++ b/res/composer-schema.json @@ -115,6 +115,21 @@ "bin-dir": { "type": "string", "description": "The location where all binaries are linked, defaults to \"vendor/bin\"." + }, + "process-timeout": { + "type": "integer", + "description": "The timeout in seconds for process executions, defaults to 300 (5mins)." + }, + "notify-on-install": { + "type": "boolean", + "description": "Composer allows repositories to define a notification URL, so that they get notified whenever a package from that repository is installed. This option allows you to disable that behaviour, defaults to true." + }, + "github-protocols": { + "type": "array", + "description": "A list of protocols to use for github.com clones, in priority order, defaults to [\"git\", \"https\", \"http\"].", + "items": { + "type": "string" + } } } },