diff options
| author |   Göktürk Yüksek <gokturk@gentoo.org> | 2019-11-28 13:28:59 -0500 |
|---|---|---|
| committer | Göktürk Yüksek <gokturk@gentoo.org> | 2019-11-28 13:32:29 -0500 |
| commit | dabb1f76df1fe26cdf1b79d235b4ee3f0a9464cb (patch) | |
| tree | b3f1ba190473387d98deb2ea931daa3d969021ad | |
| parent | ebuild-writing/variables: fix the trailing slash in ROOT for EAPI7 (diff) | |
| download | devmanual-dabb1f76.tar.gz devmanual-dabb1f76.tar.bz2 devmanual-dabb1f76.zip | |
ebuild-writing/variables: update the paragraph about trailing slashes
The information dates back to pre-EAPI7 era and incorrectly states
that ROOT etc. always end with a trailing slash, which is incorrect
with EAPI7. Update the text to reflect both EAPI7 and pre-EAPI7
practices and suggest the bash suffix removal for pre-EAPI7 ebuilds to
ease transition.
Signed-off-by: Göktürk Yüksek <gokturk@gentoo.org>
| -rw-r--r-- | ebuild-writing/variables/text.xml | 21 |
1 files changed, 8 insertions, 13 deletions
diff --git a/ebuild-writing/variables/text.xml b/ebuild-writing/variables/text.xml index ffd2597..b6c84f7 100644 --- a/ebuild-writing/variables/text.xml +++ b/ebuild-writing/variables/text.xml @@ -644,21 +644,16 @@ follows. <body> <p> -The following variables always end in a trailing slash by default: -<c>D</c>, <c>ED</c>, <c>ROOT</c>, <c>EROOT</c>. Therefore, there is no -need to suffix them with <c>/</c> when joining paths. +The following variables never end with a trailing slash in EAPI 7: +<c>D</c>, <c>ED</c>, <c>ROOT</c>, <c>EROOT</c>. Conversely, in EAPIS +preceeding EAPI 7, these variables are guaranteed to end with a +trailing slash. When working with EAPIs prior to EAPI 7, developers +are encouraged to use the bash suffix removal for the trailing slash +and add an explicit <c>/</c> when joining paths. For example: +<c>${D%/}/</c>, <c>${ED%/}/</c>, <c>${ROOT%/}/</c>, +<c>${EROOT%/}/</c>. </p> -<note> -Future EAPI may remove the trailing slash at the end per -<uri link="https://bugs.gentoo.org/465772">Bug 465772</uri>. -To ease the transition, and ensure maximum compatibility with both the -current and the future EAPI, developers are encouraged to use the bash -suffix removal for the trailing slash and add an explicit <c>/</c> -when joining paths. For example: <c>${D%/}/</c>, <c>${ED%/}/</c>, -<c>${ROOT%/}/</c>, <c>${EROOT%/}/</c>. -</note> - </body> </section> |