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

$home -> $COMPOSER_HOME (#10363) 

the `$home` variable referenced in the conifguration docs for data- and
cache-dir is a reference to an internal PHP variable that contains the
composer home directory.

as on the documentation page it is not visible where that variable comes
from (the document uses only shell/environment variables otherwise) these
two places are hard to read/understand.

the exact meaning of `$home` (lowercase) is the composer-home (or just
home) global configuration setting (composer home is for all user-wide
composer invocations, to store data in the filesystem namespace of the
user executing composer).

that meaning is better documented with the `$COMPOSER_HOME` environment
variable (which when it does not exists the default value is well
documented in [03-cli.md#composer-home].

replace `$home` with `$COMPOSER_HOME`.

additionally small typo fix on "rollback" which is "roll back".

discussion: #10363
[03-cli.md#composer-home]: doc/03-cli.md#composer-home
pull/10371/head
Tom Klingenberg 2021-12-19 14:05:57 +01:00 committed by GitHub
parent d274bf0313
commit 692de949de
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
doc/06-config.md
View File

@ -253,8 +253,8 @@ into this directory.
Defaults to `C:\Users\<user>\AppData\Roaming\Composer` on Windows,
`$XDG_DATA_HOME/composer` on unix systems that follow the XDG Base Directory
Specifications, and `$home` on other unix systems. Right now it is only
used for storing past composer.phar files to be able to rollback to older
Specifications, and `$COMPOSER_HOME` on other unix systems. Right now it is only
used for storing past composer.phar files to be able to roll back to older
versions. See also [COMPOSER_HOME](03-cli.md#composer-home).
## cache-dir
@ -262,8 +262,8 @@ versions. See also [COMPOSER_HOME](03-cli.md#composer-home).
Defaults to `C:\Users\<user>\AppData\Local\Composer` on Windows,
`/Users/<user>/Library/Caches/composer` on macOS, `$XDG_CACHE_HOME/composer`
on unix systems that follow the XDG Base Directory Specifications, and
`$home/cache` on other unix systems. Stores all the caches used by Composer.
See also [COMPOSER_HOME](03-cli.md#composer-home).
`$COMPOSER_HOME/cache` on other unix systems. Stores all the caches used by
Composer. See also [COMPOSER_HOME](03-cli.md#composer-home).
## cache-files-dir