Browse Source

Update docs and schema for new config option

Jordi Boggiano 12 năm trước cách đây
mục cha
commit
7023767501
2 tập tin đã thay đổi với 18 bổ sung0 xóa
  1. 3 0
      doc/04-schema.md
  2. 15 0
      res/composer-schema.json

+ 3 - 0
doc/04-schema.md

@@ -567,6 +567,9 @@ The following options are supported:
 * **process-timeout:** Defaults to `300`. The duration processes like git clones
 * **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
   can run before Composer assumes they died out. You may need to make this
   higher if you have a slow connection or huge vendors.
   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
 * **notify-on-install:** Defaults to `true`. Composer allows repositories to
   define a notification URL, so that they get notified whenever a package from
   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.
   that repository is installed. This option allows you to disable that behaviour.

+ 15 - 0
res/composer-schema.json

@@ -115,6 +115,21 @@
                 "bin-dir": {
                 "bin-dir": {
                     "type": "string",
                     "type": "string",
                     "description": "The location where all binaries are linked, defaults to \"vendor/bin\"."
                     "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"
+                    }
                 }
                 }
             }
             }
         },
         },