summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorUlrich Müller <ulm@gentoo.org>2022-05-11 23:55:40 +0200
committerUlrich Müller <ulm@gentoo.org>2022-05-14 09:29:57 +0200
commit260e21bf65f67ad424e990306a7a4789b6b2f1de (patch)
treea3860037e248a964f31d36499f4cf939cd3d974d
parentpkg-mgr-commands.tex: Whitespace (diff)
downloadpms-260e21bf65f67ad424e990306a7a4789b6b2f1de.tar.gz
pms-260e21bf65f67ad424e990306a7a4789b6b2f1de.tar.bz2
pms-260e21bf65f67ad424e990306a7a4789b6b2f1de.zip
pkg-mgr-commands.tex: Tighten the spec for reserved names
"abort", "dyn" and "prep" are only reserved at the beginning of a name. This appears to be their only (historical and recent) usage in Portage. "ebuild" is allowed as substring of words like "rebuild", which is somewhat common in names. Bug: https://bugs.gentoo.org/843779 Signed-off-by: Ulrich Müller <ulm@gentoo.org>
-rw-r--r--pkg-mgr-commands.tex14
1 files changed, 10 insertions, 4 deletions
diff --git a/pkg-mgr-commands.tex b/pkg-mgr-commands.tex
index 6df5f32..d4dcffe 100644
--- a/pkg-mgr-commands.tex
+++ b/pkg-mgr-commands.tex
@@ -1316,19 +1316,25 @@ Ebuilds must not run any of these commands once the current phase function has r
\subsection{Reserved commands and variables}
-Except where documented otherwise, all functions and variables that contain any of the following
+Except where documented otherwise, all functions and variables that begin with any of the following
strings (ignoring case) are reserved for package manager use and may not be used or relied upon by
ebuilds:
\begin{compactitem}
-\item \t{__} (two underscores) at beginning of string
+\item \t{__} (two underscores)
\item \t{abort}
\item \t{dyn}
-\item \t{ebuild}
+\item \t{prep}
+\end{compactitem}
+
+The same applies to functions and variables that contain any of the following strings (ignoring
+case):
+\nobreakpar
+\begin{compactitem}
+\item \t{ebuild} (unless immediately preceded by another letter)
\item \t{hook}
\item \t{paludis}
\item \t{portage}
-\item \t{prep}
\end{compactitem}
% vim: set filetype=tex fileencoding=utf8 et tw=100 spell spelllang=en :