[gentoo-commits] proj/devmanual:master commit in: ebuild-writing/variables/

public inbox for gentoo-commits@lists.gentoo.org
 help / color / mirror / Atom feed

From: "Göktürk Yüksek" <gokturk@gentoo.org>
To: gentoo-commits@lists.gentoo.org
Subject: [gentoo-commits] proj/devmanual:master commit in: ebuild-writing/variables/
Date: Fri, 28 Oct 2016 14:21:56 +0000 (UTC)	[thread overview]
Message-ID: <1477434659.1d5e96b5ef5eb637ea7aaa477eaeca56fad9a4fe.gokturk@gentoo> (raw)

commit:     1d5e96b5ef5eb637ea7aaa477eaeca56fad9a4fe
Author:     Göktürk Yüksek <gokturk <AT> gentoo <DOT> org>
AuthorDate: Tue Oct 25 22:30:59 2016 +0000
Commit:     Göktürk Yüksek <gokturk <AT> gentoo <DOT> org>
CommitDate: Tue Oct 25 22:30:59 2016 +0000
URL:        https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=1d5e96b5

ebuild-writing/variables: move the trailing slash issue to a separate section

The ROOT section talks about using ${ROOT%/}/ notation to accommodate
for the upcoming EAPI. The variables D, ED, and EROOT also end in a
trailing slash. Create a separate section to talk about this issue.

Suggested-By: David Seifert <soap <AT> gentoo.org>

 ebuild-writing/variables/text.xml | 34 +++++++++++++++++++++++-----------
 1 file changed, 23 insertions(+), 11 deletions(-)

diff --git a/ebuild-writing/variables/text.xml b/ebuild-writing/variables/text.xml
index eb8770d..f402070 100644
--- a/ebuild-writing/variables/text.xml
+++ b/ebuild-writing/variables/text.xml
@@ -457,19 +457,8 @@ pkg_postinst() {
 	fi
 }
 </codesample>
-
-The <c>ROOT</c> variable always ends in a trailing slash. Therefore,
-there is no need to suffix it with <c>/</c> when joining paths.
 </p>
 
-<note>
-Future EAPI may remove the trailing slash at the end per
-<uri link="https://bugs.gentoo.org/465772">Bug 465722</uri>.
-Developers can use <c>${ROOT%/}</c> to ensure maximum compatibility
-with both the current and the future EAPI.
-</note>
-
-
 </body>
 </section>
 
@@ -565,5 +554,28 @@ follows.
 </body>
 </section>
 
+<section>
+<title>Trailing Slashes in Variables</title>
+<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.
+</p>
+
+<note>
+Future EAPI may remove the trailing slash at the end per
+<uri link="https://bugs.gentoo.org/465772">Bug 465722</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>
+
 </chapter>
 </guide>

next             reply	other threads:[~2016-10-28 14:22 UTC|newest]

Thread overview: 57+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2016-10-28 14:21 Göktürk Yüksek [this message]
  -- strict thread matches above, loose matches on Subject: below --
2025-09-20 13:24 [gentoo-commits] proj/devmanual:master commit in: ebuild-writing/variables/ Sam James
2025-08-03 13:01 James Le Cuirot
2025-08-03 13:01 James Le Cuirot
2025-07-22 22:25 James Le Cuirot
2025-07-22 22:25 James Le Cuirot
2022-08-25 16:42 Ulrich Müller
2022-08-25 16:42 Ulrich Müller
2022-08-25 16:42 Ulrich Müller
2022-02-18 18:19 Sam James
2022-02-16 18:43 Ulrich Müller
2022-02-16 18:02 Matthew Smith
2021-05-28 13:09 Ulrich Müller
2021-03-30  7:21 Ulrich Müller
2021-03-30  7:21 Ulrich Müller
2021-03-30  7:21 Ulrich Müller
2021-03-30  7:21 Ulrich Müller
2021-03-30  7:21 Ulrich Müller
2021-03-26 19:05 Ulrich Müller
2020-03-11 14:38 Ulrich Müller
2019-11-29  9:28 Ulrich Müller
2019-11-28 18:32 Göktürk Yüksek
2019-11-28 18:32 Göktürk Yüksek
2019-11-26  1:49 Göktürk Yüksek
2019-11-26  1:49 Göktürk Yüksek
2019-10-16 20:16 Göktürk Yüksek
2019-10-16 20:16 Göktürk Yüksek
2019-10-16 20:16 Göktürk Yüksek
2019-10-16 20:16 Göktürk Yüksek
2019-10-16 20:16 Göktürk Yüksek
2019-10-16 20:16 Göktürk Yüksek
2019-10-16 20:16 Göktürk Yüksek
2019-10-16 20:16 Göktürk Yüksek
2019-05-22 19:40 Göktürk Yüksek
2019-03-24 16:48 Ulrich Müller
2019-03-19 17:11 Brian Evans
2019-03-19 17:11 Brian Evans
2018-10-24 13:01 Brian Evans
2018-10-24 13:01 Brian Evans
2017-11-12 20:15 Ulrich Müller
2017-09-09  3:43 Göktürk Yüksek
2016-12-07 19:46 Göktürk Yüksek
2016-11-17  5:23 Göktürk Yüksek
2016-10-28 14:21 Göktürk Yüksek
2016-07-13  3:18 Göktürk Yüksek
2016-07-13  2:48 Göktürk Yüksek
2016-05-20  6:23 Göktürk Yüksek
2016-05-18  6:56 Göktürk Yüksek
2016-05-11  1:43 Mike Gilbert
2016-05-04  9:13 Göktürk Yüksek
2015-12-08 20:06 Ulrich Müller
2015-08-07  5:08 Mike Frysinger
2013-05-15 13:39 Dirkjan Ochtman
2013-05-15 13:39 Dirkjan Ochtman
2013-05-15 13:17 Dirkjan Ochtman
2012-11-24 19:12 Ulrich Mueller
2012-11-11 19:33 Markos Chandras

find likely ancestor, descendant, or conflicting patches for this message:
( dfblob:eb8770d dfblob:f402070 )
 OR (
bs:"[gentoo-commits] proj/devmanual:master commit in: ebuild-writing/variables/" )
	(help)

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=1477434659.1d5e96b5ef5eb637ea7aaa477eaeca56fad9a4fe.gokturk@gentoo \
    --to=gokturk@gentoo.org \
    --cc=gentoo-commits@lists.gentoo.org \
    --cc=gentoo-dev@lists.gentoo.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link

Be sure your reply has a Subject: header at the top and a blank line before the message body.

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox