Fix #1492: Add PIPX_GLOBAL_(HOME|BIN_DIR|MAN_DIR) documentation and list them in pipx environment

[viscruocco]

Fixed #1492

• I have added a news fragment under changelog.d/ (if the patch affects the end users)

Summary of changes

• Added PIPX_GLOBAL_HOME, PIPX_GLOBAL_BIN_DIR and PIPX_GLOBAL_MAN_DIR to output of pipx environment under the Environment variables (set by user) section.
• Added documentation of the PIPX_GLOBAL_* vars in pipx --help, pipx install --help, pipx environment --help and installation.md.

Test plan

Tested by running

$ pipx environment
$ pipx environment --global
$ pipx environment --help
$ pipx install --help

[chrysle]

Could you also add a test for these variables, please?

[viscruocco]

Could you also add a test for these variables, please?

Is this minimal test expansion sufficient?
2bbce3c

[chrysle]

I'd like to also test the paths, though not strictly necessary.

[viscruocco]

I'd like to also test the paths, though not strictly necessary.

Actually there are no paths to check here, because the variables are just added to the set by user section, which is not populated in the tests at all:

$ pipx environment --global
Environment variables (set by user):

PIPX_HOME=
PIPX_GLOBAL_HOME=             # <-- added
PIPX_BIN_DIR=
PIPX_GLOBAL_BIN_DIR=          # <-- added
PIPX_MAN_DIR=
PIPX_GLOBAL_MAN_DIR=          # <-- added
PIPX_SHARED_LIBS=
PIPX_DEFAULT_PYTHON=
PIPX_FETCH_MISSING_PYTHON=
USE_EMOJI=
PIPX_HOME_ALLOW_SPACE=

Derived values (computed by pipx):

PIPX_HOME=/opt/pipx
PIPX_BIN_DIR=/usr/local/bin
PIPX_MAN_DIR=/usr/local/share/man
PIPX_SHARED_LIBS=/opt/pipx/shared
PIPX_LOCAL_VENVS=/opt/pipx/venvs
PIPX_LOG_DIR=/opt/pipx/logs
PIPX_TRASH_DIR=/opt/pipx/trash
PIPX_VENV_CACHEDIR=/opt/pipx/.cache
PIPX_STANDALONE_PYTHON_CACHEDIR=/opt/pipx/py
PIPX_DEFAULT_PYTHON=/usr/local/bin/python3.12
USE_EMOJI=true
PIPX_HOME_ALLOW_SPACE=false

[Gitznik]

This looks good to me. Also nice improvement on the docs themselves 👍

[chrysle]

Actually there are no paths to check here

Yep, I thought about creating a separate test and populating these variables manually, to verify they take effect.

[viscruocco]

Yep, I thought about creating a separate test and populating these variables manually, to verify they take effect.

I'm sorry, I think this is a slightly bigger change than what I'm in for right now. I hope it's okay if I leave it at that.

[chrysle]

I'm sorry, I think this is a slightly bigger change than what I'm in for right now. I hope it's okay if I leave it at that.

Sure, no problem!

[chrysle]

LGTM, thanks! Please rebase or merge.