From 302ecf824c961665cf0aead98f65099eacec04e8 Mon Sep 17 00:00:00 2001 From: Kevin Boyd Date: Wed, 27 Nov 2024 07:30:21 -0800 Subject: [PATCH] Update wording of process-timeout description (#12211) Cleans up the description of process-timeout to better separate the config setting from the static helper for script commands. --- doc/06-config.md | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) diff --git a/doc/06-config.md b/doc/06-config.md index bff70d03d..85a138b6a 100644 --- a/doc/06-config.md +++ b/doc/06-config.md @@ -6,10 +6,22 @@ This chapter will describe the `config` section of the `composer.json` ## process-timeout The timeout in seconds for process executions, defaults to 300 (5mins). -The duration processes like git clones can run before +The duration processes like `git clone`s can run before Composer assumes they died out. You may need to make this higher if you have a slow connection or huge vendors. +Example: + +```json +{ + "config": { + "process-timeout": 900 + } +} +``` + +### Disabling timeouts for an individual script command + To disable the process timeout on a custom command under `scripts`, a static helper is available: