diff options
| author |   Michał Górny <mgorny@gentoo.org> | 2024-06-01 11:22:32 +0200 |
|---|---|---|
| committer | Michał Górny <mgorny@gentoo.org> | 2024-06-14 14:26:06 +0200 |
| commit | 4c9973d691bf1842f7a1fcefc90e31872054bc94 (patch) | |
| tree | 4196ff08b210e7e0c650eedc12706506f928f159 /eclass | |
| parent | distutils-r1.eclass: Doc DISTUTILS_IN_SOURCE_BUILD as deprecated (diff) | |
| download | gentoo-4c9973d691bf1842f7a1fcefc90e31872054bc94.tar.gz gentoo-4c9973d691bf1842f7a1fcefc90e31872054bc94.tar.bz2 gentoo-4c9973d691bf1842f7a1fcefc90e31872054bc94.zip | |
distutils-r1.eclass: Document BUILD_DIR for consistency
Closes: https://bugs.gentoo.org/910661
Signed-off-by: Michał Górny <mgorny@gentoo.org>
Diffstat (limited to 'eclass')
| -rw-r--r-- | eclass/distutils-r1.eclass | 16 |
1 files changed, 16 insertions, 0 deletions
diff --git a/eclass/distutils-r1.eclass b/eclass/distutils-r1.eclass index 2b610a4d2ceb..3d72a5d3d554 100644 --- a/eclass/distutils-r1.eclass +++ b/eclass/distutils-r1.eclass @@ -206,6 +206,22 @@ esac # the build system in pure Python packages and packages using the stable # Python ABI. +# @ECLASS_VARIABLE: BUILD_DIR +# @OUTPUT_VARIABLE +# @DEFAULT_UNSET +# @DESCRIPTION: +# The current build directory. In global scope, it is supposed to +# contain an initial build directory; if unset, it defaults to ${S}. +# +# When running in multi-impl mode, the BUILD_DIR variable is set +# by python-r1.eclass. Otherwise, it is set by distutils-r1.eclass +# for consistency. +# +# Example value: +# @CODE +# ${WORKDIR}/foo-1.3-python3_12 +# @CODE + if [[ -z ${_DISTUTILS_R1_ECLASS} ]]; then _DISTUTILS_R1_ECLASS=1 |