Skip to content

Commit

Permalink
[DOC] Clarify PREFIX usage in environment variables (#5065)
Browse files Browse the repository at this point in the history
* Clarify `LIBRARY_*`, `SCRIPT`, & `LD_RUN_PATH` use `PREFIX`

Saying `<build prefix>` now implies `BUILD_PREFIX`, which isn't the
case. AFAIK these have always been constructed based on `PREFIX`, which
is the host environment. Guessing this is just leftover verbiage that
needs a refresh.

* Add `BUILD_PREFIX` to environment variables
  • Loading branch information
jakirkham authored Nov 20, 2023
1 parent 9eaa9fc commit 67cc72e
Showing 1 changed file with 13 additions and 11 deletions.
24 changes: 13 additions & 11 deletions docs/source/user-guide/environment-variables.rst
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,8 @@ inherited from the shell environment in which you invoke
environment variable and defaults to the architecture the
interpreter running conda was
compiled with.
* - BUILD_PREFIX
- Build prefix where command line tools are installed.
* - CMAKE_GENERATOR
- The CMake generator string for the current build
environment. On Linux systems, this is always
Expand Down Expand Up @@ -92,7 +94,7 @@ inherited from the shell environment in which you invoke
- Inherited from your shell environment and augmented with
``$PREFIX/bin``.
* - PREFIX
- Build prefix to which the build script should install.
- Host prefix to which the build script should install.
* - PKG_BUILDNUM
- Build number of the package being built.
* - PKG_NAME
Expand All @@ -110,11 +112,11 @@ inherited from the shell environment in which you invoke
is installed only in the host prefix when it is listed as
a host requirement.
* - PY3K
- ``1`` when Python 3 is installed in the build prefix,
- ``1`` when Python 3 is installed in the host prefix,
otherwise ``0``.
* - R
- Path to the R executable in the build prefix. R is only
installed in the build prefix when it is listed as a build
- Path to the R executable in the host prefix. R is only
installed in the host prefix when it is listed as a build
requirement.
* - RECIPE_DIR
- Directory of the recipe.
Expand All @@ -132,7 +134,7 @@ inherited from the shell environment in which you invoke

Unix-style packages on Windows, which are usually statically
linked to executables, are built in a special ``Library``
directory under the build prefix. The environment variables
directory under the host prefix. The environment variables
listed in the following table are defined only on Windows.

.. list-table::
Expand All @@ -142,15 +144,15 @@ listed in the following table are defined only on Windows.
- Same as PREFIX, but as a Unix-style path, such as
``/cygdrive/c/path/to/prefix``.
* - LIBRARY_BIN
- ``<build prefix>\Library\bin``.
- ``%PREFIX%\Library\bin``.
* - LIBRARY_INC
- ``<build prefix>\Library\include``.
- ``%PREFIX%\Library\include``.
* - LIBRARY_LIB
- ``<build prefix>\Library\lib``.
- ``%PREFIX%\Library\lib``.
* - LIBRARY_PREFIX
- ``<build prefix>\Library``.
- ``%PREFIX%\Library``.
* - SCRIPTS
- ``<build prefix>\Scripts``.
- ``%PREFIX%\Scripts``.
* - VS_MAJOR
- The major version number of the Visual Studio version
activated within the build, such as ``9``.
Expand Down Expand Up @@ -196,7 +198,7 @@ defined only on Linux.
:widths: 20 80

* - LD_RUN_PATH
- ``<build prefix>/lib``.
- ``$PREFIX/lib``.


.. _git-env:
Expand Down

0 comments on commit 67cc72e

Please sign in to comment.