1
0
Fork 0
composer/doc
Tom Klingenberg 692de949de
$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
2021-12-19 14:05:57 +01:00
..
articles Add composer platform package with exact Composer version (#10313) 2021-11-27 14:26:57 +01:00
dev Prioritize repository over package versions in the default policy, fixes #3509 2015-04-30 10:43:04 +01:00
faqs Added link to composer-allow-superuser (#10215) 2021-10-26 17:43:03 +02:00
fixtures Fix EOL of text files (#9877) 2021-05-12 15:19:52 +02:00
00-intro.md docs: Highlight sudo (#10367) 2021-12-19 10:59:13 +01:00
01-basic-usage.md Improve some linking 2021-11-23 14:48:47 +01:00
02-libraries.md Make a note about lower casing of package names (#9883) 2021-05-17 22:18:06 +02:00
03-cli.md Fix PHP x spacing 2021-12-19 12:38:45 +01:00
04-schema.md Expose path to autoload in a global var for binaries (#10137) 2021-11-25 09:53:03 +01:00
05-repositories.md Make it explicitly clear that `dev-` shouldn't be in the actual branch name. (#10335) 2021-12-07 21:22:17 +01:00
06-config.md $home -> $COMPOSER_HOME (#10363) 2021-12-19 14:05:57 +01:00
07-runtime.md Doc clarification 2021-11-30 09:46:38 +01:00
08-community.md Rename master branch to main 2021-10-14 16:21:47 +02:00