From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from lists.gentoo.org (pigeon.gentoo.org [208.92.234.80]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by finch.gentoo.org (Postfix) with ESMTPS id 03E571394EF for ; Fri, 28 Oct 2016 14:22:02 +0000 (UTC) Received: from pigeon.gentoo.org (localhost [127.0.0.1]) by pigeon.gentoo.org (Postfix) with SMTP id A490321C03E; Fri, 28 Oct 2016 14:22:00 +0000 (UTC) Received: from smtp.gentoo.org (smtp.gentoo.org [140.211.166.183]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by pigeon.gentoo.org (Postfix) with ESMTPS id 8CCDA21C03E for ; Fri, 28 Oct 2016 14:22:00 +0000 (UTC) Received: from oystercatcher.gentoo.org (oystercatcher.gentoo.org [148.251.78.52]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.gentoo.org (Postfix) with ESMTPS id 40335341655 for ; Fri, 28 Oct 2016 14:21:59 +0000 (UTC) Received: from localhost.localdomain (localhost [127.0.0.1]) by oystercatcher.gentoo.org (Postfix) with ESMTP id C7F6B24A7 for ; Fri, 28 Oct 2016 14:21:56 +0000 (UTC) From: "Göktürk Yüksek" To: gentoo-commits@lists.gentoo.org Content-Transfer-Encoding: 8bit Content-type: text/plain; charset=UTF-8 Reply-To: gentoo-dev@lists.gentoo.org, "Göktürk Yüksek" Message-ID: <1477434659.1d5e96b5ef5eb637ea7aaa477eaeca56fad9a4fe.gokturk@gentoo> Subject: [gentoo-commits] proj/devmanual:master commit in: ebuild-writing/variables/ X-VCS-Repository: proj/devmanual X-VCS-Files: ebuild-writing/variables/text.xml X-VCS-Directories: ebuild-writing/variables/ X-VCS-Committer: gokturk X-VCS-Committer-Name: Göktürk Yüksek X-VCS-Revision: 1d5e96b5ef5eb637ea7aaa477eaeca56fad9a4fe X-VCS-Branch: master Date: Fri, 28 Oct 2016 14:21:56 +0000 (UTC) Precedence: bulk List-Post: List-Help: List-Unsubscribe: List-Subscribe: List-Id: Gentoo Linux mail X-BeenThere: gentoo-commits@lists.gentoo.org X-Archives-Salt: 7d6bfede-138e-401e-9c18-1839c6494e03 X-Archives-Hash: 10cbbe148e365e333025e173f9077cf9 commit: 1d5e96b5ef5eb637ea7aaa477eaeca56fad9a4fe Author: Göktürk Yüksek gentoo org> AuthorDate: Tue Oct 25 22:30:59 2016 +0000 Commit: Göktürk Yüksek gentoo 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 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 } - -The ROOT variable always ends in a trailing slash. Therefore, -there is no need to suffix it with / when joining paths.

- -Future EAPI may remove the trailing slash at the end per -Bug 465722. -Developers can use ${ROOT%/} to ensure maximum compatibility -with both the current and the future EAPI. - - - @@ -565,5 +554,28 @@ follows. +
+Trailing Slashes in Variables + + +

+The following variables always end in a trailing slash by default: +D, ED, ROOT, EROOT. Therefore, there is no +need to suffix them with / when joining paths. +

+ + +Future EAPI may remove the trailing slash at the end per +Bug 465722. +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 / +when joining paths. For example: ${D%/}/, ${ED%/}/, +${ROOT%/}/, ${EROOT%/}/. + + + +
+