diff options
| author |   Ulrich Müller <ulm@gentoo.org> | 2022-08-17 09:08:26 +0200 |
|---|---|---|
| committer | Ulrich Müller <ulm@gentoo.org> | 2022-08-18 18:02:10 +0200 |
| commit | 7ef569e7b5487784b5cab81daef60cd920da2082 (patch) | |
| tree | 2e1b12a61b3e0d6936116b9d6a77f85668d0bf15 | |
| parent | ebuild-writing/variables: Demote single variable sections to subsections (diff) | |
| download | devmanual-7ef569e7b5487784b5cab81daef60cd920da2082.tar.gz devmanual-7ef569e7b5487784b5cab81daef60cd920da2082.tar.bz2 devmanual-7ef569e7b5487784b5cab81daef60cd920da2082.zip | |
ebuild-writing/variables: Add section about reserved variables
Signed-off-by: Ulrich Müller <ulm@gentoo.org>
| -rw-r--r-- | ebuild-writing/variables/text.xml | 35 |
1 files changed, 35 insertions, 0 deletions
diff --git a/ebuild-writing/variables/text.xml b/ebuild-writing/variables/text.xml index 4c7df4f..d77f4b7 100644 --- a/ebuild-writing/variables/text.xml +++ b/ebuild-writing/variables/text.xml @@ -722,6 +722,41 @@ table. </section> <section> +<title>Variables reserved for the package manager</title> +<body> + +<p> +Variables and functions that begin with any of the following strings (ignoring +case) are reserved for package manager use. Ebuilds must neither use them nor +rely upon them: +</p> + +<ul> + <li><c>__</c> (two underscores)</li> + <li><c>abort</c></li> + <li><c>dyn</c></li> + <li><c>prep</c></li> +</ul> + +<p> +The same applies to functions and variables that contain any of the following +strings (ignoring case): +</p> + +<ul> + <li> + <c>ebuild</c> (unless immediately preceded by another letter, and except + for the <c>EBUILD_PHASE</c> and <c>EBUILD_PHASE_FUNC</c> variables) + </li> + <li><c>hook</c></li> + <li><c>paludis</c></li> + <li><c>portage</c></li> +</ul> + +</body> +</section> + +<section> <title>Version and Name Formatting Issues</title> <body> |