From e5010b45f289be210fdddf1720b75f229c190f79 Mon Sep 17 00:00:00 2001 From: Kate Date: Mon, 21 Nov 2022 16:20:44 +0000 Subject: [PATCH] Documentation: Add some missing environment variable added during a build Co-authored-by: Raja Boujbel --- doc/pages/Manual.md | 17 +++++++++++------ master_changes.md | 1 + 2 files changed, 12 insertions(+), 6 deletions(-) diff --git a/doc/pages/Manual.md b/doc/pages/Manual.md index 070e8e16591..1b579a711e0 100644 --- a/doc/pages/Manual.md +++ b/doc/pages/Manual.md @@ -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=` (`` is the name of the package being built/installed/removed) - - `OPAM_PACKAGE_VERSION=` (`` 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=` (`` is the name of the package being built/installed/removed) + - `OPAM_PACKAGE_VERSION=` (`` is the version of the package being built/installed/removed) + - `OPAMCLI=2.0` (since opam 2.1) + - non overwritable: + - `OPAMROOT`=` + - `OPAMSWITCH=` + - `OPAM_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) diff --git a/master_changes.md b/master_changes.md index ca710438b6a..3e8a1899ba6 100644 --- a/master_changes.md +++ b/master_changes.md @@ -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