commit: dd772c7c3461de8f6625145e9a7715b6a9fecbb2
Author: James Le Cuirot <chewi <AT> gentoo <DOT> org>
AuthorDate: Tue Jul 22 22:22:55 2025 +0000
Commit: James Le Cuirot <chewi <AT> gentoo <DOT> org>
CommitDate: Tue Jul 22 22:23:49 2025 +0000
URL: https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=dd772c7c
ebuild-writing/variables: Clarify definitions of BROOT and ESYSROOT
The precise definition of ESYSROOT is hard to explain, but ebuild
writers only need to know what it might be set to and what it's commonly
used for.
Signed-off-by: James Le Cuirot <chewi <AT> gentoo.org>
ebuild-writing/variables/text.xml | 20 ++++++++++++--------
1 file changed, 12 insertions(+), 8 deletions(-)
diff --git a/ebuild-writing/variables/text.xml
b/ebuild-writing/variables/text.xml
index 126cefb..e2e2789 100644
--- a/ebuild-writing/variables/text.xml
+++ b/ebuild-writing/variables/text.xml
@@ -133,23 +133,27 @@ for these variables when writing ebuilds.
</ti>
</tr>
<tr>
- <ti><c>SYSROOT</c></ti>
+ <ti><c>BROOT</c></ti>
<ti>
- (EAPI=7) The absolute path to the root directory containing build
dependencies
- satisfied by <c>DEPEND</c>
+ (EAPI=7) The absolute path to the prefixed root directory
+ containing build dependencies satisfied by <c>BDEPEND</c>, which
+ are typically executable build tools. Usually blank. Not
+ necessarily the same as <c>EPREFIX</c>.
</ti>
</tr>
<tr>
- <ti><c>ESYSROOT</c></ti>
+ <ti><c>SYSROOT</c></ti>
<ti>
- (EAPI=7) Shorthand for <c>${SYSROOT%/}${EPREFIX}/</c>.
+ (EAPI=7) The absolute path to the root directory containing build
+ dependencies satisfied by <c>DEPEND</c>.
</ti>
</tr>
<tr>
- <ti><c>BROOT</c></ti>
+ <ti><c>ESYSROOT</c></ti>
<ti>
- (EAPI=7) The absolute path to the root directory containing build
dependencies
- satisfied by <c>BDEPEND</c>, typically executable build tools.
+ (EAPI=7) The same as either <c>EROOT</c> or <c>BROOT</c> depending
+ on the value of <c>SYSROOT</c>. Commonly used to reference the
+ location of headers and libraries at build time.
</ti>
</tr>
<tr>
