Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation: Add some missing environment variable added during a build #5363

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

kit-ty-kate
Copy link
Member

No description provided.

Comment on lines 1115 to 1122
- `CDPATH=`
- `MAKEFLAGS=`
- `MAKELEVEL=`
- `OPAM_SWITCH_PREFIX=<switch prefix>`
- `OPAMSWITCH=<switch name>`
- `OPAM_PACKAGE_NAME=<pkg>` (`<pkg>` is the name of the package being built/installed/removed)
- `OPAM_PACKAGE_VERSION=<ver>` (`<ver>` is the version of the package being built/installed/removed)
- `OPAMCLI=2.0` (since opam 2.1)
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- `CDPATH=`
- `MAKEFLAGS=`
- `MAKELEVEL=`
- `OPAM_SWITCH_PREFIX=<switch prefix>`
- `OPAMSWITCH=<switch name>`
- `OPAM_PACKAGE_NAME=<pkg>` (`<pkg>` is the name of the package being built/installed/removed)
- `OPAM_PACKAGE_VERSION=<ver>` (`<ver>` is the version of the package being built/installed/removed)
- `OPAMCLI=2.0` (since opam 2.1)
- can be overridden by `build-env`:
- `CDPATH=`
- `MAKEFLAGS=`
- `MAKELEVEL=`
- `OPAM_PACKAGE_NAME=<pkg>` (`<pkg>` is the name of the package being built/installed/removed)
- `OPAM_PACKAGE_VERSION=<ver>` (`<ver>` is the version of the package being built/installed/removed)
- `OPAMCLI=2.0` (since opam 2.1)
- non overwritable:
- `OPAMROOT`=<opam root path>`
- `OPAMSWITCH=<switch name>`
- `OPAM_SWITCH_PREFIX=<switch prefix>`

we should add a test about that

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There is also PATH and MANPATH that have switch path & manpath added to their value ; and they can be redefined via build-env.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

And there is also all environment variables defined by other packages (setenv)

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

See test in #5377

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Development

Successfully merging this pull request may close these issues.

None yet

2 participants