Gentoo Archives: gentoo-commits

From: "Ulrich Müller" <ulm@g.o>
To: gentoo-commits@l.g.o
Subject: [gentoo-commits] proj/devmanual:master commit in: ebuild-writing/variables/
Date: Thu, 25 Aug 2022 16:42:42
Message-Id: 1660838530.7ef569e7b5487784b5cab81daef60cd920da2082.ulm@gentoo
1 commit: 7ef569e7b5487784b5cab81daef60cd920da2082
2 Author: Ulrich Müller <ulm <AT> gentoo <DOT> org>
3 AuthorDate: Wed Aug 17 07:08:26 2022 +0000
4 Commit: Ulrich Müller <ulm <AT> gentoo <DOT> org>
5 CommitDate: Thu Aug 18 16:02:10 2022 +0000
6 URL: https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=7ef569e7
7
8 ebuild-writing/variables: Add section about reserved variables
9
10 Signed-off-by: Ulrich Müller <ulm <AT> gentoo.org>
11
12 ebuild-writing/variables/text.xml | 35 +++++++++++++++++++++++++++++++++++
13 1 file changed, 35 insertions(+)
14
15 diff --git a/ebuild-writing/variables/text.xml b/ebuild-writing/variables/text.xml
16 index 4c7df4f..d77f4b7 100644
17 --- a/ebuild-writing/variables/text.xml
18 +++ b/ebuild-writing/variables/text.xml
19 @@ -721,6 +721,41 @@ table.
20 </subsection>
21 </section>
22
23 +<section>
24 +<title>Variables reserved for the package manager</title>
25 +<body>
26 +
27 +<p>
28 +Variables and functions that begin with any of the following strings (ignoring
29 +case) are reserved for package manager use. Ebuilds must neither use them nor
30 +rely upon them:
31 +</p>
32 +
33 +<ul>
34 + <li><c>__</c> (two underscores)</li>
35 + <li><c>abort</c></li>
36 + <li><c>dyn</c></li>
37 + <li><c>prep</c></li>
38 +</ul>
39 +
40 +<p>
41 +The same applies to functions and variables that contain any of the following
42 +strings (ignoring case):
43 +</p>
44 +
45 +<ul>
46 + <li>
47 + <c>ebuild</c> (unless immediately preceded by another letter, and except
48 + for the <c>EBUILD_PHASE</c> and <c>EBUILD_PHASE_FUNC</c> variables)
49 + </li>
50 + <li><c>hook</c></li>
51 + <li><c>paludis</c></li>
52 + <li><c>portage</c></li>
53 +</ul>
54 +
55 +</body>
56 +</section>
57 +
58 <section>
59 <title>Version and Name Formatting Issues</title>
60 <body>