commit:     dabb1f76df1fe26cdf1b79d235b4ee3f0a9464cb
Author:     Göktürk Yüksek <gokturk <AT> gentoo <DOT> org>
AuthorDate: Thu Nov 28 18:28:59 2019 +0000
Commit:     Göktürk Yüksek <gokturk <AT> gentoo <DOT> org>
CommitDate: Thu Nov 28 18:32:29 2019 +0000
URL:        https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=dabb1f76

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 <AT> gentoo.org>

 ebuild-writing/variables/text.xml | 21 ++++++++-------------
 1 file 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>
 

Reply via email to