Skip to content

Commit

Permalink
Documentation: Add some missing environment variable added during a b…
Browse files Browse the repository at this point in the history
…uild

Co-authored-by: Raja Boujbel <raja.boujbel@ocamlpro.com>
  • Loading branch information
kit-ty-kate and rjbou committed Aug 7, 2024
1 parent 6effccc commit e5010b4
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 6 deletions.
17 changes: 11 additions & 6 deletions doc/pages/Manual.md
Original file line number Diff line number Diff line change
Expand Up @@ -1186,12 +1186,17 @@ files.
build, install and remove scripts.

The following environment variables are set by opam (but 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)
- 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>`
- `TMP` and `TMPDIR` are set by the sandbox script (bubblewrap), but should not be relied on since the sandbox is not used on all platforms and can be disabled by the user.
- `CYGWIN=winsymlinks:native` on Windows, or `CYGWIN=$CYGWIN winsymlinks:native` if `CYGWIN` is defined and not empty and `CYGWIN` does not contain either `winsymlinks:native` or `winsymlinks:nativestrict` already (since opam 2.2). In some cases `noglob` can also be added to this variable, such that the default value becomes `CYGWIN=winsymlinks:native noglob` (since opam 2.1)

Expand Down
1 change: 1 addition & 0 deletions master_changes.md
Original file line number Diff line number Diff line change
Expand Up @@ -167,6 +167,7 @@ users)
* Add a brief note about version ordering and an OCaml REPL example [#6119 @mbarbin]
* Update the installation documentation after the release of opam 2.2 [#6138 @kit-ty-kate]
* Fix formatting of inline code in `Environment update portability` section [#6141 @shonfeder]
* Add some missing environment variable added during a build [#5363 @kit-ty-kate @rjbou]

## Security fixes

Expand Down

0 comments on commit e5010b4

Please sign in to comment.