From 692de949de1a69bfe8d1bc87ba24b1e8ed2d2852 Mon Sep 17 00:00:00 2001 From: Tom Klingenberg <352517+ktomk@users.noreply.github.com> Date: Sun, 19 Dec 2021 14:05:57 +0100 Subject: [PATCH] $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 --- doc/06-config.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/doc/06-config.md b/doc/06-config.md index 7bde6bfb8..b546f5322 100644 --- a/doc/06-config.md +++ b/doc/06-config.md @@ -253,8 +253,8 @@ into this directory. Defaults to `C:\Users\\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\\AppData\Local\Composer` on Windows, `/Users//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