public-mirrors
/
composer
mirror of https://github.com/composer/composer
1
0
Fork 0
Code

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.
pull/11772/merge
Kevin Boyd 2024-11-27 07:30:21 -08:00 committed by GitHub
parent 5eeba719d3
commit 302ecf824c
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 13 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
doc/06-config.md
View File

@ -6,10 +6,22 @@ This chapter will describe the `config` section of the `composer.json`
## process-timeout ## process-timeout
The timeout in seconds for process executions, defaults to 300 (5mins). 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 Composer assumes they died out. You may need to make this higher if you have a
slow connection or huge vendors. 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 To disable the process timeout on a custom command under `scripts`, a static
helper is available: helper is available: