[gentoo-commits] proj/pms:eapi-9 commit in: /
commit: a331bd4241cecfe6b124408f345979f126d519e7 Author: Ulrich Müller gentoo org> AuthorDate: Thu Jun 20 18:16:12 2024 + Commit: Ulrich Müller gentoo org> CommitDate: Thu Jun 20 18:16:12 2024 + URL:https://gitweb.gentoo.org/proj/pms.git/commit/?id=a331bd42 EAPI 9 no longer rewrites absolute symlinks Bug: https://bugs.gentoo.org/934514 Signed-off-by: Ulrich Müller gentoo.org> eapi-differences.tex | 5 + merge.tex| 19 +-- 2 files changed, 22 insertions(+), 2 deletions(-) diff --git a/eapi-differences.tex b/eapi-differences.tex index f6aafe7..3d5bb97 100644 --- a/eapi-differences.tex +++ b/eapi-differences.tex @@ -171,6 +171,9 @@ Controllable stripping & \compactfeatureref{dostrip} & \t{unpack} support for \t{rar} & \compactfeatureref{unpack-extensions} & Yes & Yes & No & No \\ +Absolute symlink rewriting & \compactfeatureref{symlink-rewrite} & +Yes & Yes & Yes & No \\ + \end{longtable} \chapter{Differences between EAPIs} @@ -356,6 +359,8 @@ EAPI 9 is EAPI 8 with the following changes: \begin{compactitem} \item Different default EAPI for profiles, \featureref{profile-eapi-default}. +\item Absolute symlinks no longer being rewritten, \featureref{symlink-rewrite} + \end{compactitem} \ChangeWhenAddingAnEAPI{9} diff --git a/merge.tex b/merge.tex index 27b0ba8..e51c1b8 100644 --- a/merge.tex +++ b/merge.tex @@ -138,8 +138,23 @@ Ebuilds must not attempt to merge a symlink on top of a directory. \subsection{Rewriting} -Any absolute symlink whose link starts with \t{D} must be rewritten with the leading \t{D} removed. -The package manager should issue a notice when doing this. +\featurelabel{symlink-rewrite} In EAPIs listed in table~\ref{tab:symlink-rewrite} as rewriting +symlinks, any absolute symlink whose link starts with \t{D} must be rewritten with the leading +\t{D} removed. The package manager should issue a notice when encountering such a symlink. + +\ChangeWhenAddingAnEAPI{9} +\begin{centertable}{Rewriting of absolute symlinks} +\label{tab:symlink-rewrite} +\begin{tabular}{ll} + \toprule + \multicolumn{1}{c}{\textbf{EAPI}} & + \multicolumn{1}{c}{\textbf{Rewrite symlinks?}} \\ + \midrule + 0, 1, 2, 3, 4, 5, 6, 7, 8 & Yes \\ + 9 & No \\ + \bottomrule +\end{tabular} +\end{centertable} \section{Hard links}
[gentoo-commits] proj/pms:eapi-9 commit in: /
commit: e1251fe69eac1e01c3915ae289b9ba73e8cc7413 Author: Ulrich Müller gentoo org> AuthorDate: Tue May 7 17:28:42 2024 + Commit: Ulrich Müller gentoo org> CommitDate: Wed May 8 18:11:59 2024 + URL:https://gitweb.gentoo.org/proj/pms.git/commit/?id=e1251fe6 Use sentence case throughout Subsection headings were already changed from title case to sentence case in commit ca463ce. This left chapter and section headings alone, which is inconsistent (although it is specified by some style guides like APA). This commit changes headings to sentence case throughout, following most other Gentoo documentation, e.g. wiki and devmanual. Signed-off-by: Ulrich Müller gentoo.org> appendices.tex | 8 commands.tex | 6 +++--- dependencies.tex | 6 +++--- desk-reference.tex | 4 ++-- eapi-cheatsheet.tex| 26 +- eapi-differences.tex | 4 ++-- ebuild-env-vars.tex| 2 +- ebuild-environment.tex | 6 +++--- ebuild-format.tex | 2 +- ebuild-functions.tex | 6 +++--- ebuild-vars.tex| 10 +- eclasses.tex | 4 ++-- introduction.tex | 4 ++-- merge.tex | 8 metadata-cache.tex | 8 names.tex | 10 +- pkg-mgr-commands.tex | 2 +- pms.tex| 2 +- profile-variables.tex | 2 +- profiles.tex | 4 ++-- tree-layout.tex| 16 21 files changed, 70 insertions(+), 70 deletions(-) diff --git a/appendices.tex b/appendices.tex index daf9b01..8249ab3 100644 --- a/appendices.tex +++ b/appendices.tex @@ -5,7 +5,7 @@ The \t{metadata.xml} file is used to contain extra package- or category-level in what is stored in ebuild metadata. Its exact format is strictly beyond the scope of this document, and is described in GLEP~68~\cite{glep68}. -\chapter{Unspecified Items} +\chapter{Unspecified items} The following items are not specified by this document, and must not be relied upon by ebuilds. This is, of course, an incomplete list---it covers only the things that the authors know have @@ -24,9 +24,9 @@ been abused in the past. \item The \t{PORTDIR_OVERLAY} variable, and overlay behaviour in general. \end{compactitem} -\chapter{Historical Curiosities} +\chapter{Historical curiosities} -\section{Long-obsolete Features} +\section{Long-obsolete features} The items described in this section are included for information only. Unless otherwise noted, they were deprecated or abandoned long before EAPI was introduced. Ebuilds must not use these features, @@ -61,7 +61,7 @@ The \t{use.defaults} file in the profile directory was used to implement `autous flags on or off depending upon which packages are installed. It was deprecated long ago and finally removed in 2009. -\section{Retroactive Changes} +\section{Retroactive changes} In some exceptional cases, changes to the specification have been approved by the Gentoo Council without introducing a new EAPI\@. This section lists such retroactive changes. diff --git a/commands.tex b/commands.tex index d0ad87d..2c9e594 100644 --- a/commands.tex +++ b/commands.tex @@ -1,4 +1,4 @@ -\chapter{Available Commands} +\chapter{Available commands} This chapter documents the commands available to an ebuild. Unless otherwise specified, they may be aliases, shell functions, or executables in the ebuild's \t{PATH}. @@ -7,7 +7,7 @@ When an ebuild is being sourced for metadata querying rather than for a build (t when none of the \t{src_} or \t{pkg_} functions are to be called), no external command may be executed. The package manager may take steps to enforce this. -\section{System Commands} +\section{System commands} Any ebuild not listed in the system set for the active profile(s) may assume the presence of every command that is always provided by the system set for that profile. However, it must target the @@ -49,7 +49,7 @@ The following commands must always be available in the ebuild environment: \end{tabular} \end{centertable} -\section{Commands Provided by Package Dependencies} +\section{Commands provided by package dependencies} In some cases a package's build process will require the availability of executables not provided by the core system, a common example being autotools. The availability of commands provided by the diff --git a/dependencies.tex b/dependencies.tex index 6c09714..47c96c3 100644 --- a/dependencies.tex +++ b/dependencies.tex @@ -1,7 +1,7 @@ \chapter{Dependencies} \label{ch:dependencies} -\section{Dependency Classes} +\section{Dependency classes} \label{sec:dependency-classes} \begin{centertable}{Dependency classes required to be satisfied for a particular phase function} @@ -111,7 +111,7 @@ interfaces related to the dependency classes. In addition, \t{HOMEPAGE}, \t{SRC_URI}, \t{LICENSE}, \t{REQUIRED_USE}, \t{PROPERTIES} and \t{RESTRICT} use dependency-style
[gentoo-commits] proj/pms:eapi-9 commit in: /
commit: d773b8caeb11cfc3d37b0463eeed4a8a18ffb8d7 Author: Ulrich Müller gentoo org> AuthorDate: Tue Aug 3 16:32:47 2021 + Commit: Ulrich Müller gentoo org> CommitDate: Sun Jun 2 09:56:50 2024 + URL:https://gitweb.gentoo.org/proj/pms.git/commit/?id=d773b8ca Add an EAPI 9 identical to EAPI 8 Signed-off-by: Ulrich Müller gentoo.org> commands.tex | 4 +- dependencies.tex | 26 - eapi-differences.tex | 153 +++--- eapis.tex | 4 +- ebuild-env-vars.tex | 26 - ebuild-format.tex | 4 +- ebuild-functions.tex | 46 +++ ebuild-vars.tex | 22 eclasses.tex | 4 +- merge.tex | 6 +- pkg-mgr-commands.tex | 100 - pms.tex | 4 +- profile-variables.tex | 8 +-- profiles.tex | 12 ++-- tree-layout.tex | 8 +-- 15 files changed, 195 insertions(+), 232 deletions(-) diff --git a/commands.tex b/commands.tex index 2c9e594..81fd204 100644 --- a/commands.tex +++ b/commands.tex @@ -33,7 +33,7 @@ The following commands must always be available in the ebuild environment: table~\ref{tab:system-commands-table} as requiring GNU find. \end{compactitem} -\ChangeWhenAddingAnEAPI{8} +\ChangeWhenAddingAnEAPI{9} \begin{centertable}{System commands for EAPIs} \label{tab:system-commands-table} \begin{tabular}{lll} @@ -44,7 +44,7 @@ The following commands must always be available in the ebuild environment: \midrule 0, 1, 2, 3, 4 & Undefined & Any \\ 5, 6 & Yes & Any \\ - 7, 8 & Yes & 2.7 \\ + 7, 8, 9 & Yes & 2.7 \\ \bottomrule \end{tabular} \end{centertable} diff --git a/dependencies.tex b/dependencies.tex index 47c96c3..24628ef 100644 --- a/dependencies.tex +++ b/dependencies.tex @@ -88,7 +88,7 @@ with the native build system (\t{CBUILD}). Ebuilds are allowed to call them in \ \t{pkg_postinst}. Ebuilds may also call them in \t{pkg_prerm} and \t{pkg_postrm} but must not rely on them being available. -\ChangeWhenAddingAnEAPI{8} +\ChangeWhenAddingAnEAPI{9} \begin{centertable}{EAPIs supporting additional dependency types} \label{tab:depend-table} \begin{tabular}{lll} @@ -99,7 +99,7 @@ on them being available. \midrule 0, 1, 2, 3, 4, 5, 6 & No & No \\ 7 & Yes & No \\ - 8 & Yes & Yes \\ + 8, 9& Yes & Yes \\ \bottomrule \end{tabular} \end{centertable} @@ -155,7 +155,7 @@ be surrounded on both sides by whitespace, except at the start and end of the st In particular, note that whitespace is not optional. -\ChangeWhenAddingAnEAPI{8} +\ChangeWhenAddingAnEAPI{9} \begin{centertable}{EAPIs supporting \t{REQUIRED_USE ??}\ groups} \label{tab:at-most-one-of-table} \begin{tabular}{ll} @@ -164,7 +164,7 @@ In particular, note that whitespace is not optional. \multicolumn{1}{c}{\textbf{Supports \t{REQUIRED_USE ??}\ groups?}} \\ \midrule 0, 1, 2, 3, 4 & No \\ - 5, 6, 7, 8& Yes \\ + 5, 6, 7, 8, 9 & Yes \\ \bottomrule \end{tabular} \end{centertable} @@ -204,7 +204,7 @@ In an exactly-one-of group, exactly one immediate child element must be matched. In EAPIs specified in table~\ref{tab:empty-dep-groups}, an empty exactly-one-of group counts as being matched. -\ChangeWhenAddingAnEAPI{8} +\ChangeWhenAddingAnEAPI{9} \begin{centertable}{Matching of empty dependency groups in EAPIs} \label{tab:empty-dep-groups} \begin{tabular}{ll} @@ -214,7 +214,7 @@ being matched. are matched?}} \\ \midrule 0, 1, 2, 3, 4, 5, 6 & Yes \\ - 7, 8& No \\ + 7, 8, 9 & No \\ \bottomrule \end{tabular} \end{centertable} @@ -250,7 +250,7 @@ manager must warn or error if this feature is used with an EAPI not supporting u \note{Order is important. The slot restriction must come before use dependencies.} -\ChangeWhenAddingAnEAPI{8} +\ChangeWhenAddingAnEAPI{9} \begin{centertable}{Support for \t{SLOT} dependencies and sub-slots in EAPIs} \label{tab:slot-deps-table} \begin{tabular}{lll} @@ -261,12 +261,12 @@ manager must warn or error if this feature is used with an EAPI not supporting u \midrule 0 & No & No \\ 1, 2, 3, 4& Named only & No \\ - 5, 6, 7, 8& Named and operator & Yes \\ + 5, 6, 7, 8, 9 & Named and operator & Yes \\ \bottomrule \end{tabular} \end{centertable} -\ChangeWhenAddingAnEAPI{8} +\ChangeWhenAddingAnEAPI{9} \begin{centertable}{EAPIs supporting \t{USE} dependencies} \label{tab:use-deps-table} \begin{tabular}{ll} @@ -276,7 +276,7 @@ manager must warn or error if this feature is used with an
[gentoo-commits] proj/pms:eapi-9 commit in: /
commit: e044fe24e90de258483a59130c1b56de21082bc6 Author: Ulrich Müller gentoo org> AuthorDate: Tue Apr 2 16:53:19 2024 + Commit: Ulrich Müller gentoo org> CommitDate: Tue Apr 2 16:53:19 2024 + URL:https://gitweb.gentoo.org/proj/pms.git/commit/?id=e044fe24 ebuild-env-vars.tex: Be more specific about REPLACING_VERSIONS phases Signed-off-by: Ulrich Müller gentoo.org> ebuild-env-vars.tex | 7 --- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/ebuild-env-vars.tex b/ebuild-env-vars.tex index 0dcfd24..06d37d9 100644 --- a/ebuild-env-vars.tex +++ b/ebuild-env-vars.tex @@ -255,12 +255,13 @@ inconsistent variable. package, and \t{buildonly} if building a binary package without installing it. Only for EAPIs listed in table~\ref{tab:added-env-vars-table} as supporting \t{MERGE_TYPE}. \\ \t{REPLACING_VERSIONS} & -\t{pkg_*} (see text) & +\t{pkg_preinst}, \t{pkg_postinst} (\t{pkg_pretend}, \t{pkg_setup}) & Yes & A list of all versions of this package (including revision, if specified), whitespace separated with no leading or trailing whitespace, that are being replaced (uninstalled or overwritten) -as a result of this install. See section~\ref{sec:replacing-versions}. Only for EAPIs listed -in table~\ref{tab:added-env-vars-table} as supporting \t{REPLACING_VERSIONS}. \\ +as a result of this install. See section~\ref{sec:replacing-versions}, especially for the phases +in which the variable is legal. Only for EAPIs listed in table~\ref{tab:added-env-vars-table} +as supporting \t{REPLACING_VERSIONS}. \\ \t{REPLACED_BY_VERSION} & \t{pkg_prerm}, \t{pkg_postrm} & Yes &
[gentoo-commits] proj/pms:eapi-9 commit in: /
commit: 76b3958184fc93fec5ac15c67288de21475ff592 Author: Ulrich Müller gentoo org> AuthorDate: Mon Feb 21 18:32:43 2022 + Commit: Ulrich Müller gentoo org> CommitDate: Sun Jun 2 09:56:51 2024 + URL:https://gitweb.gentoo.org/proj/pms.git/commit/?id=76b39581 EAPI 9 profile EAPI defaults to top-level Bug: https://bugs.gentoo.org/806181 Signed-off-by: Ulrich Müller gentoo.org> eapi-differences.tex | 5 - profiles.tex | 23 +-- 2 files changed, 25 insertions(+), 3 deletions(-) diff --git a/eapi-differences.tex b/eapi-differences.tex index 9617dc4..f6aafe7 100644 --- a/eapi-differences.tex +++ b/eapi-differences.tex @@ -32,6 +32,9 @@ have identical entries for all listed EAPIs.} Less strict \t{updates} syntax & \compactfeatureref{updates-filenames} & No & No & Yes & Yes \\ +Default EAPI for profiles & \compactfeatureref{profile-eapi-default} & +0 & 0 & 0 & Top-level \\ + Profile files as directories & \compactfeatureref{profile-file-dirs} & No & Yes & Yes & Yes \\ @@ -352,7 +355,7 @@ EAPI 8 is EAPI 7 with the following changes: EAPI 9 is EAPI 8 with the following changes: \begin{compactitem} -\item None +\item Different default EAPI for profiles, \featureref{profile-eapi-default}. \end{compactitem} \ChangeWhenAddingAnEAPI{9} diff --git a/profiles.tex b/profiles.tex index c836f08..9d00c14 100644 --- a/profiles.tex +++ b/profiles.tex @@ -33,8 +33,27 @@ are discarded. A profile directory may contain an \t{eapi} file. This file, if it exists, must contain a single line with the name of an EAPI\@. This specifies the EAPI to use when handling the directory in question; a package manager must not attempt to use any profile using a directory which requires an -EAPI it does not support. If no \t{eapi} file is present, EAPI 0 shall be used. The EAPI is neither -inherited via the \t{parent} file nor in subdirectories. +EAPI it does not support. + +\featurelabel{profile-eapi-default} If no \t{eapi} file is present, the default depends on the EAPI +of the top-level profiles directory (see section~\ref{sec:profiles-dir}). That EAPI shall be used +if table~\ref{tab:profile-eapi-default} lists it as ``top-level''. Otherwise, EAPI 0 shall be used. + +The EAPI is neither inherited via the \t{parent} file nor in subdirectories. + +\ChangeWhenAddingAnEAPI{9} +\begin{centertable}{Default EAPI for profiles} +\label{tab:profile-eapi-default} +\begin{tabular}{ll} + \toprule + \multicolumn{1}{c}{\textbf{EAPI}} & + \multicolumn{1}{c}{\textbf{Default EAPI?}} \\ + \midrule + 0, 1, 2, 3, 4, 5, 6, 7, 8 & 0 \\ + 9 & Top-level \\ + \bottomrule +\end{tabular} +\end{centertable} \subsection{deprecated} If a profile contains a file named \t{deprecated}, it is treated as such. The first line of this
[gentoo-commits] proj/pms:eapi-9 commit in: /
commit: 544d28de1b799ffe839bd6d7b5bc15b4d8e5970d Author: Ulrich Müller gentoo org> AuthorDate: Sat Apr 29 14:33:48 2023 + Commit: Ulrich Müller gentoo org> CommitDate: Thu May 4 18:39:57 2023 + URL:https://gitweb.gentoo.org/proj/pms.git/commit/?id=544d28de pkg-mgr-commands.tex: Drop CONF_LIBDIR* and DEFAULT_ABI The CONF_LIBDIR variable was used exclusively in the 2004.3 profile (i.e. it was no longer defined in 2005.0). Portage support for CONF_LIBDIR was added by this commit: https://gitweb.gentoo.org/archive/proj/portage-cvs.git/commit/?id=ecc2faaa00b1e6250129267ba873bedd2121eac5 Note that neither the ABI nor the LIBDIR_${ABI} variable existed at the time. The CONF_LIBDIR_OVERRIDE and DEFAULT_ABI variables were never implemented in the dolib* and einstall commands in Portage. With the three variables dropped, the algorithm is identical to the logic used for get_libdir(). Therefore drop alg:ebuild-libdir and refer to alg:get-libdir instead. Bug: https://bugs.gentoo.org/267159 Signed-off-by: Ulrich Müller gentoo.org> pkg-mgr-commands.tex | 30 -- 1 file changed, 4 insertions(+), 26 deletions(-) diff --git a/pkg-mgr-commands.tex b/pkg-mgr-commands.tex index 4fac077..b6113f6 100644 --- a/pkg-mgr-commands.tex +++ b/pkg-mgr-commands.tex @@ -430,7 +430,7 @@ commands once the current phase function has returned. table~\ref{tab:offset-env-vars-table}, hence EAPIs lacking offset-prefix support should use \t{D} instead of \t{ED} in the command given in listing~\ref{lst:einstall}. Variable \t{libdir} is an auxiliary local variable whose value is determined by -algorithm~\ref{alg:ebuild-libdir}. +algorithm~\ref{alg:get-libdir}. \begin{listing}[H] \caption{\t{einstall} command} \label{lst:einstall} @@ -554,7 +554,7 @@ the current phase function has returned. EAPI dependent as per section~\ref{sec:failure-behaviour}. \item[dolib.a] For each argument, installs it into the appropriate library subdirectory under -\t{DESTTREE}, as determined by algorithm~\ref{alg:ebuild-libdir}. Files are installed with file +\t{DESTTREE}, as determined by algorithm~\ref{alg:get-libdir}. Files are installed with file mode \t{0644}. Any symlinks are installed into the same directory as relative links to their original target. Failure behaviour is EAPI dependent as per section~\ref{sec:failure-behaviour}. @@ -565,28 +565,6 @@ the current phase function has returned. in table~\ref{tab:banned-commands-table}, this command is banned as per section~\ref{sec:banned-commands}. -\begin{algorithm} -\caption{Determining the library directory} \label{alg:ebuild-libdir} -\begin{algorithmic}[1] -\IF{CONF_LIBDIR_OVERRIDE is set in the environment} -\STATE return CONF_LIBDIR_OVERRIDE -\ENDIF -\IF{CONF_LIBDIR is set in the environment} -\STATE let LIBDIR_default=CONF_LIBDIR -\ELSE -\STATE let LIBDIR_default=``lib'' -\ENDIF -\IF{ABI is set in the environment} -\STATE let abi=ABI -\ELSIF{DEFAULT_ABI is set in the environment} -\STATE let abi=DEFAULT_ABI -\ELSE -\STATE let abi=``default'' -\ENDIF -\STATE return the value of LIBDIR_\$abi -\end{algorithmic} -\end{algorithm} - \item[doman] Installs the given man pages into the appropriate subdirectory of \t{/usr/share/man} depending upon its apparent section suffix (e.\,g.\ \t{foo.1} goes to \t{/usr/share/man/man1/foo.1}) with file mode \t{0644}. @@ -1273,7 +1251,7 @@ has returned. supporting \t{get_libdir}. \begin{algorithm} -\caption{\t{get_libdir} logic} \label{alg:get-libdir} +\caption{Library directory logic} \label{alg:get-libdir} \begin{algorithmic}[1] \STATE let libdir=\t{lib} \IF{the ABI environment variable is set} @@ -1282,7 +1260,7 @@ has returned. \STATE let libdir=the value of the variable named by libvar \ENDIF \ENDIF -\STATE print the value of libdir +\RETURN the value of libdir \end{algorithmic} \end{algorithm}
[gentoo-commits] proj/pms:eapi-9 commit in: /
commit: 47772dd3b715953dda0e663c62d31814043f9df6 Author: Ulrich Müller gentoo org> AuthorDate: Sat Jan 27 09:04:54 2024 + Commit: Ulrich Müller gentoo org> CommitDate: Sat Jan 27 13:03:44 2024 + URL:https://gitweb.gentoo.org/proj/pms.git/commit/?id=47772dd3 tree-layout.tex: Loosen restrictions on reusing package and slot names Closes: https://bugs.gentoo.org/923019 Signed-off-by: Ulrich Müller gentoo.org> tree-layout.tex | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/tree-layout.tex b/tree-layout.tex index 99fc46a..61f70a2 100644 --- a/tree-layout.tex +++ b/tree-layout.tex @@ -229,9 +229,9 @@ to \t{slot2}. It is unspecified in what order the files in the \t{updates} directory are processed. Lines within each file are processed in ascending order. -Any name that has appeared as the origin of a move must not be reused in the future. Any slot -that has appeared as the origin of a slot move may not be used by packages matching the spec of -that slot move in the future. +At any given time, a name that appears as the origin of a move may not be used as a qualified +package name in the repository. A slot that appears as the origin of a slot move may not be used +by packages matching the spec of that slot move. \ChangeWhenAddingAnEAPI{8} \begin{centertable}{Naming rules for files in \t{updates} directory for EAPIs}
[gentoo-commits] proj/pms:eapi-9 commit in: /
commit: ea5b43c5e8b666124592fae8e0697f0d990ab1f4 Author: Ulrich Müller gentoo org> AuthorDate: Mon May 13 20:51:12 2024 + Commit: Ulrich Müller gentoo org> CommitDate: Mon May 13 20:51:12 2024 + URL:https://gitweb.gentoo.org/proj/pms.git/commit/?id=ea5b43c5 pms.cls: Redefine headings for list of tables etc. Signed-off-by: Ulrich Müller gentoo.org> pms.cls | 9 - 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/pms.cls b/pms.cls index d9907b7..0cf630b 100644 --- a/pms.cls +++ b/pms.cls @@ -128,11 +128,18 @@ % Define a new column type P for tables, like p but with ragged-right text \newcolumntype{P}[1]{>{\setlength\rightskip{0pt plus 1fil}}p{#1}} +% Redefine headings for list of tables/figures/algorithms +\renewcommand{\listtablename}{Tables} +\renewcommand{\listfigurename}{Figures} +\g@addto@macro\@documentclasshook{ +\renewcommand{\listalgorithmname}{Algorithms} +} + % Define a float environment for listings \floatstyle{ruled} \newfloat{listing}{tbp}{lol}[chapter] \floatname{listing}{Listing} -\newcommand{\listoflistings}{\listof{listing}{List of Listings}} +\newcommand{\listoflistings}{\listof{listing}{Listings}} % Prevent page break before a list \newcommand{\nobreakpar}{\par\nobreak\@afterheading}
[gentoo-commits] proj/pms:eapi-9 commit in: /
commit: bd3a35db46006e2c45fee66e7759cfc327ebf187 Author: Ulrich Müller gentoo org> AuthorDate: Sun May 12 18:15:24 2024 + Commit: Ulrich Müller gentoo org> CommitDate: Mon May 13 17:44:13 2024 + URL:https://gitweb.gentoo.org/proj/pms.git/commit/?id=bd3a35db pms.cls, eapi-cheatsheet.tex: Avoid conditional code in \date Signed-off-by: Ulrich Müller gentoo.org> eapi-cheatsheet.tex | 9 - pms.cls | 13 ++--- 2 files changed, 10 insertions(+), 12 deletions(-) diff --git a/eapi-cheatsheet.tex b/eapi-cheatsheet.tex index fc75aec..2e2b757 100644 --- a/eapi-cheatsheet.tex +++ b/eapi-cheatsheet.tex @@ -33,11 +33,10 @@ Ulrich Müller \\ \href{mailto:u...@gentoo.org}{u...@gentoo.org} } -\date{% -Version \version \\ -\ifthenelse{\equal{\gitCommitterDate}{(None)}} -{Generated on: \today} -{\printdate{\gitCommitterDate}}% +\ifthenelse{\equal{\gitCommitterDate}{(None)}}{% +\date{Version \version \\ Generated on: \today} +}{% +\date{Version \version \\ \printdate{\gitCommitterDate}} } \CutLine*{1} \CutLine*{3} diff --git a/pms.cls b/pms.cls index d1a85fa..d9907b7 100644 --- a/pms.cls +++ b/pms.cls @@ -175,13 +175,12 @@ % Reads the last commit date from the Git repository and even succeeds % when none is available -\date{% -\ifthenelse{\equal{\gitCommitterDate}{(None)}} -{Generated on: \today} -{\printdate{\gitCommitterDate}}% -} -\newcommand{\commitinfo}{% -\ifthenelse{\equal{\gitCommitterDate}{(None)}}{}{% +\ifthenelse{\equal{\gitCommitterDate}{(None)}}{% +\date{Generated on: \today} +\newcommand{\commitinfo}{} +}{% +\date{\printdate{\gitCommitterDate}} +\newcommand{\commitinfo}{% This version corresponds to commit \gitAbbrevHash \ifthenelse{\equal{\gitBranch}{\detokenize{master}}}{} { on branch \gitBranch}%
[gentoo-commits] proj/pms:eapi-9 commit in: /
commit: 4d3c1a3d1275a76f41c0c7c50ec11d1f8954e2fb Author: Ulrich Müller gentoo org> AuthorDate: Thu Feb 22 17:12:22 2024 + Commit: Ulrich Müller gentoo org> CommitDate: Thu Feb 22 17:12:22 2024 + URL:https://gitweb.gentoo.org/proj/pms.git/commit/?id=4d3c1a3d tree-layout.tex: Plural use of "data" is preferred in BE https://digitalblog.ons.gov.uk/2016/12/08/data-is-versus-data-are/ This also fixes an "underfull \hbox" error. Signed-off-by: Ulrich Müller gentoo.org> tree-layout.tex | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/tree-layout.tex b/tree-layout.tex index 61f70a2..d286307 100644 --- a/tree-layout.tex +++ b/tree-layout.tex @@ -265,7 +265,7 @@ directory, support files needed by these eclasses. \section{The Metadata Directory} \label{sec:metadata-dir} -The \t{metadata} directory contains various repository-level metadata that is not contained in +The \t{metadata} directory contains various repository-level metadata that are not contained in \t{profiles/}. All contents are optional. In this standard only the \t{cache} subdirectory is described; other contents are optional but may include security advisories, DTD files for the various XML files used in the repository, and repository timestamps.
[gentoo-commits] proj/pms:eapi-9 commit in: /
commit: 7674760dc5ac6d2a1800203f8b257665bc12b9db Author: Ulrich Müller gentoo org> AuthorDate: Sat Jan 27 09:04:35 2024 + Commit: Ulrich Müller gentoo org> CommitDate: Sat Jan 27 09:04:35 2024 + URL:https://gitweb.gentoo.org/proj/pms.git/commit/?id=7674760d pms.tex: Update copyright years Signed-off-by: Ulrich Müller gentoo.org> pms.tex | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pms.tex b/pms.tex index f435f51..bd8c9d5 100644 --- a/pms.tex +++ b/pms.tex @@ -31,7 +31,7 @@ \vspace*{\fill} {% \small -\textcopyright{} 2007--2023 Stephen Bennett, Ciaran McCreesh and others. Contributions are owned +\textcopyright{} 2007--2024 Stephen Bennett, Ciaran McCreesh and others. Contributions are owned by their respective authors, and may have been changed substantially before inclusion. This work is released under the Creative Commons Attribution-ShareAlike 4.0 International
[gentoo-commits] proj/pms:eapi-9 commit in: /
commit: ef9be7c2a696a476514de29e2f88df82f37f2ceb Author: Ulrich Müller gentoo org> AuthorDate: Thu Feb 22 17:19:40 2024 + Commit: Ulrich Müller gentoo org> CommitDate: Thu Feb 22 17:19:40 2024 + URL:https://gitweb.gentoo.org/proj/pms.git/commit/?id=ef9be7c2 ebuild-env-vars.tex: EBUILD_PHASE{,_FUNC} are valid only in phases Portage didn't ever set (or unset) these variables to a special value when sourcing the ebuild, so obviously ebuilds cannot rely on this. Restrict their validity to actual phases and make global scope behaviour unspecified. The previous wording was introduced with commit 58d3bc0. Bug: https://bugs.gentoo.org/908552 Signed-off-by: Ulrich Müller gentoo.org> ebuild-env-vars.tex | 14 +++--- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/ebuild-env-vars.tex b/ebuild-env-vars.tex index aae5413..0dcfd24 100644 --- a/ebuild-env-vars.tex +++ b/ebuild-env-vars.tex @@ -224,23 +224,23 @@ inconsistent variable. A whitespace-delimited list of all active USE flags for this ebuild. See section~\ref{sec:use-iuse-handling} for details. \\ \t{EBUILD_PHASE} & -All & +\t{src_*}, \t{pkg_*} & No & Takes one of the values \t{config}, \t{setup}, \t{nofetch}, \t{unpack}, \t{prepare}, \t{configure}, \t{compile}, \t{test}, \t{install}, \t{preinst}, \t{postinst}, \t{prerm}, \t{postrm}, \t{info}, \t{pretend} according to the top level ebuild function that was executed -by the package manager. May be unset or any single word that is not any of the above when the -ebuild is being sourced for other (e.\,g.\ metadata or QA) purposes. \\ +by the package manager. Behaviour is unspecified when the ebuild is being sourced for other +(e.\,g.\ metadata or QA) purposes. \\ \t{EBUILD_PHASE_FUNC} & -All & +\t{src_*}, \t{pkg_*} & No & \featurelabel{ebuild-phase-func} Takes one of the values \t{pkg_config}, \t{pkg_setup}, \t{pkg_nofetch}, \t{src_unpack}, \t{src_prepare}, \t{src_configure}, \t{src_compile}, \t{src_test}, \t{src_install}, \t{pkg_preinst}, \t{pkg_postinst}, \t{pkg_prerm}, \t{pkg_postrm}, \t{pkg_info}, \t{pkg_pretend} according to the top level ebuild function that -was executed by the package manager. May be unset or any single word that is not any of the -above when the ebuild is being sourced for other (e.\,g.\ metadata or QA) purposes. Only for -EAPIs listed in table~\ref{tab:added-env-vars-table} as supporting \t{EBUILD_PHASE_FUNC}. \\ +was executed by the package manager. Behaviour is unspecified when the ebuild is being sourced +for other (e.\,g.\ metadata or QA) purposes. Only for EAPIs listed in +table~\ref{tab:added-env-vars-table} as supporting \t{EBUILD_PHASE_FUNC}. \\ \t{KV} & All & Yes &
[gentoo-commits] proj/pms:eapi-9 commit in: /
commit: 1a669f3ce2ac6b6cf4c96be16dfea0b5621a938d Author: Michał Górny gentoo org> AuthorDate: Wed Feb 21 15:45:01 2024 + Commit: Ulrich Müller gentoo org> CommitDate: Sun Mar 3 17:29:40 2024 + URL:https://gitweb.gentoo.org/proj/pms.git/commit/?id=1a669f3c ebuild-vars.tex: Add "test_privileged" to valid "PROPERTIES" Add "test_privileged" to the values of "PROPERTIES", as introduced in Portage commit 997058a825a340813532bef77a34425cf4a88eb2 (to be included in 3.0.62). This is akin to "test_network", used to indicate that the test suite needs superuser privileges. Bug: https://bugs.gentoo.org/924585 Signed-off-by: Michał Górny gentoo.org> Signed-off-by: Ulrich Müller gentoo.org> ebuild-vars.tex | 2 ++ 1 file changed, 2 insertions(+) diff --git a/ebuild-vars.tex b/ebuild-vars.tex index 5f3f583..79fa96f 100644 --- a/ebuild-vars.tex +++ b/ebuild-vars.tex @@ -239,6 +239,8 @@ The following tokens are permitted inside \t{PROPERTIES}: installed. \item[test_network] The package manager may run tests that require an internet connection, even if the ebuild has \t{RESTRICT=test}. +\item[test_privileged] The package manager may run tests that require superuser privileges, even +if the ebuild has \t{RESTRICT=test}. \end{description} Package managers may recognise other tokens. Ebuilds may not rely upon any token being supported.
[gentoo-commits] proj/pms:eapi-9 commit in: /
commit: 5c394f7d83e432cde0d9ff9d70c2e2eb0c1c2327 Author: Ulrich Müller gentoo org> AuthorDate: Wed Aug 2 10:18:54 2023 + Commit: Ulrich Müller gentoo org> CommitDate: Sun Aug 6 11:09:41 2023 + URL:https://gitweb.gentoo.org/proj/pms.git/commit/?id=5c394f7d ebuild-env-vars.tex: BROOT is valid in additional pkg_* phases By section sec:dependency-classes, dependency class BDEPEND is satisfied in phase functions src_* and pkg_setup (only if part of source build); IDEPEND is satisfied in pkg_preinst, pkg_postinst, pkg_prerm and pkg_postrm. Update the entry for BROOT accordingly. Closes: https://bugs.gentoo.org/911574 Reported-by: Mike Gilbert gentoo.org> Signed-off-by: Ulrich Müller gentoo.org> ebuild-env-vars.tex | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/ebuild-env-vars.tex b/ebuild-env-vars.tex index fc8123b..20aedb4 100644 --- a/ebuild-env-vars.tex +++ b/ebuild-env-vars.tex @@ -149,7 +149,8 @@ inconsistent variable. by table~\ref{tab:depend-prefix}. Only for EAPIs listed in table~\ref{tab:offset-env-vars-table} as supporting \t{ESYSROOT}. \\ \t{BROOT} & -\t{src_*}, \t{pkg_setup}\footnotemark[\value{footnote}] & +\t{src_*}, \t{pkg_setup},\footnotemark[\value{footnote}] \t{pkg_preinst}, \t{pkg_postinst}, +\t{pkg_prerm}, \t{pkg_postrm} & No & \featurelabel{broot} The absolute path to the root directory containing build dependencies satisfied by \t{BDEPEND} and \t{IDEPEND}, typically executable build tools. This includes any
[gentoo-commits] proj/pms:eapi-9 commit in: /
commit: ea32ea927dad915bd50e0dcf976379b8470eb4d7 Author: Ulrich Müller gentoo org> AuthorDate: Sun Aug 6 09:52:14 2023 + Commit: Ulrich Müller gentoo org> CommitDate: Mon Aug 7 17:08:16 2023 + URL:https://gitweb.gentoo.org/proj/pms.git/commit/?id=ea32ea92 ebuild-env-vars.tex: Add footnote about BROOT in pkg_* phases Restrict the previous change to EAPIs that actually support IDEPEND. Bug: https://bugs.gentoo.org/911574 Signed-off-by: Ulrich Müller gentoo.org> ebuild-env-vars.tex | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/ebuild-env-vars.tex b/ebuild-env-vars.tex index 20aedb4..6046e1f 100644 --- a/ebuild-env-vars.tex +++ b/ebuild-env-vars.tex @@ -150,7 +150,8 @@ inconsistent variable. as supporting \t{ESYSROOT}. \\ \t{BROOT} & \t{src_*}, \t{pkg_setup},\footnotemark[\value{footnote}] \t{pkg_preinst}, \t{pkg_postinst}, -\t{pkg_prerm}, \t{pkg_postrm} & +\t{pkg_prerm}, \t{pkg_postrm}\footnote{Legal in \t{pkg_*inst} and \t{pkg_*rm} only for EAPIs +listed in table~\ref{tab:depend-table} as supporting \t{IDEPEND}.} & No & \featurelabel{broot} The absolute path to the root directory containing build dependencies satisfied by \t{BDEPEND} and \t{IDEPEND}, typically executable build tools. This includes any
[gentoo-commits] proj/pms:eapi-9 commit in: /
commit: 658ead31edffc3bf431c5840830a357e3fe555da Author: Ulrich Müller gentoo org> AuthorDate: Fri Dec 29 11:54:18 2023 + Commit: Ulrich Müller gentoo org> CommitDate: Fri Dec 29 12:20:21 2023 + URL:https://gitweb.gentoo.org/proj/pms.git/commit/?id=658ead31 ebuild-env-vars.tex: Clarify that D is not valid in pkg_postinst D in pkg_* phases was first mentioned in SVN r74 (commit f627e46102c6) as a variable specific to the pkg_preinst phase function (replacing IMAGE). pkg_postinst was added in r88 (commit 3da3ee561f1a), but this was reverted in r89 (commit 65c466317718) "D in pkg_postinst == bad". pkg_postinst reappeared when the env vars section was converted to a table in commit 58d3bc0e8301. According to chapter 13 "Merging and Unmerging", the method used to perform the merge is not specified, and merging a regular file or a directory may alter or remove its source under D. Therefore, trying to access any file in D during the postinst phase is an error. The scope of ED follows that of D. Closes: https://bugs.gentoo.org/920889 Signed-off-by: Ulrich Müller gentoo.org> ebuild-env-vars.tex | 9 - 1 file changed, 4 insertions(+), 5 deletions(-) diff --git a/ebuild-env-vars.tex b/ebuild-env-vars.tex index 5fe72dc..aae5413 100644 --- a/ebuild-env-vars.tex +++ b/ebuild-env-vars.tex @@ -192,14 +192,13 @@ inconsistent variable. The presence of a trailing slash is EAPI dependent as listed in table~\ref{tab:trailing-slash}. \\ \t{D} (continued) & -\t{pkg_preinst}, \t{pkg_postinst} & -Yes\footnote{Consistent across \t{pkg_preinst} and \t{pkg_postinst}, but may not necessarily -have the same value that it had in the \t{src_*} phases.} & -Contains the full path to the image that is about to be or has just been merged. +\t{pkg_preinst} & +No\footnote{May not necessarily have the same value that it had in the \t{src_*} phases.} & +Contains the full path to the image directory of the package about to be merged. The presence of a trailing slash is EAPI dependent as listed in table~\ref{tab:trailing-slash}. \\ \t{ED} & -\t{src_*}, \t{pkg_preinst}, \t{pkg_postinst} & +\t{src_*}, \t{pkg_preinst} & See \t{D} & Contains the concatenation of the paths in the \t{D} and \t{EPREFIX} variables, for convenience. See also the \t{EPREFIX} variable. Only for EAPIs listed in
[gentoo-commits] proj/pms:eapi-9 commit in: /
commit: 07dde903c0f2feeb9f4aa46273436dc992b18913 Author: Ulrich Müller gentoo org> AuthorDate: Thu Aug 3 16:16:07 2023 + Commit: Ulrich Müller gentoo org> CommitDate: Sun Aug 6 11:09:41 2023 + URL:https://gitweb.gentoo.org/proj/pms.git/commit/?id=07dde903 ebuild-env-vars.tex: Avoid "Ditto" in the env variables table Suggested-by: Sam James gentoo.org> Signed-off-by: Ulrich Müller gentoo.org> ebuild-env-vars.tex | 23 +++ 1 file changed, 11 insertions(+), 12 deletions(-) diff --git a/ebuild-env-vars.tex b/ebuild-env-vars.tex index 533936a..fc8123b 100644 --- a/ebuild-env-vars.tex +++ b/ebuild-env-vars.tex @@ -48,15 +48,15 @@ inconsistent variable. Package name and version, without the revision part. For example, \t{vim-7.0.174}. \\ \t{PF} & All & -Ditto & +No\footnotemark[\value{footnote}] & Package name, version, and revision (if any), for example \t{vim-7.0.174-r1}. \\ \t{PN} & All & -Ditto & +No\footnotemark[\value{footnote}] & Package name, for example \t{vim}. \\ \t{CATEGORY} & All & -Ditto & +No\footnotemark[\value{footnote}] & The package's category, for example \t{app-editors}. \\ \t{PV} & All & @@ -81,7 +81,7 @@ inconsistent variable. assume that the package manager sets it in the EAPIs supporting it. For example, a few configure scripts use this variable to find the \t{aalib} package; ebuilds calling such configure scripts must thus work around this.} & -Ditto & +\t{src_*}, \t{pkg_nofetch} & Yes & \featurelabel{aa} All source files that could be available for the package, including any that are disabled in \t{A} because of USE conditionals. The value is calculated from the base names @@ -96,11 +96,11 @@ inconsistent variable. not exist; if a repository provides no support files for the package in question then an ebuild must be prepared for the situation where \t{FILESDIR} points to a non-existent directory. \\ \t{DISTDIR} & -Ditto & +\t{src_*}, global~scope\footnotemark[\value{footnote}] & Yes & The full path to the directory in which the files in the \t{A} variable are stored. \\ \t{WORKDIR} & -Ditto & +\t{src_*}, global~scope\footnotemark[\value{footnote}] & Yes & The full path to the ebuild's working directory, where all build data should be contained. \\ \t{S} & @@ -143,19 +143,18 @@ inconsistent variable. satisfied by \t{DEPEND}\@. Only for EAPIs listed in table~\ref{tab:added-env-vars-table} as supporting \t{SYSROOT}. \\ \t{ESYSROOT} & -Ditto & +\t{src_*}, \t{pkg_setup}\footnotemark[\value{footnote}] & No & Contains the concatenation of the \t{SYSROOT} path and applicable prefix value, as determined by table~\ref{tab:depend-prefix}. Only for EAPIs listed in table~\ref{tab:offset-env-vars-table} as supporting \t{ESYSROOT}. \\ \t{BROOT} & -Ditto & +\t{src_*}, \t{pkg_setup}\footnotemark[\value{footnote}] & No & \featurelabel{broot} The absolute path to the root directory containing build dependencies satisfied by \t{BDEPEND} and \t{IDEPEND}, typically executable build tools. This includes any applicable offset prefix. Only for EAPIs listed in table~\ref{tab:added-env-vars-table} as -supporting \t{BROOT}. -\\ +supporting \t{BROOT}. \\ \t{T} & All & Partially\footnote{Consistent and preserved across a single connected sequence of install or @@ -164,12 +163,12 @@ inconsistent variable. The full path to a temporary directory for use by the ebuild. \\ \t{TMPDIR} & All & -Ditto & +Partially\footnotemark[\value{footnote}] & Must be set to the location of a usable temporary directory, for any applications called by an ebuild. Must not be used by ebuilds directly; see \t{T} above. \\ \t{HOME} & All & -Ditto & +Partially\footnotemark[\value{footnote}] & The full path to an appropriate temporary directory for use by any programs invoked by the ebuild that may read or modify the home directory. \\ \t{EPREFIX} &
[gentoo-commits] proj/pms:eapi-9 commit in: /
commit: f336f16ab8ab80d77cfb626eb2935eacda8bb596 Author: Ulrich Müller gentoo org> AuthorDate: Thu Aug 3 16:22:33 2023 + Commit: Ulrich Müller gentoo org> CommitDate: Mon Aug 7 17:08:16 2023 + URL:https://gitweb.gentoo.org/proj/pms.git/commit/?id=f336f16a ebuild-env-vars.tex: Variables may not be meaningful in global scope Signed-off-by: Ulrich Müller gentoo.org> ebuild-env-vars.tex | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/ebuild-env-vars.tex b/ebuild-env-vars.tex index 6046e1f..5fe72dc 100644 --- a/ebuild-env-vars.tex +++ b/ebuild-env-vars.tex @@ -2,8 +2,9 @@ \label{sec:ebuild-env-vars} The package manager must define the following environment variables. Not all variables are -meaningful in all phases; variables that are not meaningful in a given phase may be unset or set to -any value. Ebuilds must not attempt to modify any of these variables, unless otherwise specified. +universally meaningful; variables that are not meaningful in a given phase or in global scope may +be unset or set to any value. Ebuilds must not attempt to modify any of these variables, unless +otherwise specified. Because of their special meanings, these variables may not be preserved consistently across all phases as would normally happen due to environment saving (see section~\ref{sec:ebuild-env-state}).
[gentoo-commits] proj/pms:eapi-9 commit in: /
commit: aecb51e70f8546fd7f55144f9035ca982ab6fae1 Author: Ulrich Müller gentoo org> AuthorDate: Sun Dec 24 13:05:52 2023 + Commit: Ulrich Müller gentoo org> CommitDate: Sun Dec 24 13:05:52 2023 + URL:https://gitweb.gentoo.org/proj/pms.git/commit/?id=aecb51e7 pkg-mgr-commands.tex: Sandbox commands accept any file The sandbox commands addread, addwrite, addpredict and adddeny can accept not only directories, but also other files like regular files or device nodes. This behaviour is supported by all three package managers. Also, the sandbox's default configuration relies on it (e.g. "/dev/null" and "${HOME}/.bash_history" in /etc/sandbox.conf), and it is widely used in the Gentoo repository. Signed-off-by: Ulrich Müller gentoo.org> pkg-mgr-commands.tex | 12 ++-- 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/pkg-mgr-commands.tex b/pkg-mgr-commands.tex index b6113f6..2202b64 100644 --- a/pkg-mgr-commands.tex +++ b/pkg-mgr-commands.tex @@ -89,14 +89,14 @@ called, the package manager must abort the build process indicating an error. \end{centertable} \subsection{Sandbox commands} -These commands affect the behaviour of the sandbox. Each command takes a single directory as -argument. Ebuilds must not run any of these commands once the current phase function has returned. +These commands affect the behaviour of the sandbox. Each command takes a single path as argument. +Ebuilds must not run any of these commands once the current phase function has returned. \begin{description} -\item[addread] Add a directory to the permitted read list. -\item[addwrite] Add a directory to the permitted write list. -\item[addpredict] Add a directory to the predict list. Any write to a location in this list will be +\item[addread] Add a path to the permitted read list. +\item[addwrite] Add a path to the permitted write list. +\item[addpredict] Add a path to the predict list. Any write to a location in this list will be denied, but will not trigger access violation messages or abort the build process. -\item[adddeny] Add a directory to the deny list. +\item[adddeny] Add a path to the deny list. \end{description} \subsection{Package manager query commands}
[gentoo-commits] proj/pms:eapi-9 commit in: /
commit: 86bdfe73f488081e6abc9397693e35b400cfc6b6 Author: Ulrich Müller gentoo org> AuthorDate: Thu Aug 3 16:12:16 2023 + Commit: Ulrich Müller gentoo org> CommitDate: Sun Aug 6 11:09:40 2023 + URL:https://gitweb.gentoo.org/proj/pms.git/commit/?id=86bdfe73 Reformat the footnotes in the env variables longtable Signed-off-by: Ulrich Müller gentoo.org> ebuild-env-vars.tex | 12 pms.cls | 3 +++ 2 files changed, 11 insertions(+), 4 deletions(-) diff --git a/ebuild-env-vars.tex b/ebuild-env-vars.tex index b8deb04..533936a 100644 --- a/ebuild-env-vars.tex +++ b/ebuild-env-vars.tex @@ -12,13 +12,17 @@ the various different \t{pkg_*} phases. Ebuilds must recalculate any variable th inconsistent variable. \begin{landscape} +% Reduce width of text area to make room for margin notes +\addtolength{\hsize}{-25mm} +\setlength{\linewidth}{\hsize} +\setlength{\columnwidth}{\hsize} +\addtolength{\footskip}{25mm} \reversemarginpar -\addtolength{\marginparsep}{-25mm} % Workaround for broken marginnote positioning in lscape environment \addtolength{\marginparsep}{-\textwidth} % FIXME -\setlength{\LTleft}{25mm plus 1fil} +\setlength{\LTleft}{0pt plus 1fil} \setlength{\LTright}{0pt plus 1fil} -\begin{longtable}{!{\extracolsep{\fill}} l P{7.5em} l p{0.5\linewidth}} +\begin{longtable}{!{\extracolsep{\fill}} l P{7.5em} l p{35em}} \caption{Defined variables\label{tab:defined-vars}}\\ \toprule \multicolumn{1}{c}{\textbf{Variable}} & @@ -34,7 +38,7 @@ inconsistent variable. \multicolumn{1}{c}{\textbf{Description}} \\ \midrule \endhead -\midrule +%\midrule \endfoot \bottomrule \endlastfoot diff --git a/pms.cls b/pms.cls index dcef98c..d1a85fa 100644 --- a/pms.cls +++ b/pms.cls @@ -22,8 +22,10 @@ \PassOptionsToPackage{utf8}{inputenc} \PassOptionsToPackage{quiet}{marginnote} \PassOptionsToPackage{nohyphen}{underscore} +\PassOptionsToPackage{hang,flushmargin}{footmisc} \PassOptionsToPackage{nottoc,notlot,notlof}{tocbibind} \PassOptionsToPackage{hyphens}{url} % url.sty implicitly loaded by hyperref +\PassOptionsToPackage{hyperfootnotes=false}{hyperref} % footmisc compatibility \PassOptionsToPackage{local}{gitinfo2} \PassOptionsToPackage{chapter}{algorithm} % algorithmic and algorithm to be loaded last to avoid failures @@ -41,6 +43,7 @@ marginnote, % Typeset a paragraph in the page margin paralist, % Additional list environments underscore, % Allow simple _ instead of \_ +footmisc, % Customise footnotes chngcntr, % Redefinition of counters tocbibind, % Add bibliography to table of contents float, % More control over float environments
[gentoo-commits] proj/pms:eapi-9 commit in: /
commit: f9adb7bfa495cd46f01bb2c9b72ceea9b603b888 Author: Ulrich Müller gentoo org> AuthorDate: Mon May 29 13:12:21 2023 + Commit: Ulrich Müller gentoo org> CommitDate: Sun Jun 4 00:02:27 2023 + URL:https://gitweb.gentoo.org/proj/pms.git/commit/?id=f9adb7bf metadata-cache.tex: Document the md5-dict cache format Signed-off-by: Ulrich Müller gentoo.org> metadata-cache.tex | 36 ++-- pms.bib| 11 +++ 2 files changed, 41 insertions(+), 6 deletions(-) diff --git a/metadata-cache.tex b/metadata-cache.tex index d69ecdd..9ff7086 100644 --- a/metadata-cache.tex +++ b/metadata-cache.tex @@ -3,16 +3,19 @@ \section{Directory Contents} -The \t{metadata/cache} directory, if it exists, contains directories whose names are the same as -categories in the repository. Each subdirectory may optionally contain one file per package version -in that category, named \t{-}, in the format described below. +The \t{metadata/cache} or \t{metadata/md5-cache} directories, if either of them exists, contain +directories whose names are the same as categories in the repository. Each subdirectory may +optionally contain one file per package version in that category, named \t{-}, +in one of the formats described below. The metadata cache may be incomplete or non-existent, and may contain additional bogus entries. -\section{Cache File Format} +\section{Legacy Cache File Format} +\label{sec:legacy-cache} -Each cache file contains the textual values of various metadata keys, one per line, in the following -order. Other lines may be present following these; their meanings are not defined here. +The legacy cache file format is used in the \t{metadata/cache} directory. Each cache file contains +the textual values of various metadata keys, one per line, in the following order. Other lines may +be present following these; their meanings are not defined here. \begin{compactenum} \item Build-time dependencies (\t{DEPEND}) @@ -47,6 +50,27 @@ Any future EAPI that uses this cache format will continue to place the EAPI valu such a concept makes sense for that EAPI, and will place a value that is clearly not a supported EAPI on line~15 if it does~not. +\section{md5-dict Cache File Format} + +The ``md5-dict'' cache file format is used in the \t{metadata/md5-cache} directory. Each cache file +contains \t{=} pairs, one per line, in arbitrary order. The keys are the same as those +listed in section~\ref{sec:legacy-cache} except the \t{INHERITED} key. In addition, keys \t{_md5_} +and \t{_eclasses_} contain values as defined below. + +\begin{description} +\item[_md5_] The MD5 checksum of the ebuild for the package version. + +\item[_eclasses_] A list of \i{name-checksum} pairs for all eclasses directly or indirectly +inherited by the ebuild, in arbitrary order, where \i{name} is the eclass name and \i{checksum} +is the MD5 checksum of the eclass. Pairs are separated from each other by single tab characters, +as are \i{name} and \i{checksum} in each pair. +\end{description} + +All MD5 checksums are computed and formatted as described in RFC~1321~\cite{rfc1321}. + +Other keys may be present; their meanings are not defined here. Lines with an empty value can be +omitted. + % vim: set filetype=tex fileencoding=utf8 et tw=100 spell spelllang=en : %%% Local Variables: diff --git a/pms.bib b/pms.bib index bef07c1..ac60c44 100644 --- a/pms.bib +++ b/pms.bib @@ -52,3 +52,14 @@ month = Oct, url = {https://www.gentoo.org/glep/glep-0074.html} } + +@techreport{rfc1321, +author = {Ronald L. Rivest}, +title = {The {MD5} message-digest algorithm}, +type = {RFC}, +number = 1321, +institution = {RFC Editor}, +year = 1992, +month = Apr, +url = {https://www.rfc-editor.org/rfc/rfc1321} +}
[gentoo-commits] proj/pms:eapi-9 commit in: /
commit: 8db624245bc7ac34712017a70c056abe9d4a60cf Author: Ulrich Müller gentoo org> AuthorDate: Mon May 29 13:07:58 2023 + Commit: Ulrich Müller gentoo org> CommitDate: Mon May 29 13:07:58 2023 + URL:https://gitweb.gentoo.org/proj/pms.git/commit/?id=8db62424 pms.bib: Use @techreport entry type for GLEPs This is a slightly better fit than @manual. Also, change citation keys to lowercase. Signed-off-by: Ulrich Müller gentoo.org> appendices.tex | 6 +++--- pms.bib | 35 +-- tree-layout.tex | 2 +- 3 files changed, 29 insertions(+), 14 deletions(-) diff --git a/appendices.tex b/appendices.tex index 7a2c70b..daf9b01 100644 --- a/appendices.tex +++ b/appendices.tex @@ -3,7 +3,7 @@ The \t{metadata.xml} file is used to contain extra package- or category-level information beyond what is stored in ebuild metadata. Its exact format is strictly beyond the scope of this document, -and is described in GLEP~68~\cite{Glep68}. +and is described in GLEP~68~\cite{glep68}. \chapter{Unspecified Items} @@ -76,7 +76,7 @@ the \t{PROVIDE} metadata that it supplied certain virtuals, and the package mana in mind when handling dependencies. Old-style virtuals were supported by EAPIs 0, 1, 2, 3 and~4. They were phased out via -GLEP~37~\cite{Glep37} and finally removed in 2011. +GLEP~37~\cite{glep37} and finally removed in 2011. \note{A `new-style virtual' is a normal package that installs no files and uses its dependency requirements to pull in a `provider'. This does not require any special handling from the package @@ -87,7 +87,7 @@ The method to specify the EAPI of an ebuild used to be a shell variable assignme manager had to source the ebuild in order to determine the EAPI\@. Therefore any ebuild using a future EAPI would still have to be sourceable by old package managers, which imposed restrictions e.\,g.\ on updating the Bash version or on possible changes of global scope functions. Several -approaches to overcome this limitation were discussed, notably GLEP~55~\cite{Glep55}, which was +approaches to overcome this limitation were discussed, notably GLEP~55~\cite{glep55}, which was rejected though. The current syntax of the \t{EAPI} assignment statement (see section~\ref{sec:eapi}), allowing diff --git a/pms.bib b/pms.bib index 014b643..bef07c1 100644 --- a/pms.bib +++ b/pms.bib @@ -1,38 +1,53 @@ -@manual{Glep37, +@techreport{glep37, author = {Jason Stubbs}, -title = {{GLEP} 37: Virtuals deprecation}, +title = {Virtuals deprecation}, +type = {GLEP}, +number = 37, +institution = {Gentoo Linux}, year = 2006, month = Sep, url = {https://www.gentoo.org/glep/glep-0037.html} } -@manual{Glep44, +@techreport{glep44, author = {Marius Mauch}, -title = {{GLEP} 44: Manifest2 format}, +title = {{Manifest2} format}, +type = {GLEP}, +number = 44, +institution = {Gentoo Linux}, year = 2006, month = Sep, url = {https://www.gentoo.org/glep/glep-0044.html} } -@manual{Glep55, +@techreport{glep55, author = {Piotr Jaroszyński}, -title = {{GLEP} 55: Use {EAPI}-suffixed ebuilds}, +title = {Use {EAPI}-suffixed ebuilds}, +type = {GLEP}, +number = 55, +institution = {Gentoo Linux}, year = 2009, month = May, url = {https://www.gentoo.org/glep/glep-0055.html} } -@manual{Glep68, +@techreport{glep68, author = {Michał Górny}, -title = {{GLEP} 68: Package and category metadata}, +title = {Package and category metadata}, +type = {GLEP}, +number = 68, +institution = {Gentoo Linux}, year = 2022, month = Oct, url = {https://www.gentoo.org/glep/glep-0068.html} } -@manual{Glep74, +@techreport{glep74, author = {Michał Górny and Robin Hugh Johnson and Ulrich Müller}, -title = {{GLEP} 74: Full-tree verification using Manifest files}, +title = {Full-tree verification using {Manifest} files}, +type = {GLEP}, +number = 74, +institution = {Gentoo Linux}, year = 2022, month = Oct, url = {https://www.gentoo.org/glep/glep-0074.html} diff --git a/tree-layout.tex b/tree-layout.tex index da01ff8..99fc46a 100644 --- a/tree-layout.tex +++ b/tree-layout.tex @@ -54,7 +54,7 @@ A package directory contains the following: \item A \t{metadata.xml} file, as described in appendix~\ref{app:metadata-xml}\@. Optional only for legacy support. \item A \t{ChangeLog}, in a format determined by the provider of the repository. Optional. -\item A \t{Manifest} file, whose format is described in~\cite{Glep74}. Can be omitted if the file +\item A \t{Manifest} file, whose format is described in~\cite{glep74}. Can be omitted if the file would be empty. \item A \t{files} directory, containing any support files needed by the ebuilds. Optional. \end{compactitem}
[gentoo-commits] proj/pms:eapi-9 commit in: /
commit: 4ebd8c5b40256db4ee682fa5af0046cc4acfbd1f Author: Ulrich Müller gentoo org> AuthorDate: Mon Feb 21 18:32:43 2022 + Commit: Ulrich Müller gentoo org> CommitDate: Fri Apr 14 15:57:14 2023 + URL:https://gitweb.gentoo.org/proj/pms.git/commit/?id=4ebd8c5b EAPI 9 profile EAPI defaults to top-level Bug: https://bugs.gentoo.org/806181 Signed-off-by: Ulrich Müller gentoo.org> eapi-differences.tex | 5 - profiles.tex | 23 +-- 2 files changed, 25 insertions(+), 3 deletions(-) diff --git a/eapi-differences.tex b/eapi-differences.tex index fbb23b4..9319769 100644 --- a/eapi-differences.tex +++ b/eapi-differences.tex @@ -32,6 +32,9 @@ have identical entries for all listed EAPIs.} Less strict \t{updates} syntax & \compactfeatureref{updates-filenames} & No & No & Yes & Yes \\ +Default EAPI for profiles & \compactfeatureref{profile-eapi-default} & +0 & 0 & 0 & Top-level \\ + Profile files as directories & \compactfeatureref{profile-file-dirs} & No & Yes & Yes & Yes \\ @@ -352,7 +355,7 @@ EAPI 8 is EAPI 7 with the following changes: EAPI 9 is EAPI 8 with the following changes: \begin{compactitem} -\item None +\item Different default EAPI for profiles, \featureref{profile-eapi-default}. \end{compactitem} \ChangeWhenAddingAnEAPI{9} diff --git a/profiles.tex b/profiles.tex index e350972..05caace 100644 --- a/profiles.tex +++ b/profiles.tex @@ -33,8 +33,27 @@ are discarded. A profile directory may contain an \t{eapi} file. This file, if it exists, must contain a single line with the name of an EAPI\@. This specifies the EAPI to use when handling the directory in question; a package manager must not attempt to use any profile using a directory which requires an -EAPI it does not support. If no \t{eapi} file is present, EAPI 0 shall be used. The EAPI is neither -inherited via the \t{parent} file nor in subdirectories. +EAPI it does not support. + +\featurelabel{profile-eapi-default} If no \t{eapi} file is present, the default depends on the EAPI +of the top-level profiles directory (see section~\ref{sec:profiles-dir}). That EAPI shall be used +if table~\ref{tab:profile-eapi-default} lists it as ``top-level''. Otherwise, EAPI 0 shall be used. + +The EAPI is neither inherited via the \t{parent} file nor in subdirectories. + +\ChangeWhenAddingAnEAPI{9} +\begin{centertable}{Default EAPI for profiles} +\label{tab:profile-eapi-default} +\begin{tabular}{ll} + \toprule + \multicolumn{1}{c}{\textbf{EAPI}} & + \multicolumn{1}{c}{\textbf{Default EAPI?}} \\ + \midrule + 0, 1, 2, 3, 4, 5, 6, 7, 8 & 0 \\ + 9 & Top-level \\ + \bottomrule +\end{tabular} +\end{centertable} \subsection{deprecated} If a profile contains a file named \t{deprecated}, it is treated as such. The first line of this
[gentoo-commits] proj/pms:eapi-9 commit in: /
commit: faa6e7dcd1aeece84221ce454a19b2f65211409e Author: Ulrich Müller gentoo org> AuthorDate: Tue Aug 3 16:32:47 2021 + Commit: Ulrich Müller gentoo org> CommitDate: Fri Apr 14 15:57:14 2023 + URL:https://gitweb.gentoo.org/proj/pms.git/commit/?id=faa6e7dc Add an EAPI 9 identical to EAPI 8 Signed-off-by: Ulrich Müller gentoo.org> commands.tex | 4 +- dependencies.tex | 26 - eapi-differences.tex | 153 +++--- eapis.tex | 4 +- ebuild-env-vars.tex | 26 - ebuild-format.tex | 4 +- ebuild-functions.tex | 46 +++ ebuild-vars.tex | 22 eclasses.tex | 4 +- merge.tex | 6 +- pkg-mgr-commands.tex | 100 - pms.tex | 4 +- profile-variables.tex | 8 +-- profiles.tex | 12 ++-- tree-layout.tex | 8 +-- 15 files changed, 195 insertions(+), 232 deletions(-) diff --git a/commands.tex b/commands.tex index d0ad87d..c6f4f36 100644 --- a/commands.tex +++ b/commands.tex @@ -33,7 +33,7 @@ The following commands must always be available in the ebuild environment: table~\ref{tab:system-commands-table} as requiring GNU find. \end{compactitem} -\ChangeWhenAddingAnEAPI{8} +\ChangeWhenAddingAnEAPI{9} \begin{centertable}{System commands for EAPIs} \label{tab:system-commands-table} \begin{tabular}{lll} @@ -44,7 +44,7 @@ The following commands must always be available in the ebuild environment: \midrule 0, 1, 2, 3, 4 & Undefined & Any \\ 5, 6 & Yes & Any \\ - 7, 8 & Yes & 2.7 \\ + 7, 8, 9 & Yes & 2.7 \\ \bottomrule \end{tabular} \end{centertable} diff --git a/dependencies.tex b/dependencies.tex index 6c09714..6b58f54 100644 --- a/dependencies.tex +++ b/dependencies.tex @@ -88,7 +88,7 @@ with the native build system (\t{CBUILD}). Ebuilds are allowed to call them in \ \t{pkg_postinst}. Ebuilds may also call them in \t{pkg_prerm} and \t{pkg_postrm} but must not rely on them being available. -\ChangeWhenAddingAnEAPI{8} +\ChangeWhenAddingAnEAPI{9} \begin{centertable}{EAPIs supporting additional dependency types} \label{tab:depend-table} \begin{tabular}{lll} @@ -99,7 +99,7 @@ on them being available. \midrule 0, 1, 2, 3, 4, 5, 6 & No & No \\ 7 & Yes & No \\ - 8 & Yes & Yes \\ + 8, 9& Yes & Yes \\ \bottomrule \end{tabular} \end{centertable} @@ -155,7 +155,7 @@ be surrounded on both sides by whitespace, except at the start and end of the st In particular, note that whitespace is not optional. -\ChangeWhenAddingAnEAPI{8} +\ChangeWhenAddingAnEAPI{9} \begin{centertable}{EAPIs supporting \t{REQUIRED_USE ??}\ groups} \label{tab:at-most-one-of-table} \begin{tabular}{ll} @@ -164,7 +164,7 @@ In particular, note that whitespace is not optional. \multicolumn{1}{c}{\textbf{Supports \t{REQUIRED_USE ??}\ groups?}} \\ \midrule 0, 1, 2, 3, 4 & No \\ - 5, 6, 7, 8& Yes \\ + 5, 6, 7, 8, 9 & Yes \\ \bottomrule \end{tabular} \end{centertable} @@ -204,7 +204,7 @@ In an exactly-one-of group, exactly one immediate child element must be matched. In EAPIs specified in table~\ref{tab:empty-dep-groups}, an empty exactly-one-of group counts as being matched. -\ChangeWhenAddingAnEAPI{8} +\ChangeWhenAddingAnEAPI{9} \begin{centertable}{Matching of empty dependency groups in EAPIs} \label{tab:empty-dep-groups} \begin{tabular}{ll} @@ -214,7 +214,7 @@ being matched. are matched?}} \\ \midrule 0, 1, 2, 3, 4, 5, 6 & Yes \\ - 7, 8& No \\ + 7, 8, 9 & No \\ \bottomrule \end{tabular} \end{centertable} @@ -250,7 +250,7 @@ manager must warn or error if this feature is used with an EAPI not supporting u \note{Order is important. The slot restriction must come before use dependencies.} -\ChangeWhenAddingAnEAPI{8} +\ChangeWhenAddingAnEAPI{9} \begin{centertable}{Support for \t{SLOT} dependencies and sub-slots in EAPIs} \label{tab:slot-deps-table} \begin{tabular}{lll} @@ -261,12 +261,12 @@ manager must warn or error if this feature is used with an EAPI not supporting u \midrule 0 & No & No \\ 1, 2, 3, 4& Named only & No \\ - 5, 6, 7, 8& Named and operator & Yes \\ + 5, 6, 7, 8, 9 & Named and operator & Yes \\ \bottomrule \end{tabular} \end{centertable} -\ChangeWhenAddingAnEAPI{8} +\ChangeWhenAddingAnEAPI{9} \begin{centertable}{EAPIs supporting \t{USE} dependencies} \label{tab:use-deps-table} \begin{tabular}{ll} @@ -276,7 +276,7 @@ manager must warn or error if this feature is used with an
[gentoo-commits] proj/pms:eapi-9 commit in: /
commit: b2386578c6e7c996a4d24f7808c3893502b15dba Author: Ulrich Müller gentoo org> AuthorDate: Tue Aug 3 16:32:47 2021 + Commit: Ulrich Müller gentoo org> CommitDate: Mon Apr 10 07:17:10 2023 + URL:https://gitweb.gentoo.org/proj/pms.git/commit/?id=b2386578 Add an EAPI 9 identical to EAPI 8 Signed-off-by: Ulrich Müller gentoo.org> commands.tex | 4 +- dependencies.tex | 26 +-- eapi-differences.tex | 116 +++--- eapis.tex | 4 +- ebuild-env-vars.tex | 26 +-- ebuild-format.tex | 4 +- ebuild-functions.tex | 46 ++-- ebuild-vars.tex | 22 +- eclasses.tex | 4 +- merge.tex | 6 +-- pkg-mgr-commands.tex | 100 +-- pms.tex | 4 +- profile-variables.tex | 8 ++-- profiles.tex | 12 +++--- tree-layout.tex | 8 ++-- 15 files changed, 199 insertions(+), 191 deletions(-) diff --git a/commands.tex b/commands.tex index d0ad87d..c6f4f36 100644 --- a/commands.tex +++ b/commands.tex @@ -33,7 +33,7 @@ The following commands must always be available in the ebuild environment: table~\ref{tab:system-commands-table} as requiring GNU find. \end{compactitem} -\ChangeWhenAddingAnEAPI{8} +\ChangeWhenAddingAnEAPI{9} \begin{centertable}{System commands for EAPIs} \label{tab:system-commands-table} \begin{tabular}{lll} @@ -44,7 +44,7 @@ The following commands must always be available in the ebuild environment: \midrule 0, 1, 2, 3, 4 & Undefined & Any \\ 5, 6 & Yes & Any \\ - 7, 8 & Yes & 2.7 \\ + 7, 8, 9 & Yes & 2.7 \\ \bottomrule \end{tabular} \end{centertable} diff --git a/dependencies.tex b/dependencies.tex index 6c09714..6b58f54 100644 --- a/dependencies.tex +++ b/dependencies.tex @@ -88,7 +88,7 @@ with the native build system (\t{CBUILD}). Ebuilds are allowed to call them in \ \t{pkg_postinst}. Ebuilds may also call them in \t{pkg_prerm} and \t{pkg_postrm} but must not rely on them being available. -\ChangeWhenAddingAnEAPI{8} +\ChangeWhenAddingAnEAPI{9} \begin{centertable}{EAPIs supporting additional dependency types} \label{tab:depend-table} \begin{tabular}{lll} @@ -99,7 +99,7 @@ on them being available. \midrule 0, 1, 2, 3, 4, 5, 6 & No & No \\ 7 & Yes & No \\ - 8 & Yes & Yes \\ + 8, 9& Yes & Yes \\ \bottomrule \end{tabular} \end{centertable} @@ -155,7 +155,7 @@ be surrounded on both sides by whitespace, except at the start and end of the st In particular, note that whitespace is not optional. -\ChangeWhenAddingAnEAPI{8} +\ChangeWhenAddingAnEAPI{9} \begin{centertable}{EAPIs supporting \t{REQUIRED_USE ??}\ groups} \label{tab:at-most-one-of-table} \begin{tabular}{ll} @@ -164,7 +164,7 @@ In particular, note that whitespace is not optional. \multicolumn{1}{c}{\textbf{Supports \t{REQUIRED_USE ??}\ groups?}} \\ \midrule 0, 1, 2, 3, 4 & No \\ - 5, 6, 7, 8& Yes \\ + 5, 6, 7, 8, 9 & Yes \\ \bottomrule \end{tabular} \end{centertable} @@ -204,7 +204,7 @@ In an exactly-one-of group, exactly one immediate child element must be matched. In EAPIs specified in table~\ref{tab:empty-dep-groups}, an empty exactly-one-of group counts as being matched. -\ChangeWhenAddingAnEAPI{8} +\ChangeWhenAddingAnEAPI{9} \begin{centertable}{Matching of empty dependency groups in EAPIs} \label{tab:empty-dep-groups} \begin{tabular}{ll} @@ -214,7 +214,7 @@ being matched. are matched?}} \\ \midrule 0, 1, 2, 3, 4, 5, 6 & Yes \\ - 7, 8& No \\ + 7, 8, 9 & No \\ \bottomrule \end{tabular} \end{centertable} @@ -250,7 +250,7 @@ manager must warn or error if this feature is used with an EAPI not supporting u \note{Order is important. The slot restriction must come before use dependencies.} -\ChangeWhenAddingAnEAPI{8} +\ChangeWhenAddingAnEAPI{9} \begin{centertable}{Support for \t{SLOT} dependencies and sub-slots in EAPIs} \label{tab:slot-deps-table} \begin{tabular}{lll} @@ -261,12 +261,12 @@ manager must warn or error if this feature is used with an EAPI not supporting u \midrule 0 & No & No \\ 1, 2, 3, 4& Named only & No \\ - 5, 6, 7, 8& Named and operator & Yes \\ + 5, 6, 7, 8, 9 & Named and operator & Yes \\ \bottomrule \end{tabular} \end{centertable} -\ChangeWhenAddingAnEAPI{8} +\ChangeWhenAddingAnEAPI{9} \begin{centertable}{EAPIs supporting \t{USE} dependencies} \label{tab:use-deps-table} \begin{tabular}{ll} @@ -276,7 +276,7 @@ manager must warn or error if
[gentoo-commits] proj/pms:eapi-9 commit in: /
commit: fda72fbb4cec7d11939d64505cb30d0672a6e38f Author: Ulrich Müller gentoo org> AuthorDate: Mon Feb 21 18:32:43 2022 + Commit: Ulrich Müller gentoo org> CommitDate: Mon Apr 10 07:17:11 2023 + URL:https://gitweb.gentoo.org/proj/pms.git/commit/?id=fda72fbb EAPI 9 profile EAPI defaults to top-level Bug: https://bugs.gentoo.org/806181 Signed-off-by: Ulrich Müller gentoo.org> eapi-differences.tex | 4 profiles.tex | 23 +-- 2 files changed, 25 insertions(+), 2 deletions(-) diff --git a/eapi-differences.tex b/eapi-differences.tex index 79b3931..37e59cf 100644 --- a/eapi-differences.tex +++ b/eapi-differences.tex @@ -35,6 +35,9 @@ Less strict filenames in \t{updates} & \compactfeatureref{updates-filenames} & Comments in profiles \t{parent} file & \compactfeatureref{parent-comments} & No & No & No & Yes \\ +Default EAPI for profiles & \compactfeatureref{profile-eapi-default} & +0 & 0 & 0 & Top-level \\ + Profile files as directories & \compactfeatureref{profile-file-dirs} & No & Yes & Yes & Yes \\ @@ -356,6 +359,7 @@ EAPI 9 is EAPI 8 with the following changes: \begin{compactitem} \item Comments in profiles \t{parent} file, \featureref{parent-comments}. +\item Different default EAPI for profiles, \featureref{profile-eapi-default}. \end{compactitem} \ChangeWhenAddingAnEAPI{9} diff --git a/profiles.tex b/profiles.tex index 6fa8a1c..de59f0a 100644 --- a/profiles.tex +++ b/profiles.tex @@ -50,8 +50,27 @@ this file must not contain comments or blank lines. A profile directory may contain an \t{eapi} file. This file, if it exists, must contain a single line with the name of an EAPI\@. This specifies the EAPI to use when handling the directory in question; a package manager must not attempt to use any profile using a directory which requires an -EAPI it does not support. If no \t{eapi} file is present, EAPI 0 shall be used. The EAPI is neither -inherited via the \t{parent} file nor in subdirectories. +EAPI it does not support. + +\featurelabel{profile-eapi-default} If no \t{eapi} file is present, the default depends on the EAPI +of the top-level profiles directory (see section~\ref{sec:profiles-dir}). That EAPI shall be used +if table~\ref{tab:profile-eapi-default} lists it as ``top-level''. Otherwise, EAPI 0 shall be used. + +The EAPI is neither inherited via the \t{parent} file nor in subdirectories. + +\ChangeWhenAddingAnEAPI{9} +\begin{centertable}{Default EAPI for profiles} +\label{tab:profile-eapi-default} +\begin{tabular}{ll} + \toprule + \multicolumn{1}{c}{\textbf{EAPI}} & + \multicolumn{1}{c}{\textbf{Default EAPI?}} \\ + \midrule + 0, 1, 2, 3, 4, 5, 6, 7, 8 & 0 \\ + 9 & Top-level \\ + \bottomrule +\end{tabular} +\end{centertable} \subsection{deprecated} If a profile contains a file named \t{deprecated}, it is treated as such. The first line of this
[gentoo-commits] proj/pms:eapi-9 commit in: /
commit: d7ad6126cfc378797557e94e48386929694f133e Author: Ulrich Müller gentoo org> AuthorDate: Fri Aug 19 21:22:40 2022 + Commit: Ulrich Müller gentoo org> CommitDate: Mon Apr 10 07:17:09 2023 + URL:https://gitweb.gentoo.org/proj/pms.git/commit/?id=d7ad6126 EAPI feature table: Don't use a landscape table Drop EAPIs 0 to 5 from the table, as well as items that would have identical entries for all listed EAPIs. Signed-off-by: Ulrich Müller gentoo.org> eapi-differences.tex | 321 ++- pms.cls | 2 +- 2 files changed, 61 insertions(+), 262 deletions(-) diff --git a/eapi-differences.tex b/eapi-differences.tex index 225c2b6..b20693a 100644 --- a/eapi-differences.tex +++ b/eapi-differences.tex @@ -1,39 +1,24 @@ \chapter{Feature Availability by EAPI} \note{This chapter is informative and for convenience only. Refer to the main text for specifics. -For lack of space, EAPIs 0, 1, 2, 3, and~4 have been consolidated into a single column in the table -below; entries marked with an asterisk differ between these EAPIs. See the 2012-09-20 edition -of this document for a complete table of previous EAPIs.} -% 2012-09-20 (EAPI 5) edition has a table of EAPIs 0 to 5 +For lack of space, EAPIs 0 to~5 have been omitted from the table below, as well as items that would +have identical entries for all listed EAPIs.} \ChangeWhenAddingAnEAPI{8} -\begin{landscape} -\begin{longtable}{llP{7.5em}P{7.5em}P{7.5em}P{7.5em}P{7.5em}} +\begin{longtable}{@{}l@{}} \caption{Features in EAPIs}\\ \toprule \multicolumn{1}{c}{\textbf{Feature}} & -\multicolumn{1}{c}{\textbf{Reference}} & -\multicolumn{5}{c}{\textbf{EAPIs}} \\ -\multicolumn{1}{c}{} & -\multicolumn{1}{c}{} & -\multicolumn{1}{c}{0, 1, 2, 3, 4} & -\multicolumn{1}{c}{5} & -\multicolumn{1}{c}{6} & -\multicolumn{1}{c}{7} & -\multicolumn{1}{c}{8} \\ +\multicolumn{1}{c}{\textbf{Ref.}} & +\multicolumn{3}{c}{\textbf{EAPIs}} \\ +& & 6 & 7 & 8 \\ \midrule \endfirsthead \midrule \multicolumn{1}{c}{\textbf{Feature}} & -\multicolumn{1}{c}{\textbf{Reference}} & -\multicolumn{5}{c}{\textbf{EAPIs}} \\ -\multicolumn{1}{c}{} & -\multicolumn{1}{c}{} & -\multicolumn{1}{c}{0, 1, 2, 3, 4} & -\multicolumn{1}{c}{5} & -\multicolumn{1}{c}{6} & -\multicolumn{1}{c}{7} & -\multicolumn{1}{c}{8} \\ +\multicolumn{1}{c}{\textbf{Ref.}} & +\multicolumn{3}{c}{\textbf{EAPIs}} \\ +& & 6 & 7 & 8 \\ \midrule \endhead \midrule @@ -42,334 +27,148 @@ of this document for a complete table of previous EAPIs.} \endlastfoot \t{package.mask} directory & \compactfeatureref{package-mask-dir} & -No & No & No & Yes & Yes \\ +No & Yes & Yes \\ Less strict filenames in \t{updates} & \compactfeatureref{updates-filenames} & -No & No & No & No & Yes \\ +No & No & Yes \\ Profile files as directories & \compactfeatureref{profile-file-dirs} & -No & No & No & Yes & Yes \\ +No & Yes & Yes \\ \t{package.provided} & \compactfeatureref{package-provided} & -Optional & Optional & Optional & No & No \\ - -Stable use masking/forcing & \compactfeatureref{stablemask} & -No & Yes & Yes & Yes & Yes \\ +Optional & No & No \\ Bash version & \compactfeatureref{bash-version} & -3.2 & 3.2 & 4.2 & 4.2 & 5.0 \\ - -\t{failglob} in global scope & \compactfeatureref{failglob} & -No & No & Yes & Yes & Yes \\ - -\t{IUSE} defaults & \compactfeatureref{iuse-defaults} & -* & Yes & Yes & Yes & Yes \\ - -\t{REQUIRED_USE} & \compactfeatureref{required-use} & -* & Yes & Yes & Yes & Yes \\ - -\t{PROPERTIES} & \compactfeatureref{properties} & -* & Yes & Yes & Yes & Yes \\ - -\t{SRC_URI} arrows & \compactfeatureref{src-uri-arrows} & -* & Yes & Yes & Yes & Yes \\ +4.2 & 4.2 & 5.0 \\ Selective URI restrictions & \compactfeatureref{uri-restrict} & -No & No & No & No & Yes \\ - -\t{RDEPEND=DEPEND} & \compactfeatureref{rdepend-depend} & -* & No & No & No & No \\ - -\t{DEFINED_PHASES} & \compactfeatureref{defined-phases} & -* & Yes & Yes & Yes & Yes \\ +No & No & Yes \\ \t{BDEPEND} & \compactfeatureref{bdepend} & -No & No & No & Yes & Yes \\ +No & Yes & Yes \\ \t{IDEPEND} & \compactfeatureref{idepend} & -No & No & No & No & Yes \\ - -\t{??\ ( )} groups & \compactfeatureref{at-most-one-of} & -No & Yes & Yes & Yes & Yes \\ +No & No & Yes \\ Empty \t{||}, \t{\textasciicircum\textasciicircum} groups match & \compactfeatureref{empty-dep-groups} & -Yes & Yes & Yes & No & No \\ - -Slot dependencies & \compactfeatureref{slot-deps} & -* & Named and Operator & Named and Operator & Named and Operator & Named and Operator \\ - -Sub-slots & \compactfeatureref{sub-slot} & -No & Yes & Yes & Yes & Yes \\ - -Use dependencies & \compactfeatureref{use-deps} & -* & 4-style & 4-style & 4-style & 4-style \\ - -\t{!}\ blockers & \compactfeatureref{bang-strength} & -* & Weak & Weak & Weak & Weak \\ - -\t{!!}\ blockers &
[gentoo-commits] proj/pms:eapi-9 commit in: /
commit: 6a3293622a5bc481c0cd4ca74d480632b681c563 Author: Ulrich Müller gentoo org> AuthorDate: Mon Feb 21 18:30:11 2022 + Commit: Ulrich Müller gentoo org> CommitDate: Mon Apr 10 07:17:10 2023 + URL:https://gitweb.gentoo.org/proj/pms.git/commit/?id=6a329362 EAPI 9 profile parent files can contain comments Bug: https://bugs.gentoo.org/470094 Signed-off-by: Ulrich Müller gentoo.org> eapi-differences.tex | 5 - profiles.tex | 20 +++- 2 files changed, 23 insertions(+), 2 deletions(-) diff --git a/eapi-differences.tex b/eapi-differences.tex index 2df5361..79b3931 100644 --- a/eapi-differences.tex +++ b/eapi-differences.tex @@ -32,6 +32,9 @@ have identical entries for all listed EAPIs.} Less strict filenames in \t{updates} & \compactfeatureref{updates-filenames} & No & No & Yes & Yes \\ +Comments in profiles \t{parent} file & \compactfeatureref{parent-comments} & +No & No & No & Yes \\ + Profile files as directories & \compactfeatureref{profile-file-dirs} & No & Yes & Yes & Yes \\ @@ -352,7 +355,7 @@ EAPI 8 is EAPI 7 with the following changes: EAPI 9 is EAPI 8 with the following changes: \begin{compactitem} -\item None +\item Comments in profiles \t{parent} file, \featureref{parent-comments}. \end{compactitem} \ChangeWhenAddingAnEAPI{9} diff --git a/profiles.tex b/profiles.tex index 8d8226a..6fa8a1c 100644 --- a/profiles.tex +++ b/profiles.tex @@ -25,7 +25,25 @@ first, left to right, with duplicate parent paths being sourced for every time t It is illegal for a profile's parent tree to contain cycles. Package manager behaviour upon encountering a cycle is undefined. -This file must not contain comments, blank lines or make use of line continuations. +This file must not make use of line continuations. + +\featurelabel{parent-comments} For EAPIs listed in table~\ref{tab:profile-parent-comments} as +allowing comments, blank lines and lines beginning with a \t{\#} are discarded. For other EAPIs, +this file must not contain comments or blank lines. + +\ChangeWhenAddingAnEAPI{9} +\begin{centertable}{EAPIs allowing comments in \t{parent} file} +\label{tab:profile-parent-comments} +\begin{tabular}{ll} + \toprule + \multicolumn{1}{c}{\textbf{EAPI}} & + \multicolumn{1}{c}{\textbf{Allows comments?}} \\ + \midrule + 0, 1, 2, 3, 4, 5, 6, 7, 8 & No \\ + 9 & Yes \\ + \bottomrule +\end{tabular} +\end{centertable} \subsection{The eapi file} \label{sec:profile-eapi}
[gentoo-commits] proj/pms:eapi-9 commit in: /
commit: a46337e16ed635686a063372924b2d441c7a5bdb Author: Ulrich Müller gentoo org> AuthorDate: Mon Feb 21 18:57:30 2022 + Commit: Ulrich Müller gentoo org> CommitDate: Mon Feb 27 11:05:23 2023 + URL:https://gitweb.gentoo.org/proj/pms.git/commit/?id=a46337e1 EAPI 9: econf matches configure --help output better Bug: https://bugs.gentoo.org/815169 Signed-off-by: Ulrich Müller gentoo.org> eapi-differences.tex | 4 pkg-mgr-commands.tex | 18 ++ 2 files changed, 22 insertions(+) diff --git a/eapi-differences.tex b/eapi-differences.tex index 37e59cf..45ba41b 100644 --- a/eapi-differences.tex +++ b/eapi-differences.tex @@ -141,6 +141,9 @@ Output commands use stdout & \compactfeatureref{output-no-stdout} & \t{econf -{}-disable-static} & \compactfeatureref{econf-options} & No & No & Yes & Yes \\ +\t{econf} better matching of options & \compactfeatureref{econf-options} & +No & No & No & Yes \\ + \t{domo} destination path & \compactfeatureref{domo-path} & \t{\$\{DESTTREE\}} & \t{/usr} & \t{/usr} & \t{/usr} \\ @@ -360,6 +363,7 @@ EAPI 9 is EAPI 8 with the following changes: \begin{compactitem} \item Comments in profiles \t{parent} file, \featureref{parent-comments}. \item Different default EAPI for profiles, \featureref{profile-eapi-default}. +\item \t{econf} matches \t{configure -{}-help} output better, \featureref{econf-options}. \end{compactitem} \ChangeWhenAddingAnEAPI{9} diff --git a/pkg-mgr-commands.tex b/pkg-mgr-commands.tex index 2716faa..e6e0437 100644 --- a/pkg-mgr-commands.tex +++ b/pkg-mgr-commands.tex @@ -347,6 +347,10 @@ commands once the current phase function has returned. is immediately followed by any of the characters \t{[A-Za-z0-9+_.-]}. \end{itemize} +For EAPIs listed in table~\ref{tab:econf-match-end} as matching the end of the option string, +a string in \t{configure -{}-help} output matches only if it is not immediately followed by any +of the characters \t{[A-Za-z0-9+_.-]}. + \ChangeWhenAddingAnEAPI{9} % two places \begin{centertable}{Extra \t{econf} arguments for EAPIs} \label{tab:econf-options-table} @@ -376,6 +380,20 @@ commands once the current phase function has returned. \end{tabular} \end{centertable} +\ChangeWhenAddingAnEAPI{9} +\begin{centertable}{EAPIs matching end of option string in \t{configure -{}-help} output} +\label{tab:econf-match-end} +\begin{tabular}{ll} + \toprule + \multicolumn{1}{c}{\textbf{EAPI}} & + \multicolumn{1}{c}{\textbf{Matches end of option string?}} \\ + \midrule + 0, 1, 2, 3, 4, 5, 6, 7, 8 & No \\ + 9 & Yes \\ + \bottomrule +\end{tabular} +\end{centertable} + Note that the \t{\$\{EPREFIX\}} component represents the same offset-prefix as described in table~\ref{tab:defined-vars}. It facilitates offset-prefix installations which is supported by EAPIs listed in table~\ref{tab:offset-env-vars-table}. When no offset-prefix installation is in
[gentoo-commits] proj/pms:eapi-9 commit in: /
commit: 3cd4184aa9dac4612e1094c36b1959cdbc9c1585 Author: Ulrich Müller gentoo org> AuthorDate: Mon Feb 21 18:57:30 2022 + Commit: Ulrich Müller gentoo org> CommitDate: Sun Feb 26 17:40:19 2023 + URL:https://gitweb.gentoo.org/proj/pms.git/commit/?id=3cd4184a EAPI 9: econf matches configure --help output better Bug: https://bugs.gentoo.org/815169 Signed-off-by: Ulrich Müller gentoo.org> eapi-differences.tex | 4 pkg-mgr-commands.tex | 18 ++ 2 files changed, 22 insertions(+) diff --git a/eapi-differences.tex b/eapi-differences.tex index 37e59cf..45ba41b 100644 --- a/eapi-differences.tex +++ b/eapi-differences.tex @@ -141,6 +141,9 @@ Output commands use stdout & \compactfeatureref{output-no-stdout} & \t{econf -{}-disable-static} & \compactfeatureref{econf-options} & No & No & Yes & Yes \\ +\t{econf} better matching of options & \compactfeatureref{econf-options} & +No & No & No & Yes \\ + \t{domo} destination path & \compactfeatureref{domo-path} & \t{\$\{DESTTREE\}} & \t{/usr} & \t{/usr} & \t{/usr} \\ @@ -360,6 +363,7 @@ EAPI 9 is EAPI 8 with the following changes: \begin{compactitem} \item Comments in profiles \t{parent} file, \featureref{parent-comments}. \item Different default EAPI for profiles, \featureref{profile-eapi-default}. +\item \t{econf} matches \t{configure -{}-help} output better, \featureref{econf-options}. \end{compactitem} \ChangeWhenAddingAnEAPI{9} diff --git a/pkg-mgr-commands.tex b/pkg-mgr-commands.tex index 2716faa..eeb0f49 100644 --- a/pkg-mgr-commands.tex +++ b/pkg-mgr-commands.tex @@ -347,6 +347,10 @@ commands once the current phase function has returned. is immediately followed by any of the characters \t{[A-Za-z0-9+_.-]}. \end{itemize} +For EAPIs listed in table~\ref{tab:econf-match-end} as matching the end of the option string, +a string in \t{configure -{}-help} output will only match if it is not immediately followed by +any of the characters \t{[A-Za-z0-9+_.-]}. + \ChangeWhenAddingAnEAPI{9} % two places \begin{centertable}{Extra \t{econf} arguments for EAPIs} \label{tab:econf-options-table} @@ -376,6 +380,20 @@ commands once the current phase function has returned. \end{tabular} \end{centertable} +\ChangeWhenAddingAnEAPI{9} +\begin{centertable}{EAPIs matching end of option string in \t{configure -{}-help} output} +\label{tab:econf-match-end} +\begin{tabular}{ll} + \toprule + \multicolumn{1}{c}{\textbf{EAPI}} & + \multicolumn{1}{c}{\textbf{Matches end of option string?}} \\ + \midrule + 0, 1, 2, 3, 4, 5, 6, 7, 8 & No \\ + 9 & Yes \\ + \bottomrule +\end{tabular} +\end{centertable} + Note that the \t{\$\{EPREFIX\}} component represents the same offset-prefix as described in table~\ref{tab:defined-vars}. It facilitates offset-prefix installations which is supported by EAPIs listed in table~\ref{tab:offset-env-vars-table}. When no offset-prefix installation is in
[gentoo-commits] proj/pms:eapi-9 commit in: /
commit: 9f29701e6c34079220dde59a3bc1ba53d9387cd0 Author: Ulrich Müller gentoo org> AuthorDate: Mon Feb 21 18:32:43 2022 + Commit: Ulrich Müller gentoo org> CommitDate: Sun Feb 26 17:40:19 2023 + URL:https://gitweb.gentoo.org/proj/pms.git/commit/?id=9f29701e EAPI 9 profile EAPI defaults to top-level Bug: https://bugs.gentoo.org/806181 Signed-off-by: Ulrich Müller gentoo.org> eapi-differences.tex | 4 profiles.tex | 23 +-- 2 files changed, 25 insertions(+), 2 deletions(-) diff --git a/eapi-differences.tex b/eapi-differences.tex index 79b3931..37e59cf 100644 --- a/eapi-differences.tex +++ b/eapi-differences.tex @@ -35,6 +35,9 @@ Less strict filenames in \t{updates} & \compactfeatureref{updates-filenames} & Comments in profiles \t{parent} file & \compactfeatureref{parent-comments} & No & No & No & Yes \\ +Default EAPI for profiles & \compactfeatureref{profile-eapi-default} & +0 & 0 & 0 & Top-level \\ + Profile files as directories & \compactfeatureref{profile-file-dirs} & No & Yes & Yes & Yes \\ @@ -356,6 +359,7 @@ EAPI 9 is EAPI 8 with the following changes: \begin{compactitem} \item Comments in profiles \t{parent} file, \featureref{parent-comments}. +\item Different default EAPI for profiles, \featureref{profile-eapi-default}. \end{compactitem} \ChangeWhenAddingAnEAPI{9} diff --git a/profiles.tex b/profiles.tex index 6fa8a1c..de59f0a 100644 --- a/profiles.tex +++ b/profiles.tex @@ -50,8 +50,27 @@ this file must not contain comments or blank lines. A profile directory may contain an \t{eapi} file. This file, if it exists, must contain a single line with the name of an EAPI\@. This specifies the EAPI to use when handling the directory in question; a package manager must not attempt to use any profile using a directory which requires an -EAPI it does not support. If no \t{eapi} file is present, EAPI 0 shall be used. The EAPI is neither -inherited via the \t{parent} file nor in subdirectories. +EAPI it does not support. + +\featurelabel{profile-eapi-default} If no \t{eapi} file is present, the default depends on the EAPI +of the top-level profiles directory (see section~\ref{sec:profiles-dir}). That EAPI shall be used +if table~\ref{tab:profile-eapi-default} lists it as ``top-level''. Otherwise, EAPI 0 shall be used. + +The EAPI is neither inherited via the \t{parent} file nor in subdirectories. + +\ChangeWhenAddingAnEAPI{9} +\begin{centertable}{Default EAPI for profiles} +\label{tab:profile-eapi-default} +\begin{tabular}{ll} + \toprule + \multicolumn{1}{c}{\textbf{EAPI}} & + \multicolumn{1}{c}{\textbf{Default EAPI?}} \\ + \midrule + 0, 1, 2, 3, 4, 5, 6, 7, 8 & 0 \\ + 9 & Top-level \\ + \bottomrule +\end{tabular} +\end{centertable} \subsection{deprecated} If a profile contains a file named \t{deprecated}, it is treated as such. The first line of this
[gentoo-commits] proj/pms:eapi-9 commit in: /
commit: 7e3dc6f383121e6215a04d20c3317e1592a869a0 Author: Ulrich Müller gentoo org> AuthorDate: Mon Jan 9 18:15:05 2023 + Commit: Ulrich Müller gentoo org> CommitDate: Mon Jan 9 18:15:05 2023 + URL:https://gitweb.gentoo.org/proj/pms.git/commit/?id=7e3dc6f3 pms.tex: Update copyright years Signed-off-by: Ulrich Müller gentoo.org> pms.tex | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pms.tex b/pms.tex index 1f9ecdb..f435f51 100644 --- a/pms.tex +++ b/pms.tex @@ -31,7 +31,7 @@ \vspace*{\fill} {% \small -\textcopyright{} 2007--2022 Stephen Bennett, Ciaran McCreesh and others. Contributions are owned +\textcopyright{} 2007--2023 Stephen Bennett, Ciaran McCreesh and others. Contributions are owned by their respective authors, and may have been changed substantially before inclusion. This work is released under the Creative Commons Attribution-ShareAlike 4.0 International
[gentoo-commits] proj/pms:eapi-9 commit in: /
commit: c26570a2306bf4ffe2963e3acdb82db19238f129 Author: Ulrich Müller gentoo org> AuthorDate: Tue Dec 27 21:31:46 2022 + Commit: Ulrich Müller gentoo org> CommitDate: Tue Dec 27 21:31:46 2022 + URL:https://gitweb.gentoo.org/proj/pms.git/commit/?id=c26570a2 Revert "Appendix: Do not number sections." This reverts commit 1da137e49aa5a52bb13500192d394b6dd53210da. Signed-off-by: Ulrich Müller gentoo.org> pms.tex | 1 - 1 file changed, 1 deletion(-) diff --git a/pms.tex b/pms.tex index 07113a9..1f9ecdb 100644 --- a/pms.tex +++ b/pms.tex @@ -66,7 +66,6 @@ \bibliography{pms} \appendix -\setcounter{secnumdepth}{0} \include{appendices} \include{eapi-differences} \include{desk-reference}
[gentoo-commits] proj/pms:eapi-9 commit in: /
commit: 39d51402f2eaa0ca06cb52ca3f5e1562a3496dbd Author: Ulrich Müller gentoo org> AuthorDate: Wed Jan 18 21:11:32 2023 + Commit: Ulrich Müller gentoo org> CommitDate: Wed Jan 18 21:11:32 2023 + URL:https://gitweb.gentoo.org/proj/pms.git/commit/?id=39d51402 Whitespace Signed-off-by: Ulrich Müller gentoo.org> dependencies.tex | 4 ++-- ebuild-env-vars.tex | 8 ebuild-functions.tex | 5 +++-- eclasses.tex | 4 ++-- introduction.tex | 6 +++--- merge.tex| 4 ++-- 6 files changed, 16 insertions(+), 15 deletions(-) diff --git a/dependencies.tex b/dependencies.tex index 0ff1c7e..6c09714 100644 --- a/dependencies.tex +++ b/dependencies.tex @@ -240,8 +240,8 @@ error on non-compliant input. In EAPIs shown in table~\ref{tab:slot-deps-table} as supporting \t{SLOT} dependencies, either of the above formats may additionally be suffixed by a \t{:slot} restriction, as described in -section~\ref{sec:slot-dep}. A package manager must warn or error if slot dependencies are used with an -EAPI not supporting \t{SLOT} dependencies. +section~\ref{sec:slot-dep}. A package manager must warn or error if slot dependencies are used with +an EAPI not supporting \t{SLOT} dependencies. \featurelabel{use-deps} In EAPIs shown in table~\ref{tab:use-deps-table} as supporting 2-style or 4-style \t{USE} dependencies, a specification may additionally be suffixed by at most one diff --git a/ebuild-env-vars.tex b/ebuild-env-vars.tex index db693ab..004a7a2 100644 --- a/ebuild-env-vars.tex +++ b/ebuild-env-vars.tex @@ -6,10 +6,10 @@ meaningful in all phases; variables that are not meaningful in a given phase may any value. Ebuilds must not attempt to modify any of these variables, unless otherwise specified. Because of their special meanings, these variables may not be preserved consistently across all -phases as would normally happen due to environment saving (see~\ref{sec:ebuild-env-state}). For example, -\t{EBUILD_PHASE} is different for every phase, and \t{ROOT} may have changed between the various -different \t{pkg_*} phases. Ebuilds must recalculate any variable they derive from an inconsistent -variable. +phases as would normally happen due to environment saving (see~\ref{sec:ebuild-env-state}). +For example, \t{EBUILD_PHASE} is different for every phase, and \t{ROOT} may have changed between +the various different \t{pkg_*} phases. Ebuilds must recalculate any variable they derive from an +inconsistent variable. \begin{landscape} \reversemarginpar diff --git a/ebuild-functions.tex b/ebuild-functions.tex index 0c745c3..7d372fa 100644 --- a/ebuild-functions.tex +++ b/ebuild-functions.tex @@ -434,8 +434,9 @@ the \t{ROOT} environment variable. \subsection{pkg_config} -The \t{pkg_config} function performs any custom steps required to configure a package after it has been -fully installed. It is the only ebuild function which may be interactive and prompt for user input. +The \t{pkg_config} function performs any custom steps required to configure a package after it has +been fully installed. It is the only ebuild function which may be interactive and prompt for user +input. \t{pkg_config} must be run with full access to all files and directories inside of \t{ROOT}. diff --git a/eclasses.tex b/eclasses.tex index e23dcd8..01692bc 100644 --- a/eclasses.tex +++ b/eclasses.tex @@ -8,8 +8,8 @@ using them. The interpreter is therefore the same, and the same requirements for hold. Eclasses must be located in the \t{eclass} directory in the top level of the repository---see -section~\ref{sec:eclass-dir}. Each eclass is a single file named \t{.eclass}, where \t{} is -the name of this eclass, used by \t{inherit} and \t{EXPORT_FUNCTIONS} among other places. +section~\ref{sec:eclass-dir}. Each eclass is a single file named \t{.eclass}, where \t{} +is the name of this eclass, used by \t{inherit} and \t{EXPORT_FUNCTIONS} among other places. \section{The inherit Command} \label{sec:inherit} diff --git a/introduction.tex b/introduction.tex index 57fb51a..86149b2 100644 --- a/introduction.tex +++ b/introduction.tex @@ -13,9 +13,9 @@ This document does not specify any user or package manager configuration informa \section{Rationale} -At present the only definition of what an ebuild can assume about its environment, -and the only definition of what is valid in an ebuild, is the source code of the latest Portage release -and a general consensus about which features are too new to assume availability. This has several +At present the only definition of what an ebuild can assume about its environment, and the only +definition of what is valid in an ebuild, is the source code of the latest Portage release and +a general consensus about which features are too new to assume availability. This has several drawbacks: not only is it impossible to change any aspect of Portage behaviour without verifying that nothing in
[gentoo-commits] proj/pms:eapi-9 commit in: /
commit: d32b043a7d06f1d5477f07c57e250e82a5e11915 Author: Ulrich Müller gentoo org> AuthorDate: Tue Aug 3 16:32:47 2021 + Commit: Ulrich Müller gentoo org> CommitDate: Sun Feb 26 17:40:18 2023 + URL:https://gitweb.gentoo.org/proj/pms.git/commit/?id=d32b043a Add an EAPI 9 identical to EAPI 8 Signed-off-by: Ulrich Müller gentoo.org> commands.tex | 4 +- dependencies.tex | 26 +-- eapi-differences.tex | 116 +++--- eapis.tex | 4 +- ebuild-env-vars.tex | 26 +-- ebuild-format.tex | 4 +- ebuild-functions.tex | 46 ++-- ebuild-vars.tex | 22 +- eclasses.tex | 4 +- merge.tex | 6 +-- pkg-mgr-commands.tex | 100 +-- pms.tex | 4 +- profile-variables.tex | 8 ++-- profiles.tex | 12 +++--- tree-layout.tex | 8 ++-- 15 files changed, 199 insertions(+), 191 deletions(-) diff --git a/commands.tex b/commands.tex index d0ad87d..c6f4f36 100644 --- a/commands.tex +++ b/commands.tex @@ -33,7 +33,7 @@ The following commands must always be available in the ebuild environment: table~\ref{tab:system-commands-table} as requiring GNU find. \end{compactitem} -\ChangeWhenAddingAnEAPI{8} +\ChangeWhenAddingAnEAPI{9} \begin{centertable}{System commands for EAPIs} \label{tab:system-commands-table} \begin{tabular}{lll} @@ -44,7 +44,7 @@ The following commands must always be available in the ebuild environment: \midrule 0, 1, 2, 3, 4 & Undefined & Any \\ 5, 6 & Yes & Any \\ - 7, 8 & Yes & 2.7 \\ + 7, 8, 9 & Yes & 2.7 \\ \bottomrule \end{tabular} \end{centertable} diff --git a/dependencies.tex b/dependencies.tex index 6c09714..6b58f54 100644 --- a/dependencies.tex +++ b/dependencies.tex @@ -88,7 +88,7 @@ with the native build system (\t{CBUILD}). Ebuilds are allowed to call them in \ \t{pkg_postinst}. Ebuilds may also call them in \t{pkg_prerm} and \t{pkg_postrm} but must not rely on them being available. -\ChangeWhenAddingAnEAPI{8} +\ChangeWhenAddingAnEAPI{9} \begin{centertable}{EAPIs supporting additional dependency types} \label{tab:depend-table} \begin{tabular}{lll} @@ -99,7 +99,7 @@ on them being available. \midrule 0, 1, 2, 3, 4, 5, 6 & No & No \\ 7 & Yes & No \\ - 8 & Yes & Yes \\ + 8, 9& Yes & Yes \\ \bottomrule \end{tabular} \end{centertable} @@ -155,7 +155,7 @@ be surrounded on both sides by whitespace, except at the start and end of the st In particular, note that whitespace is not optional. -\ChangeWhenAddingAnEAPI{8} +\ChangeWhenAddingAnEAPI{9} \begin{centertable}{EAPIs supporting \t{REQUIRED_USE ??}\ groups} \label{tab:at-most-one-of-table} \begin{tabular}{ll} @@ -164,7 +164,7 @@ In particular, note that whitespace is not optional. \multicolumn{1}{c}{\textbf{Supports \t{REQUIRED_USE ??}\ groups?}} \\ \midrule 0, 1, 2, 3, 4 & No \\ - 5, 6, 7, 8& Yes \\ + 5, 6, 7, 8, 9 & Yes \\ \bottomrule \end{tabular} \end{centertable} @@ -204,7 +204,7 @@ In an exactly-one-of group, exactly one immediate child element must be matched. In EAPIs specified in table~\ref{tab:empty-dep-groups}, an empty exactly-one-of group counts as being matched. -\ChangeWhenAddingAnEAPI{8} +\ChangeWhenAddingAnEAPI{9} \begin{centertable}{Matching of empty dependency groups in EAPIs} \label{tab:empty-dep-groups} \begin{tabular}{ll} @@ -214,7 +214,7 @@ being matched. are matched?}} \\ \midrule 0, 1, 2, 3, 4, 5, 6 & Yes \\ - 7, 8& No \\ + 7, 8, 9 & No \\ \bottomrule \end{tabular} \end{centertable} @@ -250,7 +250,7 @@ manager must warn or error if this feature is used with an EAPI not supporting u \note{Order is important. The slot restriction must come before use dependencies.} -\ChangeWhenAddingAnEAPI{8} +\ChangeWhenAddingAnEAPI{9} \begin{centertable}{Support for \t{SLOT} dependencies and sub-slots in EAPIs} \label{tab:slot-deps-table} \begin{tabular}{lll} @@ -261,12 +261,12 @@ manager must warn or error if this feature is used with an EAPI not supporting u \midrule 0 & No & No \\ 1, 2, 3, 4& Named only & No \\ - 5, 6, 7, 8& Named and operator & Yes \\ + 5, 6, 7, 8, 9 & Named and operator & Yes \\ \bottomrule \end{tabular} \end{centertable} -\ChangeWhenAddingAnEAPI{8} +\ChangeWhenAddingAnEAPI{9} \begin{centertable}{EAPIs supporting \t{USE} dependencies} \label{tab:use-deps-table} \begin{tabular}{ll} @@ -276,7 +276,7 @@ manager must warn or error if
[gentoo-commits] proj/pms:eapi-9 commit in: /
commit: 9264cfb906e0eae7c44596c6c339715ef6191a50 Author: Ulrich Müller gentoo org> AuthorDate: Fri Dec 9 19:03:30 2022 + Commit: Ulrich Müller gentoo org> CommitDate: Fri Dec 9 19:03:30 2022 + URL:https://gitweb.gentoo.org/proj/pms.git/commit/?id=9264cfb9 appendices.tex: No line break before GLEP number Signed-off-by: Ulrich Müller gentoo.org> appendices.tex | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/appendices.tex b/appendices.tex index 69bd2ed..d87d1be 100644 --- a/appendices.tex +++ b/appendices.tex @@ -3,7 +3,7 @@ The \t{metadata.xml} file is used to contain extra package- or category-level information beyond what is stored in ebuild metadata. Its exact format is strictly beyond the scope of this document, -and is described in GLEP 68~\cite{Glep68}. +and is described in GLEP~68~\cite{Glep68}. \chapter{Unspecified Items} @@ -76,7 +76,7 @@ the \t{PROVIDE} metadata that it supplied certain virtuals, and the package mana in mind when handling dependencies. Old-style virtuals were supported by EAPIs \t{0}, \t{1}, \t{2}, \t{3} and \t{4}. They were phased -out via GLEP 37~\cite{Glep37} and finally removed in 2011. +out via GLEP~37~\cite{Glep37} and finally removed in 2011. \note{A `new-style virtual' is a normal package that installs no files and uses its dependency requirements to pull in a `provider'. This does not require any special handling from the package @@ -87,7 +87,7 @@ The method to specify the EAPI of an ebuild used to be a shell variable assignme manager had to source the ebuild in order to determine the EAPI\@. Therefore any ebuild using a future EAPI would still have to be sourceable by old package managers, which imposed restrictions e.\,g.\ on updating the Bash version or on possible changes of global scope functions. Several -approaches to overcome this limitation were discussed, notably GLEP 55~\cite{Glep55}, which was +approaches to overcome this limitation were discussed, notably GLEP~55~\cite{Glep55}, which was rejected though. The current syntax of the \t{EAPI} assignment statement (see section~\ref{sec:eapi}), allowing
[gentoo-commits] proj/pms:eapi-9 commit in: /
commit: f344e519a5904b7994932058c97199ac67df74a6 Author: Ulrich Müller gentoo org> AuthorDate: Fri Aug 19 21:22:40 2022 + Commit: Ulrich Müller gentoo org> CommitDate: Sun Feb 26 17:40:17 2023 + URL:https://gitweb.gentoo.org/proj/pms.git/commit/?id=f344e519 EAPI feature table: Don't use a landscape table Drop EAPIs 0 to 5 from the table, as well as items that would have identical entries for all listed EAPIs. Signed-off-by: Ulrich Müller gentoo.org> eapi-differences.tex | 321 ++- pms.cls | 2 +- 2 files changed, 61 insertions(+), 262 deletions(-) diff --git a/eapi-differences.tex b/eapi-differences.tex index 225c2b6..b20693a 100644 --- a/eapi-differences.tex +++ b/eapi-differences.tex @@ -1,39 +1,24 @@ \chapter{Feature Availability by EAPI} \note{This chapter is informative and for convenience only. Refer to the main text for specifics. -For lack of space, EAPIs 0, 1, 2, 3, and~4 have been consolidated into a single column in the table -below; entries marked with an asterisk differ between these EAPIs. See the 2012-09-20 edition -of this document for a complete table of previous EAPIs.} -% 2012-09-20 (EAPI 5) edition has a table of EAPIs 0 to 5 +For lack of space, EAPIs 0 to~5 have been omitted from the table below, as well as items that would +have identical entries for all listed EAPIs.} \ChangeWhenAddingAnEAPI{8} -\begin{landscape} -\begin{longtable}{llP{7.5em}P{7.5em}P{7.5em}P{7.5em}P{7.5em}} +\begin{longtable}{@{}l@{}} \caption{Features in EAPIs}\\ \toprule \multicolumn{1}{c}{\textbf{Feature}} & -\multicolumn{1}{c}{\textbf{Reference}} & -\multicolumn{5}{c}{\textbf{EAPIs}} \\ -\multicolumn{1}{c}{} & -\multicolumn{1}{c}{} & -\multicolumn{1}{c}{0, 1, 2, 3, 4} & -\multicolumn{1}{c}{5} & -\multicolumn{1}{c}{6} & -\multicolumn{1}{c}{7} & -\multicolumn{1}{c}{8} \\ +\multicolumn{1}{c}{\textbf{Ref.}} & +\multicolumn{3}{c}{\textbf{EAPIs}} \\ +& & 6 & 7 & 8 \\ \midrule \endfirsthead \midrule \multicolumn{1}{c}{\textbf{Feature}} & -\multicolumn{1}{c}{\textbf{Reference}} & -\multicolumn{5}{c}{\textbf{EAPIs}} \\ -\multicolumn{1}{c}{} & -\multicolumn{1}{c}{} & -\multicolumn{1}{c}{0, 1, 2, 3, 4} & -\multicolumn{1}{c}{5} & -\multicolumn{1}{c}{6} & -\multicolumn{1}{c}{7} & -\multicolumn{1}{c}{8} \\ +\multicolumn{1}{c}{\textbf{Ref.}} & +\multicolumn{3}{c}{\textbf{EAPIs}} \\ +& & 6 & 7 & 8 \\ \midrule \endhead \midrule @@ -42,334 +27,148 @@ of this document for a complete table of previous EAPIs.} \endlastfoot \t{package.mask} directory & \compactfeatureref{package-mask-dir} & -No & No & No & Yes & Yes \\ +No & Yes & Yes \\ Less strict filenames in \t{updates} & \compactfeatureref{updates-filenames} & -No & No & No & No & Yes \\ +No & No & Yes \\ Profile files as directories & \compactfeatureref{profile-file-dirs} & -No & No & No & Yes & Yes \\ +No & Yes & Yes \\ \t{package.provided} & \compactfeatureref{package-provided} & -Optional & Optional & Optional & No & No \\ - -Stable use masking/forcing & \compactfeatureref{stablemask} & -No & Yes & Yes & Yes & Yes \\ +Optional & No & No \\ Bash version & \compactfeatureref{bash-version} & -3.2 & 3.2 & 4.2 & 4.2 & 5.0 \\ - -\t{failglob} in global scope & \compactfeatureref{failglob} & -No & No & Yes & Yes & Yes \\ - -\t{IUSE} defaults & \compactfeatureref{iuse-defaults} & -* & Yes & Yes & Yes & Yes \\ - -\t{REQUIRED_USE} & \compactfeatureref{required-use} & -* & Yes & Yes & Yes & Yes \\ - -\t{PROPERTIES} & \compactfeatureref{properties} & -* & Yes & Yes & Yes & Yes \\ - -\t{SRC_URI} arrows & \compactfeatureref{src-uri-arrows} & -* & Yes & Yes & Yes & Yes \\ +4.2 & 4.2 & 5.0 \\ Selective URI restrictions & \compactfeatureref{uri-restrict} & -No & No & No & No & Yes \\ - -\t{RDEPEND=DEPEND} & \compactfeatureref{rdepend-depend} & -* & No & No & No & No \\ - -\t{DEFINED_PHASES} & \compactfeatureref{defined-phases} & -* & Yes & Yes & Yes & Yes \\ +No & No & Yes \\ \t{BDEPEND} & \compactfeatureref{bdepend} & -No & No & No & Yes & Yes \\ +No & Yes & Yes \\ \t{IDEPEND} & \compactfeatureref{idepend} & -No & No & No & No & Yes \\ - -\t{??\ ( )} groups & \compactfeatureref{at-most-one-of} & -No & Yes & Yes & Yes & Yes \\ +No & No & Yes \\ Empty \t{||}, \t{\textasciicircum\textasciicircum} groups match & \compactfeatureref{empty-dep-groups} & -Yes & Yes & Yes & No & No \\ - -Slot dependencies & \compactfeatureref{slot-deps} & -* & Named and Operator & Named and Operator & Named and Operator & Named and Operator \\ - -Sub-slots & \compactfeatureref{sub-slot} & -No & Yes & Yes & Yes & Yes \\ - -Use dependencies & \compactfeatureref{use-deps} & -* & 4-style & 4-style & 4-style & 4-style \\ - -\t{!}\ blockers & \compactfeatureref{bang-strength} & -* & Weak & Weak & Weak & Weak \\ - -\t{!!}\ blockers &
[gentoo-commits] proj/pms:eapi-9 commit in: /
commit: ede65b5d136640575479c9c9a3162ee4d2be953e Author: Ulrich Müller gentoo org> AuthorDate: Tue Jan 3 20:11:28 2023 + Commit: Ulrich Müller gentoo org> CommitDate: Mon Jan 9 18:13:45 2023 + URL:https://gitweb.gentoo.org/proj/pms.git/commit/?id=ede65b5d ebuild-env-vars.tex: D is available as a variable in all src_* phases The D variable has been described as a "phase-specific variable" since the spec's early draft stage (SVN r19). However, Portage would always define the variable in all src_* phases, with the restriction that the directory would exist only in src_install(). In reality, not all ebuilds comply with the spec. For example, Perl eclasses use D in src_configure(), i.e. they rely on Portage behaviour. Therefore, lift this unnecessary and somewhat artificial restriction and make the variable (but not the directory) available outside the install phase. Signed-off-by: Ulrich Müller gentoo.org> ebuild-env-vars.tex | 15 +-- 1 file changed, 9 insertions(+), 6 deletions(-) diff --git a/ebuild-env-vars.tex b/ebuild-env-vars.tex index a55c366..db693ab 100644 --- a/ebuild-env-vars.tex +++ b/ebuild-env-vars.tex @@ -179,24 +179,27 @@ variable. See also~\ref{sec:offset-vars}. Only for EAPIs listed in table~\ref{tab:offset-env-vars-table} as supporting \t{EPREFIX}. \\ \t{D} & -\t{src_install} & -No & +\t{src_*} & +Yes & Contains the full path to the image directory into which the package should be installed. +Ebuilds must not attempt to access the directory in \t{src_*} phases other than \t{src_install}. The presence of a trailing slash is EAPI dependent as listed in table~\ref{tab:trailing-slash}. \\ \t{D} (continued) & \t{pkg_preinst}, \t{pkg_postinst} & -Yes & +Yes\footnote{Consistent across \t{pkg_preinst} and \t{pkg_postinst}, but may not necessarily +have the same value that it had in the \t{src_*} phases.} & Contains the full path to the image that is about to be or has just been merged. The presence of a trailing slash is EAPI dependent as listed in table~\ref{tab:trailing-slash}. \\ \t{ED} & -\t{src_install}, \t{pkg_preinst}, \t{pkg_postinst} & +\t{src_*}, \t{pkg_preinst}, \t{pkg_postinst} & See \t{D} & Contains the concatenation of the paths in the \t{D} and \t{EPREFIX} variables, for convenience. See also the \t{EPREFIX} variable. Only for EAPIs listed in -table~\ref{tab:offset-env-vars-table} as supporting \t{ED}\@. The presence of a trailing slash -is EAPI dependent as listed in table~\ref{tab:trailing-slash}. \\ +table~\ref{tab:offset-env-vars-table} as supporting \t{ED}\@. Ebuilds must not attempt to +access the directory in \t{src_*} phases other than \t{src_install}. The presence of a trailing +slash is EAPI dependent as listed in table~\ref{tab:trailing-slash}. \\ \t{DESTTREE} & \t{src_install} & No &
[gentoo-commits] proj/pms:eapi-9 commit in: /
commit: 5e9afb6d818201028acbe922c6d86e9bf27dd860 Author: Ulrich Müller gentoo org> AuthorDate: Sat Jan 14 09:28:01 2023 + Commit: Ulrich Müller gentoo org> CommitDate: Wed Jan 18 21:12:28 2023 + URL:https://gitweb.gentoo.org/proj/pms.git/commit/?id=5e9afb6d Distinguish between "phase" and "phase function" Signed-off-by: Ulrich Müller gentoo.org> ebuild-functions.tex | 6 +++--- eclasses.tex | 2 +- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/ebuild-functions.tex b/ebuild-functions.tex index 7d372fa..25164d4 100644 --- a/ebuild-functions.tex +++ b/ebuild-functions.tex @@ -477,9 +477,9 @@ source files from their respective locations, with notes concerning licensing if \featurelabel{default-phase-funcs} In EAPIs listed in table~\ref{tab:default-phase-function-table} as supporting \t{default_} phase functions, a function -named \t{default_}(phase) that behaves as the default implementation for that EAPI shall be defined -when executing any ebuild phase listed in the table. Ebuilds must not call these functions except -when in the phase in question. +named \t{default_}) that behaves as the default implementation for that EAPI shall +be defined when executing any ebuild phase function listed in the table. Ebuilds must not call +these functions except when in the phase in question. \ChangeWhenAddingAnEAPI{8} \begin{centertable}{EAPIs supporting \t{default_} phase functions} diff --git a/eclasses.tex b/eclasses.tex index 0b9b5d4..a4400e1 100644 --- a/eclasses.tex +++ b/eclasses.tex @@ -87,7 +87,7 @@ should the author wish to override it he can access the function in \t{foo.eclas \t{foo_src_compile}. \t{EXPORT_FUNCTIONS} must only be used on ebuild phase functions. The function that is aliased -must be named \t{eclassname_phasefunctionname}, where \t{eclassname} is the name of the eclass. +must be named \t{_}, where \t{} is the name of the eclass. If \t{EXPORT_FUNCTIONS} is called multiple times for the same phase function, the last call takes precedence. Eclasses may not rely upon any particular behaviour if they inherit another eclass
[gentoo-commits] proj/pms:eapi-9 commit in: /
commit: 08cdab4ab811b7cc3ceee356727f558eaef17b27 Author: Ulrich Müller gentoo org> AuthorDate: Fri Dec 9 19:29:04 2022 + Commit: Ulrich Müller gentoo org> CommitDate: Sun Dec 11 19:26:05 2022 + URL:https://gitweb.gentoo.org/proj/pms.git/commit/?id=08cdab4a appendices.tex: Mention EAPI for econf --disable-static Signed-off-by: Ulrich Müller gentoo.org> appendices.tex | 8 +--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/appendices.tex b/appendices.tex index ed90225..a093936 100644 --- a/appendices.tex +++ b/appendices.tex @@ -118,9 +118,11 @@ They were dropped from the specification in October 2017. The \t{-{}-disable-static} option in \t{econf} (see section~\ref{sec:build-commands}) was intended to disable only static Libtool archive building. The original check for either \t{-{}-disable-static} or \t{-{}-enable-static} occuring in \t{configure -{}-help} output produced -false positives. The specification was therefore updated in November 2022; it now requires both -\t{-{}-enable-static} and \t{-{}-enable-shared}, and in addition checks for a proper end of the -option string. +false positives. + +The test mentioned above was effective in EAPI~8. It was updated in November 2022 to require both +\t{-{}-enable-static} and \t{-{}-enable-shared}, and in addition checks for a proper end of these +option strings. % vim: set filetype=tex fileencoding=utf8 et tw=100 spell spelllang=en :
[gentoo-commits] proj/pms:eapi-9 commit in: /
commit: ab2bce21ac83e6ad6cc649ef09cd4bae334e4417 Author: Ulrich Müller gentoo org> AuthorDate: Tue Dec 27 21:35:14 2022 + Commit: Ulrich Müller gentoo org> CommitDate: Tue Dec 27 21:44:34 2022 + URL:https://gitweb.gentoo.org/proj/pms.git/commit/?id=ab2bce21 Makefile: Use guessable names for section references in HTML output This replaces the "x1*" fragment identifiers by more predictable ones with a "chapter", "section", or "appendix" prefix. This is possible because our section numbers are unique. Signed-off-by: Ulrich Müller gentoo.org> Makefile | 5 + 1 file changed, 5 insertions(+) diff --git a/Makefile b/Makefile index 89fd7a2..c882534 100644 --- a/Makefile +++ b/Makefile @@ -54,6 +54,11 @@ pms.html: $(LATEXFILES) pms.bbl $(COMMITINFO) @# remove redundant span elements LC_ALL=C sed -Ei ':x;/]*)?$$/{N;bx;};'\ ':y;s,(]*>)([^<]*)\1,\1\2,;ty' $@ + @# guessable names for sections + LC_ALL=C sed -Ei \ + -e 's/("#?)x1-[0-9]*00+([1-9][0-9]?")/\1chapter-\2/g' \ + -e 's/("#?)x1-[0-9]*00+([1-9][0-9]?(\.[0-9]+)+")/\1section-\2/g' \ + -e 's/("#?)x1-[0-9]*00+([A-Z](\.[0-9]+)*")/\1appendix-\2/g' $@ pms.bbl: pms.bib $(LATEXFILES) $(COMMITINFO) $(aux-clean)
[gentoo-commits] proj/pms:eapi-9 commit in: /
commit: eeddb7ad0b36822be7d3298caefa9475bc9dc466 Author: Ulrich Müller gentoo org> AuthorDate: Wed Feb 1 18:11:56 2023 + Commit: Ulrich Müller gentoo org> CommitDate: Wed Feb 1 18:11:56 2023 + URL:https://gitweb.gentoo.org/proj/pms.git/commit/?id=eeddb7ad ebuild-env-vars.tex: Fix indentation of list Signed-off-by: Ulrich Müller gentoo.org> ebuild-env-vars.tex | 14 +++--- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/ebuild-env-vars.tex b/ebuild-env-vars.tex index 004a7a2..7f430e7 100644 --- a/ebuild-env-vars.tex +++ b/ebuild-env-vars.tex @@ -117,13 +117,13 @@ inconsistent variable. \featurelabel{eclassdir} The full path to the master repository's eclass directory. Only for EAPIs listed in table~\ref{tab:removed-env-vars-table} as supporting \t{ECLASSDIR}. \\ \t{ROOT} & - \t{pkg_*} & - No & - The absolute path to the root directory into which the package is to be merged. Phases which run - with full filesystem access must not touch any files outside of the directory given in - \t{ROOT}\@. Also of note is that in a cross-compiling environment, binaries inside of \t{ROOT} - will not be executable on the build machine, so ebuilds must not call them. The presence of - a trailing slash is EAPI dependent as listed in table~\ref{tab:trailing-slash}. \\ +\t{pkg_*} & +No & +The absolute path to the root directory into which the package is to be merged. Phases which +run with full filesystem access must not touch any files outside of the directory given in +\t{ROOT}\@. Also of note is that in a cross-compiling environment, binaries inside of \t{ROOT} +will not be executable on the build machine, so ebuilds must not call them. The presence of +a trailing slash is EAPI dependent as listed in table~\ref{tab:trailing-slash}. \\ \t{EROOT} & \t{pkg_*} & No &
[gentoo-commits] proj/pms:eapi-9 commit in: /
commit: 2c69291b26fea14b6a93f1bf6b4f0bfd7f74f7b9 Author: Ulrich Müller gentoo org> AuthorDate: Wed Sep 7 06:35:09 2022 + Commit: Ulrich Müller gentoo org> CommitDate: Wed Sep 7 06:35:09 2022 + URL:https://gitweb.gentoo.org/proj/pms.git/commit/?id=2c69291b ebuild-format.tex: Document that umask is set to 022 Portage has been doing this since 2001. Closes: https://bugs.gentoo.org/868669 Reported-by: Mike Frysinger gentoo.org> Signed-off-by: Ulrich Müller gentoo.org> ebuild-format.tex | 3 +++ 1 file changed, 3 insertions(+) diff --git a/ebuild-format.tex b/ebuild-format.tex index 25ba28e..cf06668 100644 --- a/ebuild-format.tex +++ b/ebuild-format.tex @@ -7,6 +7,9 @@ table~\ref{tab:bash-version}, or any later version. If possible, the package man the shell's compatibility level to the exact version specified. It must ensure that any such compatibility settings (e.\,g.\ the \t{BASH_COMPAT} variable) are not exported to external programs. +The file creation mask (\t{umask}) is set to \t{022} in the shell execution environment. It is +\emph{not} saved between phase functions but always reset to this initial value. + \featurelabel{failglob} For EAPIs listed such in table~\ref{tab:bash-version}, the \t{failglob} option of bash is set in the global scope of ebuilds. If set, failed pattern matches during filename expansion result in an error when the ebuild is being sourced.
[gentoo-commits] proj/pms:eapi-9 commit in: /
commit: e0aa80cc0d28a25bfc68b4671771083e282f6ba2 Author: Ulrich Müller gentoo org> AuthorDate: Sat Nov 19 20:22:34 2022 + Commit: Ulrich Müller gentoo org> CommitDate: Sat Nov 19 20:22:34 2022 + URL:https://gitweb.gentoo.org/proj/pms.git/commit/?id=e0aa80cc pkg-mgr-commands.tex: Update condition for econf --disable-static (again) The intention is to pass --disable-static, in order to (only) disable static libtool archive building. The current condition asks for either of --{disable,enable}-static in configure --help output, which causes false positives: https://archives.gentoo.org/gentoo-portage-dev/message/efc3f424d1dffd3415da538ec25532a9 Therefore, narrow the condition to require both --enable-static and --enable-shared. In addition, backport the check for proper end of string from the EAPI 9 feature list, but restrict it to this option for now. Bug: https://bugs.gentoo.org/814368 Bug: https://bugs.gentoo.org/815169 Signed-off-by: Ulrich Müller gentoo.org> pkg-mgr-commands.tex | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/pkg-mgr-commands.tex b/pkg-mgr-commands.tex index d4dcffe..a3e8a41 100644 --- a/pkg-mgr-commands.tex +++ b/pkg-mgr-commands.tex @@ -341,8 +341,9 @@ commands once the current phase function has returned. as using it. This option will only be passed if the string \t{-{}-disable-silent-rules} occurs in the output of \t{configure -{}-help}. \item \t{-{}-disable-static}, if the EAPI is listed in table~\ref{tab:econf-options-table} -as using it. This option will only be passed if the string \t{-{}-disable-static} or -\t{-{}-enable-static} occurs in the output of \t{configure -{}-help}. +as using it. This option will only be passed if both strings \t{-{}-enable-static} and +\t{-{}-enable-shared} occur in the output of \t{configure -{}-help}, and if neither of them +is immediately followed by any of the characters \t{[A-Za-z0-9+_.-]}. \end{itemize} \ChangeWhenAddingAnEAPI{8}
[gentoo-commits] proj/pms:eapi-9 commit in: /
commit: c5a07aa426d0536f6ff9387af471105ebb0ba96e Author: Ulrich Müller gentoo org> AuthorDate: Wed Feb 1 18:12:48 2023 + Commit: Ulrich Müller gentoo org> CommitDate: Wed Feb 1 18:12:48 2023 + URL:https://gitweb.gentoo.org/proj/pms.git/commit/?id=c5a07aa4 Reference sections by "section 11.2" rather than "11.2" Signed-off-by: Ulrich Müller gentoo.org> ebuild-env-vars.tex| 8 ebuild-environment.tex | 6 +++--- 2 files changed, 7 insertions(+), 7 deletions(-) diff --git a/ebuild-env-vars.tex b/ebuild-env-vars.tex index 7f430e7..b8deb04 100644 --- a/ebuild-env-vars.tex +++ b/ebuild-env-vars.tex @@ -6,7 +6,7 @@ meaningful in all phases; variables that are not meaningful in a given phase may any value. Ebuilds must not attempt to modify any of these variables, unless otherwise specified. Because of their special meanings, these variables may not be preserved consistently across all -phases as would normally happen due to environment saving (see~\ref{sec:ebuild-env-state}). +phases as would normally happen due to environment saving (see section~\ref{sec:ebuild-env-state}). For example, \t{EBUILD_PHASE} is different for every phase, and \t{ROOT} may have changed between the various different \t{pkg_*} phases. Ebuilds must recalculate any variable they derive from an inconsistent variable. @@ -40,7 +40,7 @@ inconsistent variable. \endlastfoot \t{P} & All & -No\footnote{May change if a package has been updated (see~\ref{sec:updates-dir}).} & +No\footnote{May change if a package has been updated (see section~\ref{sec:updates-dir}).} & Package name and version, without the revision part. For example, \t{vim-7.0.174}. \\ \t{PF} & All & @@ -175,8 +175,8 @@ inconsistent variable. calling environment, \t{EPREFIX} defaults to the built-in offset-prefix that was set during installation of the package manager. When a different \t{EPREFIX} value than the built-in value is set in the calling environment, a cross-prefix build is performed where using the existing -utilities, a package is built for the given \t{EPREFIX}, akin to \t{ROOT}\@. -See also~\ref{sec:offset-vars}. Only for EAPIs listed in table~\ref{tab:offset-env-vars-table} +utilities, a package is built for the given \t{EPREFIX}, akin to \t{ROOT}\@. See also +section~\ref{sec:offset-vars}. Only for EAPIs listed in table~\ref{tab:offset-env-vars-table} as supporting \t{EPREFIX}. \\ \t{D} & \t{src_*} & diff --git a/ebuild-environment.tex b/ebuild-environment.tex index b9f3622..8093f1e 100644 --- a/ebuild-environment.tex +++ b/ebuild-environment.tex @@ -16,9 +16,9 @@ Variables that were exported must remain exported in later functions; variables visibility may retain default visibility or be exported. Variables with special meanings to the package manager are excluded from this rule. -Global variables must only contain invariant values (see~\ref{sec:metadata-invariance}). If a global -variable's value is invariant, it may have the value that would be generated at any given point -in the build sequence. +Global variables must only contain invariant values (see section~\ref{sec:metadata-invariance}). +If a global variable's value is invariant, it may have the value that would be generated at any +given point in the build sequence. This is demonstrated by code listing~\ref{lst:env-saving}.
[gentoo-commits] proj/pms:eapi-9 commit in: /
commit: 9dabbe3b66b56d41cc618a096e35310f483e961b Author: Ulrich Müller gentoo org> AuthorDate: Sat Jan 14 09:26:48 2023 + Commit: Ulrich Müller gentoo org> CommitDate: Wed Jan 18 21:12:28 2023 + URL:https://gitweb.gentoo.org/proj/pms.git/commit/?id=9dabbe3b names.tex: Specify eclass names Eclasses may export phase functions prefixed with their name, so ideally we would follow the syntax of Bash (and POSIX) identifiers: | A word consisting solely of underscores, digits, and alphabetics | from the portable character set. The first character of a name is | not a digit. Because many existing eclasses have a dot or a hyphen in their name, we follow usage in the Gentoo repository instead. (The only historical exception to the above was 64-bit.eclass, not used since 2006 and removed in 2009.) An eclass must not be named "default", otherwise names of exported functions would collide with default_. Signed-off-by: Ulrich Müller gentoo.org> eclasses.tex | 1 + names.tex| 5 + 2 files changed, 6 insertions(+) diff --git a/eclasses.tex b/eclasses.tex index 01692bc..0b9b5d4 100644 --- a/eclasses.tex +++ b/eclasses.tex @@ -10,6 +10,7 @@ hold. Eclasses must be located in the \t{eclass} directory in the top level of the repository---see section~\ref{sec:eclass-dir}. Each eclass is a single file named \t{.eclass}, where \t{} is the name of this eclass, used by \t{inherit} and \t{EXPORT_FUNCTIONS} among other places. +\t{} must be a valid eclass name, as per section~\ref{sec:eclass-names}. \section{The inherit Command} \label{sec:inherit} diff --git a/names.tex b/names.tex index 2994719..76fa72d 100644 --- a/names.tex +++ b/names.tex @@ -18,6 +18,11 @@ syntax described in section~\ref{sec:version-spec}. \note{A package name does not include the category. The term \i{qualified package name} is used where a \t{category/package} pair is meant.} +\subsection{Eclass names} +\label{sec:eclass-names} +An eclass name may contain any of the characters [\t{A-Za-z0-9_.-}]. It must begin with a letter or +an underscore. In addition, an eclass cannot be named \t{default}. + \subsection{Slot names} \label{sec:slot-names} A slot name may contain any of the characters [\t{A-Za-z0-9+_.-}]. It must not begin with a
[gentoo-commits] proj/pms:eapi-9 commit in: /
commit: 0178f252abe6c91ca639814cc4bd49c9fbe22727 Author: Ulrich Müller gentoo org> AuthorDate: Mon Feb 21 18:30:11 2022 + Commit: Ulrich Müller gentoo org> CommitDate: Sun Feb 26 17:40:18 2023 + URL:https://gitweb.gentoo.org/proj/pms.git/commit/?id=0178f252 EAPI 9 profile parent files can contain comments Bug: https://bugs.gentoo.org/470094 Signed-off-by: Ulrich Müller gentoo.org> eapi-differences.tex | 5 - profiles.tex | 20 +++- 2 files changed, 23 insertions(+), 2 deletions(-) diff --git a/eapi-differences.tex b/eapi-differences.tex index 2df5361..79b3931 100644 --- a/eapi-differences.tex +++ b/eapi-differences.tex @@ -32,6 +32,9 @@ have identical entries for all listed EAPIs.} Less strict filenames in \t{updates} & \compactfeatureref{updates-filenames} & No & No & Yes & Yes \\ +Comments in profiles \t{parent} file & \compactfeatureref{parent-comments} & +No & No & No & Yes \\ + Profile files as directories & \compactfeatureref{profile-file-dirs} & No & Yes & Yes & Yes \\ @@ -352,7 +355,7 @@ EAPI 8 is EAPI 7 with the following changes: EAPI 9 is EAPI 8 with the following changes: \begin{compactitem} -\item None +\item Comments in profiles \t{parent} file, \featureref{parent-comments}. \end{compactitem} \ChangeWhenAddingAnEAPI{9} diff --git a/profiles.tex b/profiles.tex index 8d8226a..6fa8a1c 100644 --- a/profiles.tex +++ b/profiles.tex @@ -25,7 +25,25 @@ first, left to right, with duplicate parent paths being sourced for every time t It is illegal for a profile's parent tree to contain cycles. Package manager behaviour upon encountering a cycle is undefined. -This file must not contain comments, blank lines or make use of line continuations. +This file must not make use of line continuations. + +\featurelabel{parent-comments} For EAPIs listed in table~\ref{tab:profile-parent-comments} as +allowing comments, blank lines and lines beginning with a \t{\#} are discarded. For other EAPIs, +this file must not contain comments or blank lines. + +\ChangeWhenAddingAnEAPI{9} +\begin{centertable}{EAPIs allowing comments in \t{parent} file} +\label{tab:profile-parent-comments} +\begin{tabular}{ll} + \toprule + \multicolumn{1}{c}{\textbf{EAPI}} & + \multicolumn{1}{c}{\textbf{Allows comments?}} \\ + \midrule + 0, 1, 2, 3, 4, 5, 6, 7, 8 & No \\ + 9 & Yes \\ + \bottomrule +\end{tabular} +\end{centertable} \subsection{The eapi file} \label{sec:profile-eapi}
[gentoo-commits] proj/pms:eapi-9 commit in: /
commit: 523f2f8a79516cae55607d16335babdc0b67e075 Author: Ulrich Müller gentoo org> AuthorDate: Sun Jan 29 10:49:27 2023 + Commit: Ulrich Müller gentoo org> CommitDate: Sun Jan 29 10:49:27 2023 + URL:https://gitweb.gentoo.org/proj/pms.git/commit/?id=523f2f8a names.tex: Reorder subsections Signed-off-by: Ulrich Müller gentoo.org> names.tex | 10 +- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/names.tex b/names.tex index 76fa72d..ed6d623 100644 --- a/names.tex +++ b/names.tex @@ -18,11 +18,6 @@ syntax described in section~\ref{sec:version-spec}. \note{A package name does not include the category. The term \i{qualified package name} is used where a \t{category/package} pair is meant.} -\subsection{Eclass names} -\label{sec:eclass-names} -An eclass name may contain any of the characters [\t{A-Za-z0-9_.-}]. It must begin with a letter or -an underscore. In addition, an eclass cannot be named \t{default}. - \subsection{Slot names} \label{sec:slot-names} A slot name may contain any of the characters [\t{A-Za-z0-9+_.-}]. It must not begin with a @@ -40,6 +35,11 @@ described in section~\ref{sec:use-iuse-handling}. A repository name may contain any of the characters [\t{A-Za-z0-9_-}]. It must not begin with a hyphen. In addition, every repository name must also be a valid package name. +\subsection{Eclass names} +\label{sec:eclass-names} +An eclass name may contain any of the characters [\t{A-Za-z0-9_.-}]. It must begin with a letter or +an underscore. In addition, an eclass cannot be named \t{default}. + \subsection{License names} \label{sec:license-names} A license name may contain any of the characters [\t{A-Za-z0-9+_.-}]. It must not begin with a
[gentoo-commits] proj/pms:eapi-9 commit in: /
commit: 1936b33467289e09f6130c3eba424cd2cdd962d0 Author: Ulrich Müller gentoo org> AuthorDate: Tue Dec 27 21:31:30 2022 + Commit: Ulrich Müller gentoo org> CommitDate: Tue Dec 27 21:31:30 2022 + URL:https://gitweb.gentoo.org/proj/pms.git/commit/?id=1936b334 Revert "Appendix: Include EAPI differences sections in table of contents." This reverts commit fbcb58732d0a75138c0c7185f914d10f448ed472. Signed-off-by: Ulrich Müller gentoo.org> eapi-differences.tex | 18 +- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/eapi-differences.tex b/eapi-differences.tex index a5ba486..225c2b6 100644 --- a/eapi-differences.tex +++ b/eapi-differences.tex @@ -375,11 +375,11 @@ File mtimes preserved & \compactfeatureref{mtime-preserve} & \note{This chapter is informative and for convenience only. Refer to the main text for specifics.} -\section{EAPI 0} +\section*{EAPI 0} EAPI 0 is the base EAPI. -\section{EAPI 1} +\section*{EAPI 1} EAPI 1 is EAPI 0 with the following changes: @@ -389,7 +389,7 @@ EAPI 1 is EAPI 0 with the following changes: \item Different \t{src_compile} implementation, \featureref{src-compile}. \end{compactitem} -\section{EAPI 2} +\section*{EAPI 2} EAPI 2 is EAPI 1 with the following changes: @@ -406,7 +406,7 @@ EAPI 2 is EAPI 1 with the following changes: \item \t{default} function, \featureref{default-func}. \end{compactitem} -\section{EAPI 3} +\section*{EAPI 3} EAPI 3 is EAPI 2 with the following changes: \begin{compactitem} @@ -416,7 +416,7 @@ EAPI 3 is EAPI 2 with the following changes: \item File modification times are preserved, \featureref{mtime-preserve}. \end{compactitem} -\section{EAPI 4} +\section*{EAPI 4} EAPI 4 is EAPI 3 with the following changes: @@ -445,7 +445,7 @@ EAPI 4 is EAPI 3 with the following changes: \item \t{use_with} and \t{use_enable} support empty third argument, \featureref{use-with}. \end{compactitem} -\section{EAPI 5} +\section*{EAPI 5} EAPI 5 is EAPI 4 with the following changes: @@ -466,7 +466,7 @@ EAPI 5 is EAPI 4 with the following changes: \item \t{usex} support, \featureref{usex}. \end{compactitem} -\section{EAPI 6} +\section*{EAPI 6} EAPI 6 is EAPI 5 with the following changes: @@ -489,7 +489,7 @@ EAPI 6 is EAPI 5 with the following changes: \item \t{get_libdir} support, \featureref{get-libdir}. \end{compactitem} -\section{EAPI 7} +\section*{EAPI 7} EAPI 7 is EAPI 6 with the following changes: @@ -525,7 +525,7 @@ EAPI 7 is EAPI 6 with the following changes: \item Version manipulation and comparison commands, \featureref{ver-commands}. \end{compactitem} -\section{EAPI 8} +\section*{EAPI 8} EAPI 8 is EAPI 7 with the following changes:
[gentoo-commits] proj/pms:eapi-9 commit in: /
commit: dc358cbe6c57dca54b82d2c9bc8de2e1cddd975c Author: Ulrich Müller gentoo org> AuthorDate: Fri Dec 9 19:07:07 2022 + Commit: Ulrich Müller gentoo org> CommitDate: Fri Dec 9 19:07:07 2022 + URL:https://gitweb.gentoo.org/proj/pms.git/commit/?id=dc358cbe Don't use teletype for EAPIs Signed-off-by: Ulrich Müller gentoo.org> appendices.tex | 12 ++-- dependencies.tex | 2 +- 2 files changed, 7 insertions(+), 7 deletions(-) diff --git a/appendices.tex b/appendices.tex index d87d1be..ed90225 100644 --- a/appendices.tex +++ b/appendices.tex @@ -67,16 +67,16 @@ In some exceptional cases, changes to the specification have been approved by th without introducing a new EAPI\@. This section lists such retroactive changes. \subsection{Bash version} -EAPIs \t{0}, \t{1} and \t{2} originally specified GNU Bash version 3.0. This was retroactively -updated to version 3.2 (see table~\ref{tab:bash-version}) in November 2009. +EAPIs 0, 1 and~2 originally specified GNU Bash version 3.0. This was retroactively updated to +version 3.2 (see table~\ref{tab:bash-version}) in November 2009. \subsection{Old-style virtuals} Historically, virtuals were special packages rather than regular ebuilds. An ebuild could specify in the \t{PROVIDE} metadata that it supplied certain virtuals, and the package manager had to bear this in mind when handling dependencies. -Old-style virtuals were supported by EAPIs \t{0}, \t{1}, \t{2}, \t{3} and \t{4}. They were phased -out via GLEP~37~\cite{Glep37} and finally removed in 2011. +Old-style virtuals were supported by EAPIs 0, 1, 2, 3 and~4. They were phased out via +GLEP~37~\cite{Glep37} and finally removed in 2011. \note{A `new-style virtual' is a normal package that installs no files and uses its dependency requirements to pull in a `provider'. This does not require any special handling from the package @@ -105,8 +105,8 @@ induce string prefix comparison instead of the normal version comparison logic. surprising results, e.\,g.\ \t{=dev-lang/perl-5.2*} matching \t{dev-lang/perl-5.22.0}. Moreover, implementation in package managers deviated from what was specified. -String prefix matching was effective in EAPIs \t{0}, \t{1}, \t{2}, \t{3}, \t{4} and \t{5}. It was -retroactively dropped in favour of the current behaviour in October 2015. +String prefix matching was effective in EAPIs 0, 1, 2, 3, 4 and~5. It was retroactively dropped +in favour of the current behaviour in October 2015. \subsection{Empty dependency groups} The dependency specification format (see section~\ref{sec:dependency-spec}) originally permitted diff --git a/dependencies.tex b/dependencies.tex index f14a08c..0ff1c7e 100644 --- a/dependencies.tex +++ b/dependencies.tex @@ -331,7 +331,7 @@ described in table~\ref{tab:bang-strength-table}. \featurelabel{slot-deps} A named slot dependency consists of a colon followed by a slot name. A specification with a named slot dependency matches only if the slot of the matched package is equal to the slot specified. If the slot of the package to match cannot be determined (e.\,g.\ because it -is not a supported \t{EAPI}), the match is treated as unsuccessful. +is not a supported EAPI, the match is treated as unsuccessful. \featurelabel{sub-slot} In EAPIs shown in table~\ref{tab:slot-deps-table} as supporting sub-slots, a slot dependency may contain an optional sub-slot part that follows the regular slot and is
[gentoo-commits] proj/pms:eapi-9 commit in: /
commit: b3718b21370c2991ff6b2ed76ac7a53af8477d57 Author: Ulrich Müller gentoo org> AuthorDate: Tue Dec 27 21:27:57 2022 + Commit: Ulrich Müller gentoo org> CommitDate: Tue Dec 27 21:27:57 2022 + URL:https://gitweb.gentoo.org/proj/pms.git/commit/?id=b3718b21 Use "app:" instead of "ch:" for labels in the appendix Signed-off-by: Ulrich Müller gentoo.org> appendices.tex | 2 +- desk-reference.tex | 4 ++-- tree-layout.tex| 4 ++-- 3 files changed, 5 insertions(+), 5 deletions(-) diff --git a/appendices.tex b/appendices.tex index a093936..db1dc64 100644 --- a/appendices.tex +++ b/appendices.tex @@ -1,5 +1,5 @@ \chapter{metadata.xml} -\label{ch:metadata-xml} +\label{app:metadata-xml} The \t{metadata.xml} file is used to contain extra package- or category-level information beyond what is stored in ebuild metadata. Its exact format is strictly beyond the scope of this document, diff --git a/desk-reference.tex b/desk-reference.tex index a096032..0bcda38 100644 --- a/desk-reference.tex +++ b/desk-reference.tex @@ -1,12 +1,12 @@ \ifthenelse{\boolean{TEX4HT-HACKS}}{% \chapter{Desk Reference} -\label{ch:cheatsheet} +\label{app:cheatsheet} \href{eapi-cheatsheet.pdf}{EAPI Cheat Sheet} }{% % Make sure that the cheat sheet starts on an odd page \ifthenelse{\isodd{\thepage}}{}{\null\newpage}% \includepdf[pages=-,landscape,turn=false,lastpage=2,% -addtotoc={1,chapter,0,Desk Reference,ch:cheatsheet}]{eapi-cheatsheet} +addtotoc={1,chapter,0,Desk Reference,app:cheatsheet}]{eapi-cheatsheet} } % vim: set filetype=tex fileencoding=utf8 et tw=100 spell spelllang=en : diff --git a/tree-layout.tex b/tree-layout.tex index aa04d3d..da01ff8 100644 --- a/tree-layout.tex +++ b/tree-layout.tex @@ -29,7 +29,7 @@ Each category provided by the repository (see also: the \t{profiles/categories} section~\ref{sec:profiles-dir}) shall be contained in one directory, whose name shall be that of the category. Each category directory shall contain: \begin{compactitem} -\item A \t{metadata.xml} file, as described in appendix~\ref{ch:metadata-xml}\@. Optional. +\item A \t{metadata.xml} file, as described in appendix~\ref{app:metadata-xml}\@. Optional. \item Zero or more package directories, one for each package in the category, as described in section~\ref{sec:package-dirs}. The name of the package directory shall be the corresponding package name. @@ -51,7 +51,7 @@ A package directory contains the following: \nobreakpar \begin{compactitem} \item Zero or more ebuilds. These are as described in chapter~\ref{ch:ebuild-format} and others. -\item A \t{metadata.xml} file, as described in appendix~\ref{ch:metadata-xml}\@. Optional only for +\item A \t{metadata.xml} file, as described in appendix~\ref{app:metadata-xml}\@. Optional only for legacy support. \item A \t{ChangeLog}, in a format determined by the provider of the repository. Optional. \item A \t{Manifest} file, whose format is described in~\cite{Glep74}. Can be omitted if the file
[gentoo-commits] proj/pms:eapi-9 commit in: /
commit: a2bf8fdc638f79a5c8438b095cd043b18b9f7794 Author: Ulrich Müller gentoo org> AuthorDate: Fri Nov 25 17:58:05 2022 + Commit: Ulrich Müller gentoo org> CommitDate: Fri Nov 25 17:58:05 2022 + URL:https://gitweb.gentoo.org/proj/pms.git/commit/?id=a2bf8fdc glossary.tex: Drop chapter number Signed-off-by: Ulrich Müller gentoo.org> glossary.tex | 6 +++--- introduction.tex | 2 +- pms.tex | 3 ++- 3 files changed, 6 insertions(+), 5 deletions(-) diff --git a/glossary.tex b/glossary.tex index 181febc..4ed3e82 100644 --- a/glossary.tex +++ b/glossary.tex @@ -1,7 +1,7 @@ -\chapter{Glossary} -\label{ch:glossary} +\chapter*{Glossary} +\addcontentsline{toc}{chapter}{Glossary} -This chapter contains explanations of some of the terms used in this document whose meaning may not +This glossary contains explanations of some of the terms used in this document whose meaning may not be immediately obvious. \begin{description} diff --git a/introduction.tex b/introduction.tex index b72acc3..57fb51a 100644 --- a/introduction.tex +++ b/introduction.tex @@ -7,7 +7,7 @@ well as certain aspects of package manager behaviour required to support such a This document is \emph{not} designed to be an introduction to ebuild development. Prior knowledge of ebuild creation and an understanding of how the package management system works is assumed; certain -less familiar terms are explained in the Glossary in chapter~\ref{ch:glossary}. +less familiar terms are explained in the Glossary. This document does not specify any user or package manager configuration information. diff --git a/pms.tex b/pms.tex index 97d6d30..07113a9 100644 --- a/pms.tex +++ b/pms.tex @@ -60,8 +60,9 @@ \include{commands} \include{merge} \include{metadata-cache} -\include{glossary} +% back matter begins here +\include{glossary} \bibliography{pms} \appendix
[gentoo-commits] proj/pms:eapi-9 commit in: /
commit: 603b5c5a6b9e94a8a9fc02982dca14fe46048594 Author: Ulrich Müller gentoo org> AuthorDate: Sat Nov 19 21:35:46 2022 + Commit: Ulrich Müller gentoo org> CommitDate: Sat Nov 19 21:35:46 2022 + URL:https://gitweb.gentoo.org/proj/pms.git/commit/?id=603b5c5a Appendix: Document retroactive change of econf --disable-static Signed-off-by: Ulrich Müller gentoo.org> appendices.tex | 8 pkg-mgr-commands.tex | 1 + 2 files changed, 9 insertions(+) diff --git a/appendices.tex b/appendices.tex index 3d2ef52..69bd2ed 100644 --- a/appendices.tex +++ b/appendices.tex @@ -114,6 +114,14 @@ all-of, any-of, exactly-one-of, at-most-one-of and use-conditional groups with z However, such empty groups were neither supported by all package managers nor used in ebuilds. They were dropped from the specification in October 2017. +\subsection{econf -{}-disable-static option} +The \t{-{}-disable-static} option in \t{econf} (see section~\ref{sec:build-commands}) was intended +to disable only static Libtool archive building. The original check for either +\t{-{}-disable-static} or \t{-{}-enable-static} occuring in \t{configure -{}-help} output produced +false positives. The specification was therefore updated in November 2022; it now requires both +\t{-{}-enable-static} and \t{-{}-enable-shared}, and in addition checks for a proper end of the +option string. + % vim: set filetype=tex fileencoding=utf8 et tw=100 spell spelllang=en : %%% Local Variables: diff --git a/pkg-mgr-commands.tex b/pkg-mgr-commands.tex index a3e8a41..95caa0b 100644 --- a/pkg-mgr-commands.tex +++ b/pkg-mgr-commands.tex @@ -296,6 +296,7 @@ Ebuilds must not run any of these commands once the current phase function has r \end{centertable} \subsection{Build commands} +\label{sec:build-commands} These commands are used during the \t{src_configure}, \t{src_compile}, \t{src_test}, and \t{src_install} phases to run the package's build commands. Ebuilds must not run any of these commands once the current phase function has returned.
[gentoo-commits] proj/pms:eapi-9 commit in: /
commit: b8b81bfd9e69f3d3dcd21b00580849a7abd9d8dd Author: Ulrich Müller gentoo org> AuthorDate: Fri Nov 25 20:51:11 2022 + Commit: Ulrich Müller gentoo org> CommitDate: Fri Nov 25 20:51:11 2022 + URL:https://gitweb.gentoo.org/proj/pms.git/commit/?id=b8b81bfd pms.bib: Update GLEP references to latest Post-History date Signed-off-by: Ulrich Müller gentoo.org> pms.bib | 8 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/pms.bib b/pms.bib index 8b718af..014b643 100644 --- a/pms.bib +++ b/pms.bib @@ -25,15 +25,15 @@ @manual{Glep68, author = {Michał Górny}, title = {{GLEP} 68: Package and category metadata}, -year = 2018, -month = Feb, +year = 2022, +month = Oct, url = {https://www.gentoo.org/glep/glep-0068.html} } @manual{Glep74, author = {Michał Górny and Robin Hugh Johnson and Ulrich Müller}, title = {{GLEP} 74: Full-tree verification using Manifest files}, -year = 2018, -month = Feb, +year = 2022, +month = Oct, url = {https://www.gentoo.org/glep/glep-0074.html} }
[gentoo-commits] proj/pms:eapi-9 commit in: /
commit: 18080d9d9c3322554634da881cd8e5c2da71d2f4 Author: Ulrich Müller gentoo org> AuthorDate: Mon Feb 21 18:32:43 2022 + Commit: Ulrich Müller gentoo org> CommitDate: Wed Dec 14 10:09:24 2022 + URL:https://gitweb.gentoo.org/proj/pms.git/commit/?id=18080d9d EAPI 9 profile EAPI defaults to top-level Bug: https://bugs.gentoo.org/806181 Signed-off-by: Ulrich Müller gentoo.org> eapi-differences.tex | 4 profiles.tex | 23 +-- 2 files changed, 25 insertions(+), 2 deletions(-) diff --git a/eapi-differences.tex b/eapi-differences.tex index 682b336..9f5cd62 100644 --- a/eapi-differences.tex +++ b/eapi-differences.tex @@ -35,6 +35,9 @@ Less strict filenames in \t{updates} & \compactfeatureref{updates-filenames} & Comments in profiles \t{parent} file & \compactfeatureref{parent-comments} & No & No & No & Yes \\ +Default EAPI for profiles & \compactfeatureref{profile-eapi-default} & +0 & 0 & 0 & Top-level \\ + Profile files as directories & \compactfeatureref{profile-file-dirs} & No & Yes & Yes & Yes \\ @@ -356,6 +359,7 @@ EAPI 9 is EAPI 8 with the following changes: \begin{compactitem} \item Comments in profiles \t{parent} file, \featureref{parent-comments}. +\item Different default EAPI for profiles, \featureref{profile-eapi-default}. \end{compactitem} \ChangeWhenAddingAnEAPI{9} diff --git a/profiles.tex b/profiles.tex index 6fa8a1c..de59f0a 100644 --- a/profiles.tex +++ b/profiles.tex @@ -50,8 +50,27 @@ this file must not contain comments or blank lines. A profile directory may contain an \t{eapi} file. This file, if it exists, must contain a single line with the name of an EAPI\@. This specifies the EAPI to use when handling the directory in question; a package manager must not attempt to use any profile using a directory which requires an -EAPI it does not support. If no \t{eapi} file is present, EAPI 0 shall be used. The EAPI is neither -inherited via the \t{parent} file nor in subdirectories. +EAPI it does not support. + +\featurelabel{profile-eapi-default} If no \t{eapi} file is present, the default depends on the EAPI +of the top-level profiles directory (see section~\ref{sec:profiles-dir}). That EAPI shall be used +if table~\ref{tab:profile-eapi-default} lists it as ``top-level''. Otherwise, EAPI 0 shall be used. + +The EAPI is neither inherited via the \t{parent} file nor in subdirectories. + +\ChangeWhenAddingAnEAPI{9} +\begin{centertable}{Default EAPI for profiles} +\label{tab:profile-eapi-default} +\begin{tabular}{ll} + \toprule + \multicolumn{1}{c}{\textbf{EAPI}} & + \multicolumn{1}{c}{\textbf{Default EAPI?}} \\ + \midrule + 0, 1, 2, 3, 4, 5, 6, 7, 8 & 0 \\ + 9 & Top-level \\ + \bottomrule +\end{tabular} +\end{centertable} \subsection{deprecated} If a profile contains a file named \t{deprecated}, it is treated as such. The first line of this
[gentoo-commits] proj/pms:eapi-9 commit in: /
commit: db3f61cc7d1cb81f8530e56a42dd7e68e714b715 Author: Ulrich Müller gentoo org> AuthorDate: Mon Feb 21 18:57:30 2022 + Commit: Ulrich Müller gentoo org> CommitDate: Wed Dec 14 10:09:24 2022 + URL:https://gitweb.gentoo.org/proj/pms.git/commit/?id=db3f61cc EAPI 9: econf matches configure --help output better Bug: https://bugs.gentoo.org/815169 Signed-off-by: Ulrich Müller gentoo.org> eapi-differences.tex | 4 pkg-mgr-commands.tex | 18 ++ 2 files changed, 22 insertions(+) diff --git a/eapi-differences.tex b/eapi-differences.tex index 9f5cd62..ead78a3 100644 --- a/eapi-differences.tex +++ b/eapi-differences.tex @@ -141,6 +141,9 @@ Output commands use stdout & \compactfeatureref{output-no-stdout} & \t{econf -{}-disable-static} & \compactfeatureref{econf-options} & No & No & Yes & Yes \\ +\t{econf} better matching of options & \compactfeatureref{econf-options} & +No & No & No & Yes \\ + \t{domo} destination path & \compactfeatureref{domo-path} & \t{\$\{DESTTREE\}} & \t{/usr} & \t{/usr} & \t{/usr} \\ @@ -360,6 +363,7 @@ EAPI 9 is EAPI 8 with the following changes: \begin{compactitem} \item Comments in profiles \t{parent} file, \featureref{parent-comments}. \item Different default EAPI for profiles, \featureref{profile-eapi-default}. +\item \t{econf} matches \t{configure -{}-help} output better, \featureref{econf-options}. \end{compactitem} \ChangeWhenAddingAnEAPI{9} diff --git a/pkg-mgr-commands.tex b/pkg-mgr-commands.tex index 7d2511f..e532026 100644 --- a/pkg-mgr-commands.tex +++ b/pkg-mgr-commands.tex @@ -345,6 +345,10 @@ commands once the current phase function has returned. \t{-{}-enable-static} occurs in the output of \t{configure -{}-help}. \end{itemize} +For EAPIs listed in table~\ref{tab:econf-match-end} as matching the end of the option string, +a string in \t{configure -{}-help} output will only match if is is not immediately followed by +any of the characters \t{[A-Za-z0-9+_.-]}. + \ChangeWhenAddingAnEAPI{9} % two places \begin{centertable}{Extra \t{econf} arguments for EAPIs} \label{tab:econf-options-table} @@ -374,6 +378,20 @@ commands once the current phase function has returned. \end{tabular} \end{centertable} +\ChangeWhenAddingAnEAPI{9} +\begin{centertable}{EAPIs matching end of option string in \t{configure -{}-help} output} +\label{tab:econf-match-end} +\begin{tabular}{ll} + \toprule + \multicolumn{1}{c}{\textbf{EAPI}} & + \multicolumn{1}{c}{\textbf{Matches end of option string?}} \\ + \midrule + 0, 1, 2, 3, 4, 5, 6, 7, 8 & No \\ + 9 & Yes \\ + \bottomrule +\end{tabular} +\end{centertable} + Note that the \t{\$\{EPREFIX\}} component represents the same offset-prefix as described in table~\ref{tab:defined-vars}. It facilitates offset-prefix installations which is supported by EAPIs listed in table~\ref{tab:offset-env-vars-table}. When no offset-prefix installation is in
[gentoo-commits] proj/pms:eapi-9 commit in: /
commit: 153732bdc4d6aaa8076932e2ad583dbfafc1726b Author: Ulrich Müller gentoo org> AuthorDate: Mon Feb 21 18:32:43 2022 + Commit: Ulrich Müller gentoo org> CommitDate: Mon Aug 22 18:29:58 2022 + URL:https://gitweb.gentoo.org/proj/pms.git/commit/?id=153732bd EAPI 9 profile EAPI defaults to top-level Bug: https://bugs.gentoo.org/806181 Signed-off-by: Ulrich Müller gentoo.org> eapi-differences.tex | 5 + profiles.tex | 23 +-- 2 files changed, 26 insertions(+), 2 deletions(-) diff --git a/eapi-differences.tex b/eapi-differences.tex index 682b336..9e7f269 100644 --- a/eapi-differences.tex +++ b/eapi-differences.tex @@ -35,6 +35,9 @@ Less strict filenames in \t{updates} & \compactfeatureref{updates-filenames} & Comments in profiles \t{parent} file & \compactfeatureref{parent-comments} & No & No & No & Yes \\ +Default EAPI for profiles & \compactfeatureref{profile-eapi-default} & +0 & 0 & 0 & Top-level \\ + Profile files as directories & \compactfeatureref{profile-file-dirs} & No & Yes & Yes & Yes \\ @@ -356,6 +359,8 @@ EAPI 9 is EAPI 8 with the following changes: \begin{compactitem} \item Comments in profiles \t{parent} file, \featureref{parent-comments}. +\item Different default EAPI for profiles, \featureref{profile-eapi-default}. + \end{compactitem} \ChangeWhenAddingAnEAPI{9} diff --git a/profiles.tex b/profiles.tex index 6fa8a1c..de59f0a 100644 --- a/profiles.tex +++ b/profiles.tex @@ -50,8 +50,27 @@ this file must not contain comments or blank lines. A profile directory may contain an \t{eapi} file. This file, if it exists, must contain a single line with the name of an EAPI\@. This specifies the EAPI to use when handling the directory in question; a package manager must not attempt to use any profile using a directory which requires an -EAPI it does not support. If no \t{eapi} file is present, EAPI 0 shall be used. The EAPI is neither -inherited via the \t{parent} file nor in subdirectories. +EAPI it does not support. + +\featurelabel{profile-eapi-default} If no \t{eapi} file is present, the default depends on the EAPI +of the top-level profiles directory (see section~\ref{sec:profiles-dir}). That EAPI shall be used +if table~\ref{tab:profile-eapi-default} lists it as ``top-level''. Otherwise, EAPI 0 shall be used. + +The EAPI is neither inherited via the \t{parent} file nor in subdirectories. + +\ChangeWhenAddingAnEAPI{9} +\begin{centertable}{Default EAPI for profiles} +\label{tab:profile-eapi-default} +\begin{tabular}{ll} + \toprule + \multicolumn{1}{c}{\textbf{EAPI}} & + \multicolumn{1}{c}{\textbf{Default EAPI?}} \\ + \midrule + 0, 1, 2, 3, 4, 5, 6, 7, 8 & 0 \\ + 9 & Top-level \\ + \bottomrule +\end{tabular} +\end{centertable} \subsection{deprecated} If a profile contains a file named \t{deprecated}, it is treated as such. The first line of this
[gentoo-commits] proj/pms:eapi-9 commit in: /
commit: 78f161bf267da8b25d58b927cc334212f3c0a054 Author: Ulrich Müller gentoo org> AuthorDate: Mon Feb 21 18:30:11 2022 + Commit: Ulrich Müller gentoo org> CommitDate: Mon Aug 22 18:29:57 2022 + URL:https://gitweb.gentoo.org/proj/pms.git/commit/?id=78f161bf EAPI 9 profile parent files can contain comments Bug: https://bugs.gentoo.org/470094 Signed-off-by: Ulrich Müller gentoo.org> eapi-differences.tex | 5 - profiles.tex | 20 +++- 2 files changed, 23 insertions(+), 2 deletions(-) diff --git a/eapi-differences.tex b/eapi-differences.tex index e48ea54..682b336 100644 --- a/eapi-differences.tex +++ b/eapi-differences.tex @@ -32,6 +32,9 @@ have identical entries for all listed EAPIs.} Less strict filenames in \t{updates} & \compactfeatureref{updates-filenames} & No & No & Yes & Yes \\ +Comments in profiles \t{parent} file & \compactfeatureref{parent-comments} & +No & No & No & Yes \\ + Profile files as directories & \compactfeatureref{profile-file-dirs} & No & Yes & Yes & Yes \\ @@ -352,7 +355,7 @@ EAPI 8 is EAPI 7 with the following changes: EAPI 9 is EAPI 8 with the following changes: \begin{compactitem} -\item None +\item Comments in profiles \t{parent} file, \featureref{parent-comments}. \end{compactitem} \ChangeWhenAddingAnEAPI{9} diff --git a/profiles.tex b/profiles.tex index 8d8226a..6fa8a1c 100644 --- a/profiles.tex +++ b/profiles.tex @@ -25,7 +25,25 @@ first, left to right, with duplicate parent paths being sourced for every time t It is illegal for a profile's parent tree to contain cycles. Package manager behaviour upon encountering a cycle is undefined. -This file must not contain comments, blank lines or make use of line continuations. +This file must not make use of line continuations. + +\featurelabel{parent-comments} For EAPIs listed in table~\ref{tab:profile-parent-comments} as +allowing comments, blank lines and lines beginning with a \t{\#} are discarded. For other EAPIs, +this file must not contain comments or blank lines. + +\ChangeWhenAddingAnEAPI{9} +\begin{centertable}{EAPIs allowing comments in \t{parent} file} +\label{tab:profile-parent-comments} +\begin{tabular}{ll} + \toprule + \multicolumn{1}{c}{\textbf{EAPI}} & + \multicolumn{1}{c}{\textbf{Allows comments?}} \\ + \midrule + 0, 1, 2, 3, 4, 5, 6, 7, 8 & No \\ + 9 & Yes \\ + \bottomrule +\end{tabular} +\end{centertable} \subsection{The eapi file} \label{sec:profile-eapi}
[gentoo-commits] proj/pms:eapi-9 commit in: /
commit: 591f04599193765ae803fa0d681a7d7013e703bf Author: Ulrich Müller gentoo org> AuthorDate: Fri Aug 19 21:22:40 2022 + Commit: Ulrich Müller gentoo org> CommitDate: Mon Aug 22 18:29:56 2022 + URL:https://gitweb.gentoo.org/proj/pms.git/commit/?id=591f0459 EAPI feature table: Don't use a landscape table Drop EAPIs 0 to 5 from the table, as well as items that would have identical entries for all listed EAPIs. Signed-off-by: Ulrich Müller gentoo.org> eapi-differences.tex | 321 ++- pms.cls | 2 +- 2 files changed, 61 insertions(+), 262 deletions(-) diff --git a/eapi-differences.tex b/eapi-differences.tex index a5ba486..c727758 100644 --- a/eapi-differences.tex +++ b/eapi-differences.tex @@ -1,39 +1,24 @@ \chapter{Feature Availability by EAPI} \note{This chapter is informative and for convenience only. Refer to the main text for specifics. -For lack of space, EAPIs 0, 1, 2, 3, and~4 have been consolidated into a single column in the table -below; entries marked with an asterisk differ between these EAPIs. See the 2012-09-20 edition -of this document for a complete table of previous EAPIs.} -% 2012-09-20 (EAPI 5) edition has a table of EAPIs 0 to 5 +For lack of space, EAPIs 0 to~5 have been omitted from the table below, as well as items that would +have identical entries for all listed EAPIs.} \ChangeWhenAddingAnEAPI{8} -\begin{landscape} -\begin{longtable}{llP{7.5em}P{7.5em}P{7.5em}P{7.5em}P{7.5em}} +\begin{longtable}{@{}l@{}} \caption{Features in EAPIs}\\ \toprule \multicolumn{1}{c}{\textbf{Feature}} & -\multicolumn{1}{c}{\textbf{Reference}} & -\multicolumn{5}{c}{\textbf{EAPIs}} \\ -\multicolumn{1}{c}{} & -\multicolumn{1}{c}{} & -\multicolumn{1}{c}{0, 1, 2, 3, 4} & -\multicolumn{1}{c}{5} & -\multicolumn{1}{c}{6} & -\multicolumn{1}{c}{7} & -\multicolumn{1}{c}{8} \\ +\multicolumn{1}{c}{\textbf{Ref.}} & +\multicolumn{3}{c}{\textbf{EAPIs}} \\ +& & 6 & 7 & 8 \\ \midrule \endfirsthead \midrule \multicolumn{1}{c}{\textbf{Feature}} & -\multicolumn{1}{c}{\textbf{Reference}} & -\multicolumn{5}{c}{\textbf{EAPIs}} \\ -\multicolumn{1}{c}{} & -\multicolumn{1}{c}{} & -\multicolumn{1}{c}{0, 1, 2, 3, 4} & -\multicolumn{1}{c}{5} & -\multicolumn{1}{c}{6} & -\multicolumn{1}{c}{7} & -\multicolumn{1}{c}{8} \\ +\multicolumn{1}{c}{\textbf{Ref.}} & +\multicolumn{3}{c}{\textbf{EAPIs}} \\ +& & 6 & 7 & 8 \\ \midrule \endhead \midrule @@ -42,334 +27,148 @@ of this document for a complete table of previous EAPIs.} \endlastfoot \t{package.mask} directory & \compactfeatureref{package-mask-dir} & -No & No & No & Yes & Yes \\ +No & Yes & Yes \\ Less strict filenames in \t{updates} & \compactfeatureref{updates-filenames} & -No & No & No & No & Yes \\ +No & No & Yes \\ Profile files as directories & \compactfeatureref{profile-file-dirs} & -No & No & No & Yes & Yes \\ +No & Yes & Yes \\ \t{package.provided} & \compactfeatureref{package-provided} & -Optional & Optional & Optional & No & No \\ - -Stable use masking/forcing & \compactfeatureref{stablemask} & -No & Yes & Yes & Yes & Yes \\ +Optional & No & No \\ Bash version & \compactfeatureref{bash-version} & -3.2 & 3.2 & 4.2 & 4.2 & 5.0 \\ - -\t{failglob} in global scope & \compactfeatureref{failglob} & -No & No & Yes & Yes & Yes \\ - -\t{IUSE} defaults & \compactfeatureref{iuse-defaults} & -* & Yes & Yes & Yes & Yes \\ - -\t{REQUIRED_USE} & \compactfeatureref{required-use} & -* & Yes & Yes & Yes & Yes \\ - -\t{PROPERTIES} & \compactfeatureref{properties} & -* & Yes & Yes & Yes & Yes \\ - -\t{SRC_URI} arrows & \compactfeatureref{src-uri-arrows} & -* & Yes & Yes & Yes & Yes \\ +4.2 & 4.2 & 5.0 \\ Selective URI restrictions & \compactfeatureref{uri-restrict} & -No & No & No & No & Yes \\ - -\t{RDEPEND=DEPEND} & \compactfeatureref{rdepend-depend} & -* & No & No & No & No \\ - -\t{DEFINED_PHASES} & \compactfeatureref{defined-phases} & -* & Yes & Yes & Yes & Yes \\ +No & No & Yes \\ \t{BDEPEND} & \compactfeatureref{bdepend} & -No & No & No & Yes & Yes \\ +No & Yes & Yes \\ \t{IDEPEND} & \compactfeatureref{idepend} & -No & No & No & No & Yes \\ - -\t{??\ ( )} groups & \compactfeatureref{at-most-one-of} & -No & Yes & Yes & Yes & Yes \\ +No & No & Yes \\ Empty \t{||}, \t{\textasciicircum\textasciicircum} groups match & \compactfeatureref{empty-dep-groups} & -Yes & Yes & Yes & No & No \\ - -Slot dependencies & \compactfeatureref{slot-deps} & -* & Named and Operator & Named and Operator & Named and Operator & Named and Operator \\ - -Sub-slots & \compactfeatureref{sub-slot} & -No & Yes & Yes & Yes & Yes \\ - -Use dependencies & \compactfeatureref{use-deps} & -* & 4-style & 4-style & 4-style & 4-style \\ - -\t{!}\ blockers & \compactfeatureref{bang-strength} & -* & Weak & Weak & Weak & Weak \\ - -\t{!!}\ blockers &
[gentoo-commits] proj/pms:eapi-9 commit in: /
commit: 361341d3cfe1437f55f5c58a836899207393c6e2 Author: Ulrich Müller gentoo org> AuthorDate: Tue Aug 3 16:32:47 2021 + Commit: Ulrich Müller gentoo org> CommitDate: Mon Aug 22 18:29:57 2022 + URL:https://gitweb.gentoo.org/proj/pms.git/commit/?id=361341d3 Add an EAPI 9 identical to EAPI 8 Signed-off-by: Ulrich Müller gentoo.org> commands.tex | 4 +- dependencies.tex | 26 +-- eapi-differences.tex | 116 +++--- eapis.tex | 4 +- ebuild-env-vars.tex | 26 +-- ebuild-format.tex | 4 +- ebuild-functions.tex | 46 ++-- ebuild-vars.tex | 22 +- eclasses.tex | 4 +- merge.tex | 6 +-- pkg-mgr-commands.tex | 100 +-- pms.tex | 4 +- profile-variables.tex | 8 ++-- profiles.tex | 12 +++--- tree-layout.tex | 8 ++-- 15 files changed, 199 insertions(+), 191 deletions(-) diff --git a/commands.tex b/commands.tex index d0ad87d..c6f4f36 100644 --- a/commands.tex +++ b/commands.tex @@ -33,7 +33,7 @@ The following commands must always be available in the ebuild environment: table~\ref{tab:system-commands-table} as requiring GNU find. \end{compactitem} -\ChangeWhenAddingAnEAPI{8} +\ChangeWhenAddingAnEAPI{9} \begin{centertable}{System commands for EAPIs} \label{tab:system-commands-table} \begin{tabular}{lll} @@ -44,7 +44,7 @@ The following commands must always be available in the ebuild environment: \midrule 0, 1, 2, 3, 4 & Undefined & Any \\ 5, 6 & Yes & Any \\ - 7, 8 & Yes & 2.7 \\ + 7, 8, 9 & Yes & 2.7 \\ \bottomrule \end{tabular} \end{centertable} diff --git a/dependencies.tex b/dependencies.tex index f14a08c..de6e752 100644 --- a/dependencies.tex +++ b/dependencies.tex @@ -88,7 +88,7 @@ with the native build system (\t{CBUILD}). Ebuilds are allowed to call them in \ \t{pkg_postinst}. Ebuilds may also call them in \t{pkg_prerm} and \t{pkg_postrm} but must not rely on them being available. -\ChangeWhenAddingAnEAPI{8} +\ChangeWhenAddingAnEAPI{9} \begin{centertable}{EAPIs supporting additional dependency types} \label{tab:depend-table} \begin{tabular}{lll} @@ -99,7 +99,7 @@ on them being available. \midrule 0, 1, 2, 3, 4, 5, 6 & No & No \\ 7 & Yes & No \\ - 8 & Yes & Yes \\ + 8, 9& Yes & Yes \\ \bottomrule \end{tabular} \end{centertable} @@ -155,7 +155,7 @@ be surrounded on both sides by whitespace, except at the start and end of the st In particular, note that whitespace is not optional. -\ChangeWhenAddingAnEAPI{8} +\ChangeWhenAddingAnEAPI{9} \begin{centertable}{EAPIs supporting \t{REQUIRED_USE ??}\ groups} \label{tab:at-most-one-of-table} \begin{tabular}{ll} @@ -164,7 +164,7 @@ In particular, note that whitespace is not optional. \multicolumn{1}{c}{\textbf{Supports \t{REQUIRED_USE ??}\ groups?}} \\ \midrule 0, 1, 2, 3, 4 & No \\ - 5, 6, 7, 8& Yes \\ + 5, 6, 7, 8, 9 & Yes \\ \bottomrule \end{tabular} \end{centertable} @@ -204,7 +204,7 @@ In an exactly-one-of group, exactly one immediate child element must be matched. In EAPIs specified in table~\ref{tab:empty-dep-groups}, an empty exactly-one-of group counts as being matched. -\ChangeWhenAddingAnEAPI{8} +\ChangeWhenAddingAnEAPI{9} \begin{centertable}{Matching of empty dependency groups in EAPIs} \label{tab:empty-dep-groups} \begin{tabular}{ll} @@ -214,7 +214,7 @@ being matched. are matched?}} \\ \midrule 0, 1, 2, 3, 4, 5, 6 & Yes \\ - 7, 8& No \\ + 7, 8, 9 & No \\ \bottomrule \end{tabular} \end{centertable} @@ -250,7 +250,7 @@ manager must warn or error if this feature is used with an EAPI not supporting u \note{Order is important. The slot restriction must come before use dependencies.} -\ChangeWhenAddingAnEAPI{8} +\ChangeWhenAddingAnEAPI{9} \begin{centertable}{Support for \t{SLOT} dependencies and sub-slots in EAPIs} \label{tab:slot-deps-table} \begin{tabular}{lll} @@ -261,12 +261,12 @@ manager must warn or error if this feature is used with an EAPI not supporting u \midrule 0 & No & No \\ 1, 2, 3, 4& Named only & No \\ - 5, 6, 7, 8& Named and operator & Yes \\ + 5, 6, 7, 8, 9 & Named and operator & Yes \\ \bottomrule \end{tabular} \end{centertable} -\ChangeWhenAddingAnEAPI{8} +\ChangeWhenAddingAnEAPI{9} \begin{centertable}{EAPIs supporting \t{USE} dependencies} \label{tab:use-deps-table} \begin{tabular}{ll} @@ -276,7 +276,7 @@ manager must warn or error if
[gentoo-commits] proj/pms:eapi-9 commit in: /
commit: b4e36f9fa0f3b90c7d119ffdfc38e62bc292bdaa Author: Ulrich Müller gentoo org> AuthorDate: Mon Feb 21 18:57:30 2022 + Commit: Ulrich Müller gentoo org> CommitDate: Mon Aug 22 18:29:58 2022 + URL:https://gitweb.gentoo.org/proj/pms.git/commit/?id=b4e36f9f EAPI 9: econf matches configure --help output better Bug: https://bugs.gentoo.org/815169 Signed-off-by: Ulrich Müller gentoo.org> eapi-differences.tex | 4 pkg-mgr-commands.tex | 18 ++ 2 files changed, 22 insertions(+) diff --git a/eapi-differences.tex b/eapi-differences.tex index 9e7f269..5671c22 100644 --- a/eapi-differences.tex +++ b/eapi-differences.tex @@ -141,6 +141,9 @@ Output commands use stdout & \compactfeatureref{output-no-stdout} & \t{econf -{}-disable-static} & \compactfeatureref{econf-options} & No & No & Yes & Yes \\ +\t{econf} better matching of options & \compactfeatureref{econf-options} & +No & No & No & Yes \\ + \t{domo} destination path & \compactfeatureref{domo-path} & \t{\$\{DESTTREE\}} & \t{/usr} & \t{/usr} & \t{/usr} \\ @@ -360,6 +363,7 @@ EAPI 9 is EAPI 8 with the following changes: \begin{compactitem} \item Comments in profiles \t{parent} file, \featureref{parent-comments}. \item Different default EAPI for profiles, \featureref{profile-eapi-default}. +\item \t{econf} matches \t{configure -{}-help} output better, \featureref{econf-options}. \end{compactitem} diff --git a/pkg-mgr-commands.tex b/pkg-mgr-commands.tex index 7d2511f..e532026 100644 --- a/pkg-mgr-commands.tex +++ b/pkg-mgr-commands.tex @@ -345,6 +345,10 @@ commands once the current phase function has returned. \t{-{}-enable-static} occurs in the output of \t{configure -{}-help}. \end{itemize} +For EAPIs listed in table~\ref{tab:econf-match-end} as matching the end of the option string, +a string in \t{configure -{}-help} output will only match if is is not immediately followed by +any of the characters \t{[A-Za-z0-9+_.-]}. + \ChangeWhenAddingAnEAPI{9} % two places \begin{centertable}{Extra \t{econf} arguments for EAPIs} \label{tab:econf-options-table} @@ -374,6 +378,20 @@ commands once the current phase function has returned. \end{tabular} \end{centertable} +\ChangeWhenAddingAnEAPI{9} +\begin{centertable}{EAPIs matching end of option string in \t{configure -{}-help} output} +\label{tab:econf-match-end} +\begin{tabular}{ll} + \toprule + \multicolumn{1}{c}{\textbf{EAPI}} & + \multicolumn{1}{c}{\textbf{Matches end of option string?}} \\ + \midrule + 0, 1, 2, 3, 4, 5, 6, 7, 8 & No \\ + 9 & Yes \\ + \bottomrule +\end{tabular} +\end{centertable} + Note that the \t{\$\{EPREFIX\}} component represents the same offset-prefix as described in table~\ref{tab:defined-vars}. It facilitates offset-prefix installations which is supported by EAPIs listed in table~\ref{tab:offset-env-vars-table}. When no offset-prefix installation is in
[gentoo-commits] proj/pms:eapi-9 commit in: /
commit: 3fb704b366a9c7b11806e23f271156634bc56a4f Author: Ulrich Müller gentoo org> AuthorDate: Mon Feb 21 18:57:30 2022 + Commit: Ulrich Müller gentoo org> CommitDate: Sun Aug 21 09:36:11 2022 + URL:https://gitweb.gentoo.org/proj/pms.git/commit/?id=3fb704b3 EAPI 9: econf matches configure --help output better Bug: https://bugs.gentoo.org/815169 Signed-off-by: Ulrich Müller gentoo.org> eapi-differences.tex | 4 pkg-mgr-commands.tex | 18 ++ 2 files changed, 22 insertions(+) diff --git a/eapi-differences.tex b/eapi-differences.tex index 58ae07d..cdf71f3 100644 --- a/eapi-differences.tex +++ b/eapi-differences.tex @@ -141,6 +141,9 @@ Output commands use stdout & \compactfeatureref{output-no-stdout} & \t{econf -{}-disable-static} & \compactfeatureref{econf-options} & No & No & Yes & Yes \\ +\t{econf} better matching of options & \compactfeatureref{econf-options} & +No & No & No & Yes \\ + \t{domo} destination path & \compactfeatureref{domo-path} & \t{\$\{DESTTREE\}} & \t{/usr} & \t{/usr} & \t{/usr} \\ @@ -360,6 +363,7 @@ EAPI 9 is EAPI 8 with the following changes: \begin{compactitem} \item Comments in profiles \t{parent} file, \featureref{parent-comments}. \item Different default EAPI for profiles, \featureref{profile-eapi-default}. +\item \t{econf} matches \t{configure -{}-help} output better, \featureref{econf-options}. \end{compactitem} diff --git a/pkg-mgr-commands.tex b/pkg-mgr-commands.tex index 7d2511f..e532026 100644 --- a/pkg-mgr-commands.tex +++ b/pkg-mgr-commands.tex @@ -345,6 +345,10 @@ commands once the current phase function has returned. \t{-{}-enable-static} occurs in the output of \t{configure -{}-help}. \end{itemize} +For EAPIs listed in table~\ref{tab:econf-match-end} as matching the end of the option string, +a string in \t{configure -{}-help} output will only match if is is not immediately followed by +any of the characters \t{[A-Za-z0-9+_.-]}. + \ChangeWhenAddingAnEAPI{9} % two places \begin{centertable}{Extra \t{econf} arguments for EAPIs} \label{tab:econf-options-table} @@ -374,6 +378,20 @@ commands once the current phase function has returned. \end{tabular} \end{centertable} +\ChangeWhenAddingAnEAPI{9} +\begin{centertable}{EAPIs matching end of option string in \t{configure -{}-help} output} +\label{tab:econf-match-end} +\begin{tabular}{ll} + \toprule + \multicolumn{1}{c}{\textbf{EAPI}} & + \multicolumn{1}{c}{\textbf{Matches end of option string?}} \\ + \midrule + 0, 1, 2, 3, 4, 5, 6, 7, 8 & No \\ + 9 & Yes \\ + \bottomrule +\end{tabular} +\end{centertable} + Note that the \t{\$\{EPREFIX\}} component represents the same offset-prefix as described in table~\ref{tab:defined-vars}. It facilitates offset-prefix installations which is supported by EAPIs listed in table~\ref{tab:offset-env-vars-table}. When no offset-prefix installation is in
[gentoo-commits] proj/pms:eapi-9 commit in: /
commit: 2be5b5c4c076884178d1f90bdb2d6e8c8edf811d Author: Ulrich Müller gentoo org> AuthorDate: Tue Aug 3 16:32:47 2021 + Commit: Ulrich Müller gentoo org> CommitDate: Sun Aug 21 09:36:10 2022 + URL:https://gitweb.gentoo.org/proj/pms.git/commit/?id=2be5b5c4 Add an EAPI 9 identical to EAPI 8 Signed-off-by: Ulrich Müller gentoo.org> commands.tex | 4 +- dependencies.tex | 26 +-- eapi-differences.tex | 116 +++--- eapis.tex | 4 +- ebuild-env-vars.tex | 26 +-- ebuild-format.tex | 4 +- ebuild-functions.tex | 46 ++-- ebuild-vars.tex | 22 +- eclasses.tex | 4 +- merge.tex | 6 +-- pkg-mgr-commands.tex | 100 +-- pms.tex | 4 +- profile-variables.tex | 8 ++-- profiles.tex | 12 +++--- tree-layout.tex | 8 ++-- 15 files changed, 199 insertions(+), 191 deletions(-) diff --git a/commands.tex b/commands.tex index d0ad87d..c6f4f36 100644 --- a/commands.tex +++ b/commands.tex @@ -33,7 +33,7 @@ The following commands must always be available in the ebuild environment: table~\ref{tab:system-commands-table} as requiring GNU find. \end{compactitem} -\ChangeWhenAddingAnEAPI{8} +\ChangeWhenAddingAnEAPI{9} \begin{centertable}{System commands for EAPIs} \label{tab:system-commands-table} \begin{tabular}{lll} @@ -44,7 +44,7 @@ The following commands must always be available in the ebuild environment: \midrule 0, 1, 2, 3, 4 & Undefined & Any \\ 5, 6 & Yes & Any \\ - 7, 8 & Yes & 2.7 \\ + 7, 8, 9 & Yes & 2.7 \\ \bottomrule \end{tabular} \end{centertable} diff --git a/dependencies.tex b/dependencies.tex index f14a08c..de6e752 100644 --- a/dependencies.tex +++ b/dependencies.tex @@ -88,7 +88,7 @@ with the native build system (\t{CBUILD}). Ebuilds are allowed to call them in \ \t{pkg_postinst}. Ebuilds may also call them in \t{pkg_prerm} and \t{pkg_postrm} but must not rely on them being available. -\ChangeWhenAddingAnEAPI{8} +\ChangeWhenAddingAnEAPI{9} \begin{centertable}{EAPIs supporting additional dependency types} \label{tab:depend-table} \begin{tabular}{lll} @@ -99,7 +99,7 @@ on them being available. \midrule 0, 1, 2, 3, 4, 5, 6 & No & No \\ 7 & Yes & No \\ - 8 & Yes & Yes \\ + 8, 9& Yes & Yes \\ \bottomrule \end{tabular} \end{centertable} @@ -155,7 +155,7 @@ be surrounded on both sides by whitespace, except at the start and end of the st In particular, note that whitespace is not optional. -\ChangeWhenAddingAnEAPI{8} +\ChangeWhenAddingAnEAPI{9} \begin{centertable}{EAPIs supporting \t{REQUIRED_USE ??}\ groups} \label{tab:at-most-one-of-table} \begin{tabular}{ll} @@ -164,7 +164,7 @@ In particular, note that whitespace is not optional. \multicolumn{1}{c}{\textbf{Supports \t{REQUIRED_USE ??}\ groups?}} \\ \midrule 0, 1, 2, 3, 4 & No \\ - 5, 6, 7, 8& Yes \\ + 5, 6, 7, 8, 9 & Yes \\ \bottomrule \end{tabular} \end{centertable} @@ -204,7 +204,7 @@ In an exactly-one-of group, exactly one immediate child element must be matched. In EAPIs specified in table~\ref{tab:empty-dep-groups}, an empty exactly-one-of group counts as being matched. -\ChangeWhenAddingAnEAPI{8} +\ChangeWhenAddingAnEAPI{9} \begin{centertable}{Matching of empty dependency groups in EAPIs} \label{tab:empty-dep-groups} \begin{tabular}{ll} @@ -214,7 +214,7 @@ being matched. are matched?}} \\ \midrule 0, 1, 2, 3, 4, 5, 6 & Yes \\ - 7, 8& No \\ + 7, 8, 9 & No \\ \bottomrule \end{tabular} \end{centertable} @@ -250,7 +250,7 @@ manager must warn or error if this feature is used with an EAPI not supporting u \note{Order is important. The slot restriction must come before use dependencies.} -\ChangeWhenAddingAnEAPI{8} +\ChangeWhenAddingAnEAPI{9} \begin{centertable}{Support for \t{SLOT} dependencies and sub-slots in EAPIs} \label{tab:slot-deps-table} \begin{tabular}{lll} @@ -261,12 +261,12 @@ manager must warn or error if this feature is used with an EAPI not supporting u \midrule 0 & No & No \\ 1, 2, 3, 4& Named only & No \\ - 5, 6, 7, 8& Named and operator & Yes \\ + 5, 6, 7, 8, 9 & Named and operator & Yes \\ \bottomrule \end{tabular} \end{centertable} -\ChangeWhenAddingAnEAPI{8} +\ChangeWhenAddingAnEAPI{9} \begin{centertable}{EAPIs supporting \t{USE} dependencies} \label{tab:use-deps-table} \begin{tabular}{ll} @@ -276,7 +276,7 @@ manager must warn or error if
[gentoo-commits] proj/pms:eapi-9 commit in: /
commit: 2ad6b446bea43167fdf929a89e4821f21b2e9fbf Author: Ulrich Müller gentoo org> AuthorDate: Fri Aug 19 21:22:40 2022 + Commit: Ulrich Müller gentoo org> CommitDate: Sun Aug 21 09:36:04 2022 + URL:https://gitweb.gentoo.org/proj/pms.git/commit/?id=2ad6b446 EAPI feature table: Don't use a landscape table Drop EAPIs 0 to 5 from the table, as well as items that would have identical entries for all listed EAPIs. Signed-off-by: Ulrich Müller gentoo.org> eapi-differences.tex | 321 ++- pms.cls | 2 +- 2 files changed, 61 insertions(+), 262 deletions(-) diff --git a/eapi-differences.tex b/eapi-differences.tex index a5ba486..8e8e69d 100644 --- a/eapi-differences.tex +++ b/eapi-differences.tex @@ -1,39 +1,24 @@ \chapter{Feature Availability by EAPI} \note{This chapter is informative and for convenience only. Refer to the main text for specifics. -For lack of space, EAPIs 0, 1, 2, 3, and~4 have been consolidated into a single column in the table -below; entries marked with an asterisk differ between these EAPIs. See the 2012-09-20 edition -of this document for a complete table of previous EAPIs.} -% 2012-09-20 (EAPI 5) edition has a table of EAPIs 0 to 5 +For lack of space, EAPIs 0 to~5 have been omitted from the table below, as well as items that +would have identical entries for all listed EAPIs.} \ChangeWhenAddingAnEAPI{8} -\begin{landscape} -\begin{longtable}{llP{7.5em}P{7.5em}P{7.5em}P{7.5em}P{7.5em}} +\begin{longtable}{@{}l@{}} \caption{Features in EAPIs}\\ \toprule \multicolumn{1}{c}{\textbf{Feature}} & -\multicolumn{1}{c}{\textbf{Reference}} & -\multicolumn{5}{c}{\textbf{EAPIs}} \\ -\multicolumn{1}{c}{} & -\multicolumn{1}{c}{} & -\multicolumn{1}{c}{0, 1, 2, 3, 4} & -\multicolumn{1}{c}{5} & -\multicolumn{1}{c}{6} & -\multicolumn{1}{c}{7} & -\multicolumn{1}{c}{8} \\ +\multicolumn{1}{c}{\textbf{Ref.}} & +\multicolumn{3}{c}{\textbf{EAPIs}} \\ +& & 6 & 7 & 8 \\ \midrule \endfirsthead \midrule \multicolumn{1}{c}{\textbf{Feature}} & -\multicolumn{1}{c}{\textbf{Reference}} & -\multicolumn{5}{c}{\textbf{EAPIs}} \\ -\multicolumn{1}{c}{} & -\multicolumn{1}{c}{} & -\multicolumn{1}{c}{0, 1, 2, 3, 4} & -\multicolumn{1}{c}{5} & -\multicolumn{1}{c}{6} & -\multicolumn{1}{c}{7} & -\multicolumn{1}{c}{8} \\ +\multicolumn{1}{c}{\textbf{Ref.}} & +\multicolumn{3}{c}{\textbf{EAPIs}} \\ +& & 6 & 7 & 8 \\ \midrule \endhead \midrule @@ -42,334 +27,148 @@ of this document for a complete table of previous EAPIs.} \endlastfoot \t{package.mask} directory & \compactfeatureref{package-mask-dir} & -No & No & No & Yes & Yes \\ +No & Yes & Yes \\ Less strict filenames in \t{updates} & \compactfeatureref{updates-filenames} & -No & No & No & No & Yes \\ +No & No & Yes \\ Profile files as directories & \compactfeatureref{profile-file-dirs} & -No & No & No & Yes & Yes \\ +No & Yes & Yes \\ \t{package.provided} & \compactfeatureref{package-provided} & -Optional & Optional & Optional & No & No \\ - -Stable use masking/forcing & \compactfeatureref{stablemask} & -No & Yes & Yes & Yes & Yes \\ +Optional & No & No \\ Bash version & \compactfeatureref{bash-version} & -3.2 & 3.2 & 4.2 & 4.2 & 5.0 \\ - -\t{failglob} in global scope & \compactfeatureref{failglob} & -No & No & Yes & Yes & Yes \\ - -\t{IUSE} defaults & \compactfeatureref{iuse-defaults} & -* & Yes & Yes & Yes & Yes \\ - -\t{REQUIRED_USE} & \compactfeatureref{required-use} & -* & Yes & Yes & Yes & Yes \\ - -\t{PROPERTIES} & \compactfeatureref{properties} & -* & Yes & Yes & Yes & Yes \\ - -\t{SRC_URI} arrows & \compactfeatureref{src-uri-arrows} & -* & Yes & Yes & Yes & Yes \\ +4.2 & 4.2 & 5.0 \\ Selective URI restrictions & \compactfeatureref{uri-restrict} & -No & No & No & No & Yes \\ - -\t{RDEPEND=DEPEND} & \compactfeatureref{rdepend-depend} & -* & No & No & No & No \\ - -\t{DEFINED_PHASES} & \compactfeatureref{defined-phases} & -* & Yes & Yes & Yes & Yes \\ +No & No & Yes \\ \t{BDEPEND} & \compactfeatureref{bdepend} & -No & No & No & Yes & Yes \\ +No & Yes & Yes \\ \t{IDEPEND} & \compactfeatureref{idepend} & -No & No & No & No & Yes \\ - -\t{??\ ( )} groups & \compactfeatureref{at-most-one-of} & -No & Yes & Yes & Yes & Yes \\ +No & No & Yes \\ Empty \t{||}, \t{\textasciicircum\textasciicircum} groups match & \compactfeatureref{empty-dep-groups} & -Yes & Yes & Yes & No & No \\ - -Slot dependencies & \compactfeatureref{slot-deps} & -* & Named and Operator & Named and Operator & Named and Operator & Named and Operator \\ - -Sub-slots & \compactfeatureref{sub-slot} & -No & Yes & Yes & Yes & Yes \\ - -Use dependencies & \compactfeatureref{use-deps} & -* & 4-style & 4-style & 4-style & 4-style \\ - -\t{!}\ blockers & \compactfeatureref{bang-strength} & -* & Weak & Weak & Weak & Weak \\ - -\t{!!}\ blockers &
[gentoo-commits] proj/pms:eapi-9 commit in: /
commit: e08c3e54852cd46c7b53f9ec84c8924163264ea2 Author: Ulrich Müller gentoo org> AuthorDate: Mon Feb 21 18:32:43 2022 + Commit: Ulrich Müller gentoo org> CommitDate: Sun Aug 21 09:36:11 2022 + URL:https://gitweb.gentoo.org/proj/pms.git/commit/?id=e08c3e54 EAPI 9 profile EAPI defaults to top-level Bug: https://bugs.gentoo.org/806181 Signed-off-by: Ulrich Müller gentoo.org> eapi-differences.tex | 5 + profiles.tex | 23 +-- 2 files changed, 26 insertions(+), 2 deletions(-) diff --git a/eapi-differences.tex b/eapi-differences.tex index 5559cb9..58ae07d 100644 --- a/eapi-differences.tex +++ b/eapi-differences.tex @@ -35,6 +35,9 @@ Less strict filenames in \t{updates} & \compactfeatureref{updates-filenames} & Comments in profiles \t{parent} file & \compactfeatureref{parent-comments} & No & No & No & Yes \\ +Default EAPI for profiles & \compactfeatureref{profile-eapi-default} & +0 & 0 & 0 & Top-level \\ + Profile files as directories & \compactfeatureref{profile-file-dirs} & No & Yes & Yes & Yes \\ @@ -356,6 +359,8 @@ EAPI 9 is EAPI 8 with the following changes: \begin{compactitem} \item Comments in profiles \t{parent} file, \featureref{parent-comments}. +\item Different default EAPI for profiles, \featureref{profile-eapi-default}. + \end{compactitem} \ChangeWhenAddingAnEAPI{9} diff --git a/profiles.tex b/profiles.tex index 6fa8a1c..de59f0a 100644 --- a/profiles.tex +++ b/profiles.tex @@ -50,8 +50,27 @@ this file must not contain comments or blank lines. A profile directory may contain an \t{eapi} file. This file, if it exists, must contain a single line with the name of an EAPI\@. This specifies the EAPI to use when handling the directory in question; a package manager must not attempt to use any profile using a directory which requires an -EAPI it does not support. If no \t{eapi} file is present, EAPI 0 shall be used. The EAPI is neither -inherited via the \t{parent} file nor in subdirectories. +EAPI it does not support. + +\featurelabel{profile-eapi-default} If no \t{eapi} file is present, the default depends on the EAPI +of the top-level profiles directory (see section~\ref{sec:profiles-dir}). That EAPI shall be used +if table~\ref{tab:profile-eapi-default} lists it as ``top-level''. Otherwise, EAPI 0 shall be used. + +The EAPI is neither inherited via the \t{parent} file nor in subdirectories. + +\ChangeWhenAddingAnEAPI{9} +\begin{centertable}{Default EAPI for profiles} +\label{tab:profile-eapi-default} +\begin{tabular}{ll} + \toprule + \multicolumn{1}{c}{\textbf{EAPI}} & + \multicolumn{1}{c}{\textbf{Default EAPI?}} \\ + \midrule + 0, 1, 2, 3, 4, 5, 6, 7, 8 & 0 \\ + 9 & Top-level \\ + \bottomrule +\end{tabular} +\end{centertable} \subsection{deprecated} If a profile contains a file named \t{deprecated}, it is treated as such. The first line of this
[gentoo-commits] proj/pms:eapi-9 commit in: /
commit: 0dd597e3ee3a951ad9b662a474632c0f9e0169de Author: Ulrich Müller gentoo org> AuthorDate: Mon Feb 21 18:30:11 2022 + Commit: Ulrich Müller gentoo org> CommitDate: Sun Aug 21 09:36:10 2022 + URL:https://gitweb.gentoo.org/proj/pms.git/commit/?id=0dd597e3 EAPI 9 profile parent files can contain comments Bug: https://bugs.gentoo.org/470094 Signed-off-by: Ulrich Müller gentoo.org> eapi-differences.tex | 5 - profiles.tex | 20 +++- 2 files changed, 23 insertions(+), 2 deletions(-) diff --git a/eapi-differences.tex b/eapi-differences.tex index 401fdb7..5559cb9 100644 --- a/eapi-differences.tex +++ b/eapi-differences.tex @@ -32,6 +32,9 @@ would have identical entries for all listed EAPIs.} Less strict filenames in \t{updates} & \compactfeatureref{updates-filenames} & No & No & Yes & Yes \\ +Comments in profiles \t{parent} file & \compactfeatureref{parent-comments} & +No & No & No & Yes \\ + Profile files as directories & \compactfeatureref{profile-file-dirs} & No & Yes & Yes & Yes \\ @@ -352,7 +355,7 @@ EAPI 8 is EAPI 7 with the following changes: EAPI 9 is EAPI 8 with the following changes: \begin{compactitem} -\item None +\item Comments in profiles \t{parent} file, \featureref{parent-comments}. \end{compactitem} \ChangeWhenAddingAnEAPI{9} diff --git a/profiles.tex b/profiles.tex index 8d8226a..6fa8a1c 100644 --- a/profiles.tex +++ b/profiles.tex @@ -25,7 +25,25 @@ first, left to right, with duplicate parent paths being sourced for every time t It is illegal for a profile's parent tree to contain cycles. Package manager behaviour upon encountering a cycle is undefined. -This file must not contain comments, blank lines or make use of line continuations. +This file must not make use of line continuations. + +\featurelabel{parent-comments} For EAPIs listed in table~\ref{tab:profile-parent-comments} as +allowing comments, blank lines and lines beginning with a \t{\#} are discarded. For other EAPIs, +this file must not contain comments or blank lines. + +\ChangeWhenAddingAnEAPI{9} +\begin{centertable}{EAPIs allowing comments in \t{parent} file} +\label{tab:profile-parent-comments} +\begin{tabular}{ll} + \toprule + \multicolumn{1}{c}{\textbf{EAPI}} & + \multicolumn{1}{c}{\textbf{Allows comments?}} \\ + \midrule + 0, 1, 2, 3, 4, 5, 6, 7, 8 & No \\ + 9 & Yes \\ + \bottomrule +\end{tabular} +\end{centertable} \subsection{The eapi file} \label{sec:profile-eapi}
[gentoo-commits] proj/pms:eapi-9 commit in: /
commit: f2da80f2cbccf68af327169743fe6c61911e7806 Author: Ulrich Müller gentoo org> AuthorDate: Tue Aug 3 16:32:47 2021 + Commit: Ulrich Müller gentoo org> CommitDate: Thu Aug 18 15:51:53 2022 + URL:https://gitweb.gentoo.org/proj/pms.git/commit/?id=f2da80f2 Add an EAPI 9 identical to EAPI 8 Signed-off-by: Ulrich Müller gentoo.org> commands.tex | 4 +- dependencies.tex | 26 +++--- eapi-differences.tex | 231 +++--- eapis.tex | 4 +- ebuild-env-vars.tex | 26 +++--- ebuild-format.tex | 4 +- ebuild-functions.tex | 46 +- ebuild-vars.tex | 22 ++--- eclasses.tex | 4 +- merge.tex | 6 +- pkg-mgr-commands.tex | 100 +++--- pms.tex | 4 +- profile-variables.tex | 8 +- profiles.tex | 12 +-- tree-layout.tex | 8 +- 15 files changed, 260 insertions(+), 245 deletions(-) diff --git a/commands.tex b/commands.tex index d0ad87d..c6f4f36 100644 --- a/commands.tex +++ b/commands.tex @@ -33,7 +33,7 @@ The following commands must always be available in the ebuild environment: table~\ref{tab:system-commands-table} as requiring GNU find. \end{compactitem} -\ChangeWhenAddingAnEAPI{8} +\ChangeWhenAddingAnEAPI{9} \begin{centertable}{System commands for EAPIs} \label{tab:system-commands-table} \begin{tabular}{lll} @@ -44,7 +44,7 @@ The following commands must always be available in the ebuild environment: \midrule 0, 1, 2, 3, 4 & Undefined & Any \\ 5, 6 & Yes & Any \\ - 7, 8 & Yes & 2.7 \\ + 7, 8, 9 & Yes & 2.7 \\ \bottomrule \end{tabular} \end{centertable} diff --git a/dependencies.tex b/dependencies.tex index f14a08c..de6e752 100644 --- a/dependencies.tex +++ b/dependencies.tex @@ -88,7 +88,7 @@ with the native build system (\t{CBUILD}). Ebuilds are allowed to call them in \ \t{pkg_postinst}. Ebuilds may also call them in \t{pkg_prerm} and \t{pkg_postrm} but must not rely on them being available. -\ChangeWhenAddingAnEAPI{8} +\ChangeWhenAddingAnEAPI{9} \begin{centertable}{EAPIs supporting additional dependency types} \label{tab:depend-table} \begin{tabular}{lll} @@ -99,7 +99,7 @@ on them being available. \midrule 0, 1, 2, 3, 4, 5, 6 & No & No \\ 7 & Yes & No \\ - 8 & Yes & Yes \\ + 8, 9& Yes & Yes \\ \bottomrule \end{tabular} \end{centertable} @@ -155,7 +155,7 @@ be surrounded on both sides by whitespace, except at the start and end of the st In particular, note that whitespace is not optional. -\ChangeWhenAddingAnEAPI{8} +\ChangeWhenAddingAnEAPI{9} \begin{centertable}{EAPIs supporting \t{REQUIRED_USE ??}\ groups} \label{tab:at-most-one-of-table} \begin{tabular}{ll} @@ -164,7 +164,7 @@ In particular, note that whitespace is not optional. \multicolumn{1}{c}{\textbf{Supports \t{REQUIRED_USE ??}\ groups?}} \\ \midrule 0, 1, 2, 3, 4 & No \\ - 5, 6, 7, 8& Yes \\ + 5, 6, 7, 8, 9 & Yes \\ \bottomrule \end{tabular} \end{centertable} @@ -204,7 +204,7 @@ In an exactly-one-of group, exactly one immediate child element must be matched. In EAPIs specified in table~\ref{tab:empty-dep-groups}, an empty exactly-one-of group counts as being matched. -\ChangeWhenAddingAnEAPI{8} +\ChangeWhenAddingAnEAPI{9} \begin{centertable}{Matching of empty dependency groups in EAPIs} \label{tab:empty-dep-groups} \begin{tabular}{ll} @@ -214,7 +214,7 @@ being matched. are matched?}} \\ \midrule 0, 1, 2, 3, 4, 5, 6 & Yes \\ - 7, 8& No \\ + 7, 8, 9 & No \\ \bottomrule \end{tabular} \end{centertable} @@ -250,7 +250,7 @@ manager must warn or error if this feature is used with an EAPI not supporting u \note{Order is important. The slot restriction must come before use dependencies.} -\ChangeWhenAddingAnEAPI{8} +\ChangeWhenAddingAnEAPI{9} \begin{centertable}{Support for \t{SLOT} dependencies and sub-slots in EAPIs} \label{tab:slot-deps-table} \begin{tabular}{lll} @@ -261,12 +261,12 @@ manager must warn or error if this feature is used with an EAPI not supporting u \midrule 0 & No & No \\ 1, 2, 3, 4& Named only & No \\ - 5, 6, 7, 8& Named and operator & Yes \\ + 5, 6, 7, 8, 9 & Named and operator & Yes \\ \bottomrule \end{tabular} \end{centertable} -\ChangeWhenAddingAnEAPI{8} +\ChangeWhenAddingAnEAPI{9} \begin{centertable}{EAPIs supporting \t{USE} dependencies} \label{tab:use-deps-table} \begin{tabular}{ll} @@ -276,7 +276,7 @@ manager must warn or error if this feature is used with an EAPI not supporting u
[gentoo-commits] proj/pms:eapi-9 commit in: /
commit: cf612a0335641472a263d0dc4aa4e21d6573a4db Author: Ulrich Müller gentoo org> AuthorDate: Tue Aug 3 16:34:08 2021 + Commit: Ulrich Müller gentoo org> CommitDate: Thu Aug 18 15:51:53 2022 + URL:https://gitweb.gentoo.org/proj/pms.git/commit/?id=cf612a03 EAPI feature table: Drop EAPIs 0 to 4 Also drop items that would have identical entries for all listed EAPIs. Signed-off-by: Ulrich Müller gentoo.org> eapi-differences.tex | 276 --- 1 file changed, 62 insertions(+), 214 deletions(-) diff --git a/eapi-differences.tex b/eapi-differences.tex index c75404b..7bf3f2c 100644 --- a/eapi-differences.tex +++ b/eapi-differences.tex @@ -1,22 +1,21 @@ \chapter{Feature Availability by EAPI} \note{This chapter is informative and for convenience only. Refer to the main text for specifics. -For lack of space, EAPIs 0, 1, 2, 3, and~4 have been consolidated into a single column in the table -below; entries marked with an asterisk differ between these EAPIs. See the 2012-09-20 edition -of this document for a complete table of previous EAPIs.} +For lack of space, EAPIs 0, 1, 2, 3, and~4 have been omitted from the table below, as well as items +that would have identical entries for all listed EAPIs. See the 2012-09-20 edition of this document +for a complete table of previous EAPIs.} % 2012-09-20 (EAPI 5) edition has a table of EAPIs 0 to 5 \ChangeWhenAddingAnEAPI{9} \begin{landscape} -\begin{longtable}{llP{7.5em}P{7.5em}P{7.5em}P{7.5em}P{7.5em}P{7.5em}} +\begin{longtable}{llP{7.5em}P{7.5em}P{7.5em}P{7.5em}P{7.5em}} \caption{Features in EAPIs}\\ \toprule \multicolumn{1}{c}{\textbf{Feature}} & \multicolumn{1}{c}{\textbf{Reference}} & -\multicolumn{6}{c}{\textbf{EAPIs}} \\ +\multicolumn{5}{c}{\textbf{EAPIs}} \\ \multicolumn{1}{c}{} & \multicolumn{1}{c}{} & -\multicolumn{1}{c}{0, 1, 2, 3, 4} & \multicolumn{1}{c}{5} & \multicolumn{1}{c}{6} & \multicolumn{1}{c}{7} & @@ -27,10 +26,9 @@ of this document for a complete table of previous EAPIs.} \midrule \multicolumn{1}{c}{\textbf{Feature}} & \multicolumn{1}{c}{\textbf{Reference}} & -\multicolumn{6}{c}{\textbf{EAPIs}} \\ +\multicolumn{5}{c}{\textbf{EAPIs}} \\ \multicolumn{1}{c}{} & \multicolumn{1}{c}{} & -\multicolumn{1}{c}{0, 1, 2, 3, 4} & \multicolumn{1}{c}{5} & \multicolumn{1}{c}{6} & \multicolumn{1}{c}{7} & @@ -44,236 +42,125 @@ of this document for a complete table of previous EAPIs.} \endlastfoot \t{package.mask} directory & \compactfeatureref{package-mask-dir} & -No & No & No & Yes & Yes & Yes \\ +No & No & Yes & Yes & Yes \\ Less strict filenames in \t{updates} & \compactfeatureref{updates-filenames} & -No & No & No & No & Yes & Yes \\ +No & No & No & Yes & Yes \\ Profile files as directories & \compactfeatureref{profile-file-dirs} & -No & No & No & Yes & Yes & Yes \\ +No & No & Yes & Yes & Yes \\ \t{package.provided} & \compactfeatureref{package-provided} & -Optional & Optional & Optional & No & No & No \\ - -Stable use masking/forcing & \compactfeatureref{stablemask} & -No & Yes & Yes & Yes & Yes & Yes \\ +Optional & Optional & No & No & No \\ Bash version & \compactfeatureref{bash-version} & -3.2 & 3.2 & 4.2 & 4.2 & 5.0 & 5.0 \\ +3.2 & 4.2 & 4.2 & 5.0 & 5.0 \\ \t{failglob} in global scope & \compactfeatureref{failglob} & -No & No & Yes & Yes & Yes & Yes \\ - -\t{IUSE} defaults & \compactfeatureref{iuse-defaults} & -* & Yes & Yes & Yes & Yes & Yes \\ - -\t{REQUIRED_USE} & \compactfeatureref{required-use} & -* & Yes & Yes & Yes & Yes & Yes \\ - -\t{PROPERTIES} & \compactfeatureref{properties} & -* & Yes & Yes & Yes & Yes & Yes \\ - -\t{SRC_URI} arrows & \compactfeatureref{src-uri-arrows} & -* & Yes & Yes & Yes & Yes & Yes \\ +No & Yes & Yes & Yes & Yes \\ Selective URI restrictions & \compactfeatureref{uri-restrict} & -No & No & No & No & Yes & Yes \\ - -\t{RDEPEND=DEPEND} & \compactfeatureref{rdepend-depend} & -* & No & No & No & No & No \\ - -\t{DEFINED_PHASES} & \compactfeatureref{defined-phases} & -* & Yes & Yes & Yes & Yes & Yes \\ +No & No & No & Yes & Yes \\ \t{BDEPEND} & \compactfeatureref{bdepend} & -No & No & No & Yes & Yes & Yes \\ +No & No & Yes & Yes & Yes \\ \t{IDEPEND} & \compactfeatureref{idepend} & -No & No & No & No & Yes & Yes \\ - -\t{??\ ( )} groups & \compactfeatureref{at-most-one-of} & -No & Yes & Yes & Yes & Yes & Yes \\ +No & No & No & Yes & Yes \\ Empty \t{||}, \t{\textasciicircum\textasciicircum} groups match & \compactfeatureref{empty-dep-groups} & -Yes & Yes & Yes & No & No & No \\ - -Slot dependencies & \compactfeatureref{slot-deps} & -* & Named and Operator & Named and Operator & Named and Operator & Named and Operator & -Named and Operator \\ - -Sub-slots & \compactfeatureref{sub-slot} & -No & Yes & Yes & Yes & Yes & Yes \\ - -Use dependencies &
[gentoo-commits] proj/pms:eapi-9 commit in: /
commit: edb669663d753b599673f2ddda5987a9b93be437 Author: Ulrich Müller gentoo org> AuthorDate: Mon Feb 21 18:30:11 2022 + Commit: Ulrich Müller gentoo org> CommitDate: Thu Aug 18 15:51:54 2022 + URL:https://gitweb.gentoo.org/proj/pms.git/commit/?id=edb66966 EAPI 9 profile parent files can contain comments Bug: https://bugs.gentoo.org/470094 Signed-off-by: Ulrich Müller gentoo.org> eapi-differences.tex | 5 - profiles.tex | 20 +++- 2 files changed, 23 insertions(+), 2 deletions(-) diff --git a/eapi-differences.tex b/eapi-differences.tex index 7bf3f2c..b83da4e 100644 --- a/eapi-differences.tex +++ b/eapi-differences.tex @@ -47,6 +47,9 @@ for a complete table of previous EAPIs.} Less strict filenames in \t{updates} & \compactfeatureref{updates-filenames} & No & No & No & Yes & Yes \\ +Comments in profiles \t{parent} file & \compactfeatureref{parent-comments} & +No & No & No & No & Yes \\ + Profile files as directories & \compactfeatureref{profile-file-dirs} & No & No & Yes & Yes & Yes \\ @@ -405,7 +408,7 @@ EAPI 8 is EAPI 7 with the following changes: EAPI 9 is EAPI 8 with the following changes: \begin{compactitem} -\item None +\item Comments in profiles \t{parent} file, \featureref{parent-comments}. \end{compactitem} \ChangeWhenAddingAnEAPI{9} diff --git a/profiles.tex b/profiles.tex index 8d8226a..6fa8a1c 100644 --- a/profiles.tex +++ b/profiles.tex @@ -25,7 +25,25 @@ first, left to right, with duplicate parent paths being sourced for every time t It is illegal for a profile's parent tree to contain cycles. Package manager behaviour upon encountering a cycle is undefined. -This file must not contain comments, blank lines or make use of line continuations. +This file must not make use of line continuations. + +\featurelabel{parent-comments} For EAPIs listed in table~\ref{tab:profile-parent-comments} as +allowing comments, blank lines and lines beginning with a \t{\#} are discarded. For other EAPIs, +this file must not contain comments or blank lines. + +\ChangeWhenAddingAnEAPI{9} +\begin{centertable}{EAPIs allowing comments in \t{parent} file} +\label{tab:profile-parent-comments} +\begin{tabular}{ll} + \toprule + \multicolumn{1}{c}{\textbf{EAPI}} & + \multicolumn{1}{c}{\textbf{Allows comments?}} \\ + \midrule + 0, 1, 2, 3, 4, 5, 6, 7, 8 & No \\ + 9 & Yes \\ + \bottomrule +\end{tabular} +\end{centertable} \subsection{The eapi file} \label{sec:profile-eapi}
[gentoo-commits] proj/pms:eapi-9 commit in: /
commit: 213db65b0d49478c981bc9d80afa7ff5d74eb705 Author: Ulrich Müller gentoo org> AuthorDate: Mon Feb 21 18:32:43 2022 + Commit: Ulrich Müller gentoo org> CommitDate: Thu Aug 18 15:51:54 2022 + URL:https://gitweb.gentoo.org/proj/pms.git/commit/?id=213db65b EAPI 9 profile EAPI defaults to top-level Bug: https://bugs.gentoo.org/806181 Signed-off-by: Ulrich Müller gentoo.org> eapi-differences.tex | 5 + profiles.tex | 23 +-- 2 files changed, 26 insertions(+), 2 deletions(-) diff --git a/eapi-differences.tex b/eapi-differences.tex index b83da4e..d292bc7 100644 --- a/eapi-differences.tex +++ b/eapi-differences.tex @@ -50,6 +50,9 @@ Less strict filenames in \t{updates} & \compactfeatureref{updates-filenames} & Comments in profiles \t{parent} file & \compactfeatureref{parent-comments} & No & No & No & No & Yes \\ +Default EAPI for profiles & \compactfeatureref{profile-eapi-default} & +0 & 0 & 0 & 0 & Top-level \\ + Profile files as directories & \compactfeatureref{profile-file-dirs} & No & No & Yes & Yes & Yes \\ @@ -409,6 +412,8 @@ EAPI 9 is EAPI 8 with the following changes: \begin{compactitem} \item Comments in profiles \t{parent} file, \featureref{parent-comments}. +\item Different default EAPI for profiles, \featureref{profile-eapi-default}. + \end{compactitem} \ChangeWhenAddingAnEAPI{9} diff --git a/profiles.tex b/profiles.tex index 6fa8a1c..de59f0a 100644 --- a/profiles.tex +++ b/profiles.tex @@ -50,8 +50,27 @@ this file must not contain comments or blank lines. A profile directory may contain an \t{eapi} file. This file, if it exists, must contain a single line with the name of an EAPI\@. This specifies the EAPI to use when handling the directory in question; a package manager must not attempt to use any profile using a directory which requires an -EAPI it does not support. If no \t{eapi} file is present, EAPI 0 shall be used. The EAPI is neither -inherited via the \t{parent} file nor in subdirectories. +EAPI it does not support. + +\featurelabel{profile-eapi-default} If no \t{eapi} file is present, the default depends on the EAPI +of the top-level profiles directory (see section~\ref{sec:profiles-dir}). That EAPI shall be used +if table~\ref{tab:profile-eapi-default} lists it as ``top-level''. Otherwise, EAPI 0 shall be used. + +The EAPI is neither inherited via the \t{parent} file nor in subdirectories. + +\ChangeWhenAddingAnEAPI{9} +\begin{centertable}{Default EAPI for profiles} +\label{tab:profile-eapi-default} +\begin{tabular}{ll} + \toprule + \multicolumn{1}{c}{\textbf{EAPI}} & + \multicolumn{1}{c}{\textbf{Default EAPI?}} \\ + \midrule + 0, 1, 2, 3, 4, 5, 6, 7, 8 & 0 \\ + 9 & Top-level \\ + \bottomrule +\end{tabular} +\end{centertable} \subsection{deprecated} If a profile contains a file named \t{deprecated}, it is treated as such. The first line of this
[gentoo-commits] proj/pms:eapi-9 commit in: /
commit: c5dca7fe3158fccb49a74054b7ed8f98e73bf243 Author: Ulrich Müller gentoo org> AuthorDate: Sat Mar 26 21:02:18 2022 + Commit: Ulrich Müller gentoo org> CommitDate: Sat Mar 26 21:02:18 2022 + URL:https://gitweb.gentoo.org/proj/pms.git/commit/?id=c5dca7fe Replace "root user" by "superuser" throughout Signed-off-by: Ulrich Müller gentoo.org> ebuild-vars.tex | 2 +- merge.tex | 8 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/ebuild-vars.tex b/ebuild-vars.tex index e7aab0a..5f3f583 100644 --- a/ebuild-vars.tex +++ b/ebuild-vars.tex @@ -256,7 +256,7 @@ The following tokens are permitted inside \t{RESTRICT}: \item[strip] No stripping of debug symbols from files to be installed may be performed. In EAPIs listed in table~\ref{tab:staging-area-commands} as supporting controllable stripping, this behaviour may be altered by the \t{dostrip} command. -\item[userpriv] The package manager may not drop root privileges when building the package. +\item[userpriv] The package manager may not drop superuser privileges when building the package. \item[test] The \t{src_test} phase must not be run. \end{description} diff --git a/merge.tex b/merge.tex index 0e6738d..6fcfeec 100644 --- a/merge.tex +++ b/merge.tex @@ -25,9 +25,9 @@ The owner, group and mode (including set*id and sticky bits) of the directory mu except as follows: \begin{compactitem} -\item Any directory owned by the user used to perform the build must become owned by the root user. +\item Any directory owned by the user used to perform the build must become owned by the superuser. \item Any directory whose group is the primary group of the user used to perform the build must have -its group be that of the root user. +its group be that of the superuser. \end{compactitem} On SELinux systems, the SELinux context must also be preserved. Other directory attributes, including @@ -53,9 +53,9 @@ The owner, group and mode (including set*id and sticky bits) of the file must be as follows: \begin{compactitem} -\item Any file owned by the user used to perform the build must become owned by the root user. +\item Any file owned by the user used to perform the build must become owned by the superuser. \item Any file whose group is the primary group of the user used to perform the build must have -its group be that of the root user. +its group be that of the superuser. \item The package manager may reduce read and write permissions on executable files that have a set*id bit set. \end{compactitem}
[gentoo-commits] proj/pms:eapi-9 commit in: /
commit: 8bcf0e2f9b6234e2e752d68df0ef054fd2cc49b1 Author: Ulrich Müller gentoo org> AuthorDate: Thu Mar 17 19:00:47 2022 + Commit: Ulrich Müller gentoo org> CommitDate: Thu Mar 17 19:00:47 2022 + URL:https://gitweb.gentoo.org/proj/pms.git/commit/?id=8bcf0e2f ebuild-vars.tex: Clarify which variables can be defined by an eclass Signed-off-by: Ulrich Müller gentoo.org> ebuild-vars.tex | 7 +-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/ebuild-vars.tex b/ebuild-vars.tex index d07cca4..e7aab0a 100644 --- a/ebuild-vars.tex +++ b/ebuild-vars.tex @@ -43,8 +43,9 @@ All ebuilds must define at least the following variables: \section{Optional Ebuild-defined Variables} \label{sec:optional-vars} -Ebuilds may define any of the following variables: -\nobreakpar +Ebuilds may define any of the following variables. Unless otherwise stated, any of them may be +defined by an eclass. + \begin{description} \item[EAPI] The EAPI\@. See below in section~\ref{sec:eapi}. \item[HOMEPAGE] The URI or URIs for a package's homepage, including protocols. @@ -147,6 +148,8 @@ EAPI, the package manager must make sure that the \t{EAPI} value obtained by sou with bash is identical to the EAPI obtained by parsing. The ebuild must be treated as invalid if these values are different. +Eclasses must not attempt to modify the \t{EAPI} variable. + \subsection{SRC_URI} \label{sec:src-uri-behaviour}
[gentoo-commits] proj/pms:eapi-9 commit in: /
commit: 2eacc31d620a70f29090e2de227223eb5a05157c Author: Ulrich Müller gentoo org> AuthorDate: Mon Feb 21 18:57:30 2022 + Commit: Ulrich Müller gentoo org> CommitDate: Thu Aug 18 15:51:55 2022 + URL:https://gitweb.gentoo.org/proj/pms.git/commit/?id=2eacc31d EAPI 9: econf matches configure --help output better Bug: https://bugs.gentoo.org/815169 Signed-off-by: Ulrich Müller gentoo.org> eapi-differences.tex | 4 pkg-mgr-commands.tex | 18 ++ 2 files changed, 22 insertions(+) diff --git a/eapi-differences.tex b/eapi-differences.tex index d292bc7..b38ea5d 100644 --- a/eapi-differences.tex +++ b/eapi-differences.tex @@ -175,6 +175,9 @@ Output commands use stdout & \compactfeatureref{output-no-stdout} & disable dependency tracking, disable silent rules, disable static, datarootdir, docdir, htmldir, with sysroot \\ +\t{econf} better matching of options & \compactfeatureref{econf-options} & +No & No & No & No & Yes \\ + \t{domo} destination path & \compactfeatureref{domo-path} & \t{\$\{DESTTREE\}} & \t{\$\{DESTTREE\}} & \t{/usr} & \t{/usr} & \t{/usr} \\ @@ -413,6 +416,7 @@ EAPI 9 is EAPI 8 with the following changes: \begin{compactitem} \item Comments in profiles \t{parent} file, \featureref{parent-comments}. \item Different default EAPI for profiles, \featureref{profile-eapi-default}. +\item \t{econf} matches \t{configure -{}-help} output better, \featureref{econf-options}. \end{compactitem} diff --git a/pkg-mgr-commands.tex b/pkg-mgr-commands.tex index 7d2511f..e532026 100644 --- a/pkg-mgr-commands.tex +++ b/pkg-mgr-commands.tex @@ -345,6 +345,10 @@ commands once the current phase function has returned. \t{-{}-enable-static} occurs in the output of \t{configure -{}-help}. \end{itemize} +For EAPIs listed in table~\ref{tab:econf-match-end} as matching the end of the option string, +a string in \t{configure -{}-help} output will only match if is is not immediately followed by +any of the characters \t{[A-Za-z0-9+_.-]}. + \ChangeWhenAddingAnEAPI{9} % two places \begin{centertable}{Extra \t{econf} arguments for EAPIs} \label{tab:econf-options-table} @@ -374,6 +378,20 @@ commands once the current phase function has returned. \end{tabular} \end{centertable} +\ChangeWhenAddingAnEAPI{9} +\begin{centertable}{EAPIs matching end of option string in \t{configure -{}-help} output} +\label{tab:econf-match-end} +\begin{tabular}{ll} + \toprule + \multicolumn{1}{c}{\textbf{EAPI}} & + \multicolumn{1}{c}{\textbf{Matches end of option string?}} \\ + \midrule + 0, 1, 2, 3, 4, 5, 6, 7, 8 & No \\ + 9 & Yes \\ + \bottomrule +\end{tabular} +\end{centertable} + Note that the \t{\$\{EPREFIX\}} component represents the same offset-prefix as described in table~\ref{tab:defined-vars}. It facilitates offset-prefix installations which is supported by EAPIs listed in table~\ref{tab:offset-env-vars-table}. When no offset-prefix installation is in
[gentoo-commits] proj/pms:eapi-9 commit in: /
commit: 260e21bf65f67ad424e990306a7a4789b6b2f1de Author: Ulrich Müller gentoo org> AuthorDate: Wed May 11 21:55:40 2022 + Commit: Ulrich Müller gentoo org> CommitDate: Sat May 14 07:29:57 2022 + URL:https://gitweb.gentoo.org/proj/pms.git/commit/?id=260e21bf 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 gentoo.org> pkg-mgr-commands.tex | 14 ++ 1 file 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 :
[gentoo-commits] proj/pms:eapi-9 commit in: /
commit: bcc0be554b5fc3300a0db6a3d3d7765c262aaa43 Author: Ulrich Müller gentoo org> AuthorDate: Sat Mar 26 10:06:01 2022 + Commit: Ulrich Müller gentoo org> CommitDate: Sat Mar 26 10:06:01 2022 + URL:https://gitweb.gentoo.org/proj/pms.git/commit/?id=bcc0be55 pkg-mgr-commands.tex: Specify file ownership for dobin more accurately In a non-prefix installation, files are to be owned by UID 0 / GID 0. This is also what is implemented in Portage's dobin command. Signed-off-by: Ulrich Müller gentoo.org> pkg-mgr-commands.tex | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pkg-mgr-commands.tex b/pkg-mgr-commands.tex index 7f57539..a964859 100644 --- a/pkg-mgr-commands.tex +++ b/pkg-mgr-commands.tex @@ -460,7 +460,7 @@ the current phase function has returned. \item[dobin] Installs the given files into \t{DESTTREE/bin}, where \t{DESTTREE} defaults to \t{/usr}. Gives the files mode \t{0755} and transfers file ownership to the superuser or its equivalent on the system or installation at hand. In a non-offset-prefix installation this -ownership is \t{root:root}, while in an offset-prefix aware installation this may be e.\,g.\ +ownership is \t{0:0}, while in an offset-prefix aware installation this may be e.\,g.\ \t{joe:users}. Failure behaviour is EAPI dependent as per section~\ref{sec:failure-behaviour}. \item[doconfd] Installs the given config files into \t{/etc/conf.d/}, by default with file mode
[gentoo-commits] proj/pms:eapi-9 commit in: /
commit: 7839a316822eae2fcb534cba697993ca8772b9f9 Author: Ulrich Müller gentoo org> AuthorDate: Tue Apr 12 10:56:38 2022 + Commit: Ulrich Müller gentoo org> CommitDate: Tue Apr 12 10:56:38 2022 + URL:https://gitweb.gentoo.org/proj/pms.git/commit/?id=7839a316 pkg-mgr-commands.tex: Whitespace Signed-off-by: Ulrich Müller gentoo.org> pkg-mgr-commands.tex | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pkg-mgr-commands.tex b/pkg-mgr-commands.tex index a964859..6df5f32 100644 --- a/pkg-mgr-commands.tex +++ b/pkg-mgr-commands.tex @@ -613,7 +613,7 @@ the current phase function has returned. \featurelabel{dosym-relative} In EAPIs listed in table~\ref{tab:dosym-r} as supporting creation of relative paths, when called with option \t{-r}, the first parameter (the link target) is converted from an absolute path to a path relative to the the second parameter (the link name). -The algorithm must return a result identical to the one returned by the function in +The algorithm must return a result identical to the one returned by the function in listing~\ref{lst:dosym-r}, with \t{realpath} and \t{dirname} from GNU coreutils version~8.32. Specifying option \t{-r} together with a relative path as first (target) parameter is an error.
[gentoo-commits] proj/pms:eapi-9 commit in: /
commit: d74436b4b83e2f80fdc7a5f7e7361a92770bb52e Author: Ulrich Müller gentoo org> AuthorDate: Mon Feb 21 18:57:30 2022 + Commit: Ulrich Müller gentoo org> CommitDate: Mon Feb 21 18:57:30 2022 + URL:https://gitweb.gentoo.org/proj/pms.git/commit/?id=d74436b4 EAPI 9: econf matches configure --help output better Bug: https://bugs.gentoo.org/815169 Signed-off-by: Ulrich Müller gentoo.org> eapi-differences.tex | 4 pkg-mgr-commands.tex | 18 ++ 2 files changed, 22 insertions(+) diff --git a/eapi-differences.tex b/eapi-differences.tex index 19f5134..abf775c 100644 --- a/eapi-differences.tex +++ b/eapi-differences.tex @@ -282,6 +282,9 @@ Output commands use stdout & \compactfeatureref{output-no-stdout} & disable dependency tracking, disable silent rules, disable static, datarootdir, docdir, htmldir, with sysroot \\ +\t{econf} better matching of options & \compactfeatureref{econf-options} & +No & No & No & No & Yes \\ + \t{dodoc -r} & \compactfeatureref{dodoc} & * & Yes & Yes & Yes & Yes \\ @@ -559,6 +562,7 @@ EAPI 9 is EAPI 8 with the following changes: \begin{compactitem} \item Comments in profiles \t{parent} file, \featureref{parent-comments}. \item Different default EAPI for profiles, \featureref{profile-eapi-default}. +\item \t{econf} matches \t{configure -{}-help} output better, \featureref{econf-options}. \end{compactitem} diff --git a/pkg-mgr-commands.tex b/pkg-mgr-commands.tex index dae13d4..fb8b1b8 100644 --- a/pkg-mgr-commands.tex +++ b/pkg-mgr-commands.tex @@ -345,6 +345,10 @@ commands once the current phase function has returned. \t{-{}-enable-static} occurs in the output of \t{configure -{}-help}. \end{itemize} +For EAPIs listed in table~\ref{tab:econf-match-end} as matching the end of the option string, +a string in \t{configure -{}-help} output will only match if is is not immediately followed by +any of the characters \t{[A-Za-z0-9+_.-]}. + \ChangeWhenAddingAnEAPI{9} % two places \begin{centertable}{Extra \t{econf} arguments for EAPIs} \label{tab:econf-options-table} @@ -374,6 +378,20 @@ commands once the current phase function has returned. \end{tabular} \end{centertable} +\ChangeWhenAddingAnEAPI{9} +\begin{centertable}{EAPIs matching end of option string in \t{configure -{}-help} output} +\label{tab:econf-match-end} +\begin{tabular}{ll} + \toprule + \multicolumn{1}{c}{\textbf{EAPI}} & + \multicolumn{1}{c}{\textbf{Matches end of option string?}} \\ + \midrule + 0, 1, 2, 3, 4, 5, 6, 7, 8 & No \\ + 9 & Yes \\ + \bottomrule +\end{tabular} +\end{centertable} + Note that the \t{\$\{EPREFIX\}} component represents the same offset-prefix as described in table~\ref{tab:defined-vars}. It facilitates offset-prefix installations which is supported by EAPIs listed in table~\ref{tab:offset-env-vars-table}. When no offset-prefix installation is in
[gentoo-commits] proj/pms:eapi-9 commit in: /
commit: 04953d4d22cc526d1d375a0f51cdef44c6dcde7e Author: Ulrich Müller gentoo org> AuthorDate: Mon Feb 21 18:32:43 2022 + Commit: Ulrich Müller gentoo org> CommitDate: Mon Feb 21 18:32:43 2022 + URL:https://gitweb.gentoo.org/proj/pms.git/commit/?id=04953d4d EAPI 9 profile EAPI defaults to top-level Bug: https://bugs.gentoo.org/806181 Signed-off-by: Ulrich Müller gentoo.org> eapi-differences.tex | 5 + profiles.tex | 23 +-- 2 files changed, 26 insertions(+), 2 deletions(-) diff --git a/eapi-differences.tex b/eapi-differences.tex index bb84b85..19f5134 100644 --- a/eapi-differences.tex +++ b/eapi-differences.tex @@ -50,6 +50,9 @@ Less strict filenames in \t{updates} & \compactfeatureref{updates-filenames} & Comments in profiles \t{parent} file & \compactfeatureref{parent-comments} & No & No & No & No & Yes \\ +Default EAPI for profiles & \compactfeatureref{profile-eapi-default} & +0 & 0 & 0 & 0 & Top-level \\ + Profile files as directories & \compactfeatureref{profile-file-dirs} & No & No & Yes & Yes & Yes \\ @@ -555,6 +558,8 @@ EAPI 9 is EAPI 8 with the following changes: \begin{compactitem} \item Comments in profiles \t{parent} file, \featureref{parent-comments}. +\item Different default EAPI for profiles, \featureref{profile-eapi-default}. + \end{compactitem} \ChangeWhenAddingAnEAPI{9} diff --git a/profiles.tex b/profiles.tex index 6fa8a1c..de59f0a 100644 --- a/profiles.tex +++ b/profiles.tex @@ -50,8 +50,27 @@ this file must not contain comments or blank lines. A profile directory may contain an \t{eapi} file. This file, if it exists, must contain a single line with the name of an EAPI\@. This specifies the EAPI to use when handling the directory in question; a package manager must not attempt to use any profile using a directory which requires an -EAPI it does not support. If no \t{eapi} file is present, EAPI 0 shall be used. The EAPI is neither -inherited via the \t{parent} file nor in subdirectories. +EAPI it does not support. + +\featurelabel{profile-eapi-default} If no \t{eapi} file is present, the default depends on the EAPI +of the top-level profiles directory (see section~\ref{sec:profiles-dir}). That EAPI shall be used +if table~\ref{tab:profile-eapi-default} lists it as ``top-level''. Otherwise, EAPI 0 shall be used. + +The EAPI is neither inherited via the \t{parent} file nor in subdirectories. + +\ChangeWhenAddingAnEAPI{9} +\begin{centertable}{Default EAPI for profiles} +\label{tab:profile-eapi-default} +\begin{tabular}{ll} + \toprule + \multicolumn{1}{c}{\textbf{EAPI}} & + \multicolumn{1}{c}{\textbf{Default EAPI?}} \\ + \midrule + 0, 1, 2, 3, 4, 5, 6, 7, 8 & 0 \\ + 9 & Top-level \\ + \bottomrule +\end{tabular} +\end{centertable} \subsection{deprecated} If a profile contains a file named \t{deprecated}, it is treated as such. The first line of this
[gentoo-commits] proj/pms:eapi-9 commit in: /
commit: 71012f8641c7e0b43ffd71cf04512cdb0e4f48e4 Author: Ulrich Müller gentoo org> AuthorDate: Mon Feb 21 18:30:11 2022 + Commit: Ulrich Müller gentoo org> CommitDate: Mon Feb 21 18:30:11 2022 + URL:https://gitweb.gentoo.org/proj/pms.git/commit/?id=71012f86 EAPI 9 profile parent files can contain comments Bug: https://bugs.gentoo.org/470094 Signed-off-by: Ulrich Müller gentoo.org> eapi-differences.tex | 5 - profiles.tex | 20 +++- 2 files changed, 23 insertions(+), 2 deletions(-) diff --git a/eapi-differences.tex b/eapi-differences.tex index 893caf3..bb84b85 100644 --- a/eapi-differences.tex +++ b/eapi-differences.tex @@ -47,6 +47,9 @@ of this document for a complete table of previous EAPIs.} Less strict filenames in \t{updates} & \compactfeatureref{updates-filenames} & No & No & No & Yes & Yes \\ +Comments in profiles \t{parent} file & \compactfeatureref{parent-comments} & +No & No & No & No & Yes \\ + Profile files as directories & \compactfeatureref{profile-file-dirs} & No & No & Yes & Yes & Yes \\ @@ -551,7 +554,7 @@ EAPI 8 is EAPI 7 with the following changes: EAPI 9 is EAPI 8 with the following changes: \begin{compactitem} -\item None +\item Comments in profiles \t{parent} file, \featureref{parent-comments}. \end{compactitem} \ChangeWhenAddingAnEAPI{9} diff --git a/profiles.tex b/profiles.tex index 8d8226a..6fa8a1c 100644 --- a/profiles.tex +++ b/profiles.tex @@ -25,7 +25,25 @@ first, left to right, with duplicate parent paths being sourced for every time t It is illegal for a profile's parent tree to contain cycles. Package manager behaviour upon encountering a cycle is undefined. -This file must not contain comments, blank lines or make use of line continuations. +This file must not make use of line continuations. + +\featurelabel{parent-comments} For EAPIs listed in table~\ref{tab:profile-parent-comments} as +allowing comments, blank lines and lines beginning with a \t{\#} are discarded. For other EAPIs, +this file must not contain comments or blank lines. + +\ChangeWhenAddingAnEAPI{9} +\begin{centertable}{EAPIs allowing comments in \t{parent} file} +\label{tab:profile-parent-comments} +\begin{tabular}{ll} + \toprule + \multicolumn{1}{c}{\textbf{EAPI}} & + \multicolumn{1}{c}{\textbf{Allows comments?}} \\ + \midrule + 0, 1, 2, 3, 4, 5, 6, 7, 8 & No \\ + 9 & Yes \\ + \bottomrule +\end{tabular} +\end{centertable} \subsection{The eapi file} \label{sec:profile-eapi}
[gentoo-commits] proj/pms:eapi-9 commit in: /
commit: f5f8e42eeb8ea1e8c2ac182f30214ef0c559dd88 Author: Ulrich Müller gentoo org> AuthorDate: Sun Aug 29 08:10:29 2021 + Commit: Ulrich Müller gentoo org> CommitDate: Tue Aug 31 16:02:50 2021 + URL:https://gitweb.gentoo.org/proj/pms.git/commit/?id=f5f8e42e eclasses.tex: Clarify precedence of EXPORT_FUNCTIONS calls Clarify that the last call to EXPORT_FUNCTIONS takes precedence over earlier calls. Unfortunately, we need an exception when inherit is called after EXPORT_FUNCTIONS because Portage changed its behaviour in 2009: https://gitweb.gentoo.org/proj/portage.git/commit/?id=06d4433e8b8be60d606733b9e23f57f8a5869d8f Pkgcore and Paludis apply precedence consistently based on call order of EXPORT_FUNCTIONS. Bug: https://bugs.gentoo.org/399039 Bug: https://bugs.gentoo.org/422513 Signed-off-by: Ulrich Müller gentoo.org> eclasses.tex | 4 1 file changed, 4 insertions(+) diff --git a/eclasses.tex b/eclasses.tex index a92ce1f..e23dcd8 100644 --- a/eclasses.tex +++ b/eclasses.tex @@ -88,6 +88,10 @@ should the author wish to override it he can access the function in \t{foo.eclas \t{EXPORT_FUNCTIONS} must only be used on ebuild phase functions. The function that is aliased must be named \t{eclassname_phasefunctionname}, where \t{eclassname} is the name of the eclass. +If \t{EXPORT_FUNCTIONS} is called multiple times for the same phase function, the last call takes +precedence. Eclasses may not rely upon any particular behaviour if they inherit another eclass +after calling \t{EXPORT_FUNCTIONS}. + % vim: set filetype=tex fileencoding=utf8 et tw=100 spell spelllang=en : %%% Local Variables:
[gentoo-commits] proj/pms:eapi-9 commit in: /
commit: 5e39942107035115db4b383f99167f6c793c6c63 Author: Ulrich Müller gentoo org> AuthorDate: Tue Aug 3 16:34:08 2021 + Commit: Ulrich Müller gentoo org> CommitDate: Mon Feb 14 07:29:28 2022 + URL:https://gitweb.gentoo.org/proj/pms.git/commit/?id=5e399421 EAPI feature table: Consolidate EAPIs 0 to 5 Signed-off-by: Ulrich Müller gentoo.org> eapi-differences.tex | 224 +-- 1 file changed, 109 insertions(+), 115 deletions(-) diff --git a/eapi-differences.tex b/eapi-differences.tex index c75404b..893caf3 100644 --- a/eapi-differences.tex +++ b/eapi-differences.tex @@ -1,23 +1,22 @@ \chapter{Feature Availability by EAPI} \note{This chapter is informative and for convenience only. Refer to the main text for specifics. -For lack of space, EAPIs 0, 1, 2, 3, and~4 have been consolidated into a single column in the table -below; entries marked with an asterisk differ between these EAPIs. See the 2012-09-20 edition +For lack of space, EAPIs 0, 1, 2, 3, 4, and~5 have been consolidated into a single column in the +table below; entries marked with an asterisk differ between these EAPIs. See the 2012-09-20 edition of this document for a complete table of previous EAPIs.} % 2012-09-20 (EAPI 5) edition has a table of EAPIs 0 to 5 \ChangeWhenAddingAnEAPI{9} \begin{landscape} -\begin{longtable}{llP{7.5em}P{7.5em}P{7.5em}P{7.5em}P{7.5em}P{7.5em}} +\begin{longtable}{llP{7.5em}P{7.5em}P{7.5em}P{7.5em}P{7.5em}} \caption{Features in EAPIs}\\ \toprule \multicolumn{1}{c}{\textbf{Feature}} & \multicolumn{1}{c}{\textbf{Reference}} & -\multicolumn{6}{c}{\textbf{EAPIs}} \\ +\multicolumn{5}{c}{\textbf{EAPIs}} \\ \multicolumn{1}{c}{} & \multicolumn{1}{c}{} & -\multicolumn{1}{c}{0, 1, 2, 3, 4} & -\multicolumn{1}{c}{5} & +\multicolumn{1}{c}{0, 1, 2, 3, 4, 5} & \multicolumn{1}{c}{6} & \multicolumn{1}{c}{7} & \multicolumn{1}{c}{8} & @@ -27,11 +26,10 @@ of this document for a complete table of previous EAPIs.} \midrule \multicolumn{1}{c}{\textbf{Feature}} & \multicolumn{1}{c}{\textbf{Reference}} & -\multicolumn{6}{c}{\textbf{EAPIs}} \\ +\multicolumn{5}{c}{\textbf{EAPIs}} \\ \multicolumn{1}{c}{} & \multicolumn{1}{c}{} & -\multicolumn{1}{c}{0, 1, 2, 3, 4} & -\multicolumn{1}{c}{5} & +\multicolumn{1}{c}{0, 1, 2, 3, 4, 5} & \multicolumn{1}{c}{6} & \multicolumn{1}{c}{7} & \multicolumn{1}{c}{8} & @@ -44,105 +42,104 @@ of this document for a complete table of previous EAPIs.} \endlastfoot \t{package.mask} directory & \compactfeatureref{package-mask-dir} & -No & No & No & Yes & Yes & Yes \\ +No & No & Yes & Yes & Yes \\ Less strict filenames in \t{updates} & \compactfeatureref{updates-filenames} & -No & No & No & No & Yes & Yes \\ +No & No & No & Yes & Yes \\ Profile files as directories & \compactfeatureref{profile-file-dirs} & -No & No & No & Yes & Yes & Yes \\ +No & No & Yes & Yes & Yes \\ \t{package.provided} & \compactfeatureref{package-provided} & -Optional & Optional & Optional & No & No & No \\ +Optional & Optional & No & No & No \\ Stable use masking/forcing & \compactfeatureref{stablemask} & -No & Yes & Yes & Yes & Yes & Yes \\ +* & Yes & Yes & Yes & Yes \\ Bash version & \compactfeatureref{bash-version} & -3.2 & 3.2 & 4.2 & 4.2 & 5.0 & 5.0 \\ +3.2 & 4.2 & 4.2 & 5.0 & 5.0 \\ \t{failglob} in global scope & \compactfeatureref{failglob} & -No & No & Yes & Yes & Yes & Yes \\ +No & Yes & Yes & Yes & Yes \\ \t{IUSE} defaults & \compactfeatureref{iuse-defaults} & -* & Yes & Yes & Yes & Yes & Yes \\ +* & Yes & Yes & Yes & Yes \\ \t{REQUIRED_USE} & \compactfeatureref{required-use} & -* & Yes & Yes & Yes & Yes & Yes \\ +* & Yes & Yes & Yes & Yes \\ \t{PROPERTIES} & \compactfeatureref{properties} & -* & Yes & Yes & Yes & Yes & Yes \\ +* & Yes & Yes & Yes & Yes \\ \t{SRC_URI} arrows & \compactfeatureref{src-uri-arrows} & -* & Yes & Yes & Yes & Yes & Yes \\ +* & Yes & Yes & Yes & Yes \\ Selective URI restrictions & \compactfeatureref{uri-restrict} & -No & No & No & No & Yes & Yes \\ +No & No & No & Yes & Yes \\ \t{RDEPEND=DEPEND} & \compactfeatureref{rdepend-depend} & -* & No & No & No & No & No \\ +* & No & No & No & No \\ \t{DEFINED_PHASES} & \compactfeatureref{defined-phases} & -* & Yes & Yes & Yes & Yes & Yes \\ +* & Yes & Yes & Yes & Yes \\ \t{BDEPEND} & \compactfeatureref{bdepend} & -No & No & No & Yes & Yes & Yes \\ +No & No & Yes & Yes & Yes \\ \t{IDEPEND} & \compactfeatureref{idepend} & -No & No & No & No & Yes & Yes \\ +No & No & No & Yes & Yes \\ \t{??\ ( )} groups & \compactfeatureref{at-most-one-of} & -No & Yes & Yes & Yes & Yes & Yes \\ +* & Yes & Yes & Yes & Yes \\ Empty \t{||}, \t{\textasciicircum\textasciicircum} groups match & \compactfeatureref{empty-dep-groups} & -Yes & Yes & Yes & No & No & No \\ +Yes & Yes & No &
[gentoo-commits] proj/pms:eapi-9 commit in: /
commit: a332194c099b2b367bf1d78b3aeee43c984cfb68 Author: Ulrich Müller gentoo org> AuthorDate: Tue Aug 3 16:32:47 2021 + Commit: Ulrich Müller gentoo org> CommitDate: Mon Feb 14 07:29:28 2022 + URL:https://gitweb.gentoo.org/proj/pms.git/commit/?id=a332194c Add an EAPI 9 identical to EAPI 8 Signed-off-by: Ulrich Müller gentoo.org> commands.tex | 4 +- dependencies.tex | 26 +++--- eapi-differences.tex | 231 +++--- eapis.tex | 4 +- ebuild-env-vars.tex | 26 +++--- ebuild-format.tex | 4 +- ebuild-functions.tex | 46 +- ebuild-vars.tex | 22 ++--- eclasses.tex | 4 +- merge.tex | 6 +- pkg-mgr-commands.tex | 100 +++--- pms.tex | 4 +- profile-variables.tex | 8 +- profiles.tex | 12 +-- tree-layout.tex | 8 +- 15 files changed, 260 insertions(+), 245 deletions(-) diff --git a/commands.tex b/commands.tex index d0ad87d..c6f4f36 100644 --- a/commands.tex +++ b/commands.tex @@ -33,7 +33,7 @@ The following commands must always be available in the ebuild environment: table~\ref{tab:system-commands-table} as requiring GNU find. \end{compactitem} -\ChangeWhenAddingAnEAPI{8} +\ChangeWhenAddingAnEAPI{9} \begin{centertable}{System commands for EAPIs} \label{tab:system-commands-table} \begin{tabular}{lll} @@ -44,7 +44,7 @@ The following commands must always be available in the ebuild environment: \midrule 0, 1, 2, 3, 4 & Undefined & Any \\ 5, 6 & Yes & Any \\ - 7, 8 & Yes & 2.7 \\ + 7, 8, 9 & Yes & 2.7 \\ \bottomrule \end{tabular} \end{centertable} diff --git a/dependencies.tex b/dependencies.tex index f14a08c..de6e752 100644 --- a/dependencies.tex +++ b/dependencies.tex @@ -88,7 +88,7 @@ with the native build system (\t{CBUILD}). Ebuilds are allowed to call them in \ \t{pkg_postinst}. Ebuilds may also call them in \t{pkg_prerm} and \t{pkg_postrm} but must not rely on them being available. -\ChangeWhenAddingAnEAPI{8} +\ChangeWhenAddingAnEAPI{9} \begin{centertable}{EAPIs supporting additional dependency types} \label{tab:depend-table} \begin{tabular}{lll} @@ -99,7 +99,7 @@ on them being available. \midrule 0, 1, 2, 3, 4, 5, 6 & No & No \\ 7 & Yes & No \\ - 8 & Yes & Yes \\ + 8, 9& Yes & Yes \\ \bottomrule \end{tabular} \end{centertable} @@ -155,7 +155,7 @@ be surrounded on both sides by whitespace, except at the start and end of the st In particular, note that whitespace is not optional. -\ChangeWhenAddingAnEAPI{8} +\ChangeWhenAddingAnEAPI{9} \begin{centertable}{EAPIs supporting \t{REQUIRED_USE ??}\ groups} \label{tab:at-most-one-of-table} \begin{tabular}{ll} @@ -164,7 +164,7 @@ In particular, note that whitespace is not optional. \multicolumn{1}{c}{\textbf{Supports \t{REQUIRED_USE ??}\ groups?}} \\ \midrule 0, 1, 2, 3, 4 & No \\ - 5, 6, 7, 8& Yes \\ + 5, 6, 7, 8, 9 & Yes \\ \bottomrule \end{tabular} \end{centertable} @@ -204,7 +204,7 @@ In an exactly-one-of group, exactly one immediate child element must be matched. In EAPIs specified in table~\ref{tab:empty-dep-groups}, an empty exactly-one-of group counts as being matched. -\ChangeWhenAddingAnEAPI{8} +\ChangeWhenAddingAnEAPI{9} \begin{centertable}{Matching of empty dependency groups in EAPIs} \label{tab:empty-dep-groups} \begin{tabular}{ll} @@ -214,7 +214,7 @@ being matched. are matched?}} \\ \midrule 0, 1, 2, 3, 4, 5, 6 & Yes \\ - 7, 8& No \\ + 7, 8, 9 & No \\ \bottomrule \end{tabular} \end{centertable} @@ -250,7 +250,7 @@ manager must warn or error if this feature is used with an EAPI not supporting u \note{Order is important. The slot restriction must come before use dependencies.} -\ChangeWhenAddingAnEAPI{8} +\ChangeWhenAddingAnEAPI{9} \begin{centertable}{Support for \t{SLOT} dependencies and sub-slots in EAPIs} \label{tab:slot-deps-table} \begin{tabular}{lll} @@ -261,12 +261,12 @@ manager must warn or error if this feature is used with an EAPI not supporting u \midrule 0 & No & No \\ 1, 2, 3, 4& Named only & No \\ - 5, 6, 7, 8& Named and operator & Yes \\ + 5, 6, 7, 8, 9 & Named and operator & Yes \\ \bottomrule \end{tabular} \end{centertable} -\ChangeWhenAddingAnEAPI{8} +\ChangeWhenAddingAnEAPI{9} \begin{centertable}{EAPIs supporting \t{USE} dependencies} \label{tab:use-deps-table} \begin{tabular}{ll} @@ -276,7 +276,7 @@ manager must warn or error if this feature is used with an EAPI not supporting u
[gentoo-commits] proj/pms:eapi-9 commit in: /
commit: 823cc48478a0bb108baa03f0e33e5f77824e5db2 Author: Ulrich Müller gentoo org> AuthorDate: Fri Sep 3 15:24:25 2021 + Commit: Ulrich Müller gentoo org> CommitDate: Fri Sep 3 15:24:25 2021 + URL:https://gitweb.gentoo.org/proj/pms.git/commit/?id=823cc484 eapi-cheatsheet.tex: Delete trailing whitespace Signed-off-by: Ulrich Müller gentoo.org> eapi-cheatsheet.tex | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/eapi-cheatsheet.tex b/eapi-cheatsheet.tex index c333b32..8c379bc 100644 --- a/eapi-cheatsheet.tex +++ b/eapi-cheatsheet.tex @@ -556,7 +556,7 @@ differences between these previous EAPIs. to configure, respectively. See \featureref{econf-options}. \item[\code{dosym}] With the new option \code{-r}, an absolute path specified for the link target will be converted to a path -relative to the link location. See \featureref{dosym-relative}. +relative to the link location. See \featureref{dosym-relative}. \item[\code{insopts}] Commands \code{doconfd}, \code{doenvd}, \code{doheader} install files with fixed mode 0644, i.\,e.\ they are no longer affected by \code{insopts}.
[gentoo-commits] proj/pms:eapi-9 commit in: /
commit: e68df128f8cd3b427168f9a76a655460766e6d70 Author: Ulrich Müller gentoo org> AuthorDate: Tue Aug 31 16:05:08 2021 + Commit: Ulrich Müller gentoo org> CommitDate: Tue Aug 31 16:05:08 2021 + URL:https://gitweb.gentoo.org/proj/pms.git/commit/?id=e68df128 pkg-mgr-commands.tex: Update description of text list functions Closes: https://bugs.gentoo.org/374791 Signed-off-by: Ulrich Müller gentoo.org> pkg-mgr-commands.tex | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pkg-mgr-commands.tex b/pkg-mgr-commands.tex index 4431435..331cd33 100644 --- a/pkg-mgr-commands.tex +++ b/pkg-mgr-commands.tex @@ -1016,7 +1016,7 @@ table~\ref{tab:use-list-strictness}. \end{centertable} \subsection{Text list functions} -These functions check whitespace-separated lists for a particular value. +These functions check a list of arguments for a particular value. \nobreakpar \begin{description} \item[has] Returns shell true (0) if the first argument (a word) is found in the list of subsequent
[gentoo-commits] proj/pms:eapi-9 commit in: /
commit: 0d8e19d85038ad2433e655cdbca8189d72163f60 Author: Ulrich Müller gentoo org> AuthorDate: Fri Sep 3 15:23:57 2021 + Commit: Ulrich Müller gentoo org> CommitDate: Fri Sep 3 15:23:57 2021 + URL:https://gitweb.gentoo.org/proj/pms.git/commit/?id=0d8e19d8 ebuild-env-vars.tex: Add missing \\ in table Signed-off-by: Ulrich Müller gentoo.org> ebuild-env-vars.tex | 8 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/ebuild-env-vars.tex b/ebuild-env-vars.tex index b52f0b3..a55c366 100644 --- a/ebuild-env-vars.tex +++ b/ebuild-env-vars.tex @@ -256,10 +256,10 @@ variable. \t{REPLACED_BY_VERSION} & \t{pkg_prerm}, \t{pkg_postrm} & Yes & -The single version of this package (including revision, if specified) that is replacing us, if -we are being uninstalled as part of an install, or an empty string otherwise. See -section~\ref{sec:replacing-versions}. Only for EAPIs listed in table~\ref{tab:added-env-vars-table} -as supporting \t{REPLACED_BY_VERSION}. +The single version of this package (including revision, if specified) that is replacing us, +if we are being uninstalled as part of an install, or an empty string otherwise. +See section~\ref{sec:replacing-versions}. Only for EAPIs listed in +table~\ref{tab:added-env-vars-table} as supporting \t{REPLACED_BY_VERSION}. \\ \end{longtable} \end{landscape}
[gentoo-commits] proj/pms:eapi-9 commit in: /
commit: 153324136107543ef07b1378f08bce81199a9022 Author: Ulrich Müller gentoo org> AuthorDate: Mon Aug 30 19:32:16 2021 + Commit: Ulrich Müller gentoo org> CommitDate: Tue Aug 31 16:05:50 2021 + URL:https://gitweb.gentoo.org/proj/pms.git/commit/?id=15332413 pkg-mgr-commands.tex: Clarify which commands are allowed in global scope For most commands this is already implied by the combination of the statements "When an ebuild is being sourced for metadata querying rather than for a build [...], no external command may be executed." in chapter 12 ("Available Commands") and "Except where otherwise noted, they may be internal [...] or external commands available in PATH; where this is not specified, ebuilds may not rely upon either behaviour." in section 12.3 ("Ebuild-specific Commands"). For output commands (einfo etc.) and debug commands (debug-print etc.) to be allowed in global scope, they must be implemented as shell functions. Specify this, which follows the implementation in all three package managers. Closes: https://bugs.gentoo.org/520528 Signed-off-by: Ulrich Müller gentoo.org> pkg-mgr-commands.tex | 20 1 file changed, 12 insertions(+), 8 deletions(-) diff --git a/pkg-mgr-commands.tex b/pkg-mgr-commands.tex index 331cd33..ebb4b7e 100644 --- a/pkg-mgr-commands.tex +++ b/pkg-mgr-commands.tex @@ -4,7 +4,8 @@ The following commands will always be available in the ebuild environment, provided by the package manager. Except where otherwise noted, they may be internal (shell functions or aliases) or external commands available in \t{PATH}; where this is not specified, ebuilds may not rely upon either -behaviour. +behaviour. Unless otherwise specified, it is an error if an ebuild calls any of these commands in +global scope. Unless otherwise noted, any output of these commands ends with a newline. @@ -142,8 +143,9 @@ are given, \t{-r} is assumed. These commands display messages to the user. Unless otherwise stated, the entire argument list is used as a message, with backslash-escaped characters interpreted as for the \t{echo -e} command of bash, notably \t{\textbackslash t} for a horizontal tab, \t{\textbackslash n} for a new line, and -\t{\textbackslash\textbackslash} for a literal backslash. Ebuilds must not run any of these commands -once the current phase function has returned. +\t{\textbackslash\textbackslash} for a literal backslash. These commands must be implemented +internally as shell functions and may be called in global scope. Ebuilds must not run any of these +commands once the current phase function has returned. \featurelabel{output-no-stdout} Unless otherwise noted, output may be sent to stderr or some other appropriate facility. In EAPIs listed in table~\ref{tab:output-commands} as not allowing stdout @@ -927,8 +929,7 @@ any of these functions from any other phase. \subsection{USE list functions} These functions provide behaviour based upon set or unset use flags. Ebuilds must not run any of -these commands once the current phase function has returned. It is an error if an ebuild calls any -of these functions in global scope. +these commands once the current phase function has returned. Unless otherwise noted, if any of these functions is called with a flag value that is not included in \t{IUSE_EFFECTIVE}, either behaviour is undefined or it is an error as decided by @@ -1016,7 +1017,8 @@ table~\ref{tab:use-list-strictness}. \end{centertable} \subsection{Text list functions} -These functions check a list of arguments for a particular value. +These functions check a list of arguments for a particular value. They must be implemented +internally as shell functions and may be called in global scope. \nobreakpar \begin{description} \item[has] Returns shell true (0) if the first argument (a word) is found in the list of subsequent @@ -1261,8 +1263,9 @@ has returned. \end{algorithm} \item[get_libdir] \featurelabel{get-libdir} Prints the libdir name obtained according to -algorithm~\ref{alg:get-libdir}. Must be implemented internally as a shell function. -Only available in EAPIs listed in table~\ref{tab:misc-commands} as supporting \t{get_libdir}. +algorithm~\ref{alg:get-libdir}. Must be implemented internally as a shell function and may be +called in global scope. Only available in EAPIs listed in table~\ref{tab:misc-commands} as +supporting \t{get_libdir}. \begin{algorithm} \caption{\t{get_libdir} logic} \label{alg:get-libdir} @@ -1300,6 +1303,7 @@ has returned. \subsection{Debug commands} The following commands are available for debugging. Normally all of these commands should be no ops; a package manager may provide a special debug mode where these commands instead do something. +These commands must be implemented internally as shell functions and may be called in global scope. Ebuilds must not run any of these commands once the current phase
[gentoo-commits] proj/pms:eapi-9 commit in: /
commit: b02e81a59e6a31198a3d023003144cc3938bbc02 Author: Ulrich Müller gentoo org> AuthorDate: Wed Aug 18 16:19:36 2021 + Commit: Ulrich Müller gentoo org> CommitDate: Wed Aug 18 16:19:36 2021 + URL:https://gitweb.gentoo.org/proj/pms.git/commit/?id=b02e81a5 desk-reference.tex: Include the cheat sheet from a separate file The desk reference (cheat sheet) is an own chapter. For consistency, include it from a separate file, and prefix its label with "ch:". Signed-off-by: Ulrich Müller gentoo.org> desk-reference.tex | 21 + pms.tex| 10 +- 2 files changed, 22 insertions(+), 9 deletions(-) diff --git a/desk-reference.tex b/desk-reference.tex new file mode 100644 index 000..a096032 --- /dev/null +++ b/desk-reference.tex @@ -0,0 +1,21 @@ +\ifthenelse{\boolean{TEX4HT-HACKS}}{% +\chapter{Desk Reference} +\label{ch:cheatsheet} +\href{eapi-cheatsheet.pdf}{EAPI Cheat Sheet} +}{% +% Make sure that the cheat sheet starts on an odd page +\ifthenelse{\isodd{\thepage}}{}{\null\newpage}% +\includepdf[pages=-,landscape,turn=false,lastpage=2,% +addtotoc={1,chapter,0,Desk Reference,ch:cheatsheet}]{eapi-cheatsheet} +} + +% vim: set filetype=tex fileencoding=utf8 et tw=100 spell spelllang=en : + +%%% Local Variables: +%%% mode: latex +%%% TeX-master: "pms" +%%% LaTeX-indent-level: 4 +%%% LaTeX-item-indent: 0 +%%% TeX-brace-indent-level: 4 +%%% fill-column: 100 +%%% End: diff --git a/pms.tex b/pms.tex index 8bbd037..e0a41b5 100644 --- a/pms.tex +++ b/pms.tex @@ -85,15 +85,7 @@ \include{eapi-differences} -\ifthenelse{\boolean{TEX4HT-HACKS}}{% -\chapter{Desk Reference} -\href{eapi-cheatsheet.pdf}{EAPI Cheat Sheet} -}{% -% Make sure that the cheat sheet starts on an odd page -\clearpage\ifthenelse{\isodd{\thepage}}{}{\null\newpage}% -\includepdf[pages=-,landscape,turn=false,lastpage=2,% -addtotoc={1,chapter,0,Desk Reference,cheatsheet}]{eapi-cheatsheet} -} +\include{desk-reference} \end{document}
[gentoo-commits] proj/pms:eapi-9 commit in: /
commit: 09bb58f347eef04cf9c29c7158beb1b04e645c75 Author: Ulrich Müller gentoo org> AuthorDate: Wed Aug 18 16:04:59 2021 + Commit: Ulrich Müller gentoo org> CommitDate: Wed Aug 18 16:04:59 2021 + URL:https://gitweb.gentoo.org/proj/pms.git/commit/?id=09bb58f3 pms.cls: Output class info after packages are loaded Signed-off-by: Ulrich Müller gentoo.org> pms.cls | 24 1 file changed, 12 insertions(+), 12 deletions(-) diff --git a/pms.cls b/pms.cls index a41d96c..b29a9c3 100644 --- a/pms.cls +++ b/pms.cls @@ -47,18 +47,6 @@ gitinfo2% Metadata from git } -% tex4ht workaround: hyperref needs to be loaded /after/ tex4ht injects itself -\g@addto@macro\@documentclasshook{ -\RequirePackage{% -hyperref, % Support for hyperlinks -algorithm, % -algorithmic % Set algorithms -} -} - -\ClassInfo{pms}{Capsulation of LaTeX stuff for the Package Manager -Specification, loaded baseclass: \ClassToLoad\MessageBreak} - % Make processing with TeX4HT possible \newboolean{TEX4HT-HACKS} \ifx\HCode\undefined @@ -72,6 +60,18 @@ \setboolean{TEX4HT-HACKS}{true} \fi +% tex4ht workaround: hyperref needs to be loaded /after/ tex4ht injects itself +\g@addto@macro\@documentclasshook{ +\RequirePackage{% +hyperref, % Support for hyperlinks +algorithm, % +algorithmic % Set algorithms +} +} + +\ClassInfo{pms}{LaTeX class for the Package Manager Specification, +loaded baseclass: \ClassToLoad\MessageBreak} + % Define own label and reference commands, that display the label in % the page margin. \ifthenelse{\boolean{TEX4HT-HACKS}}{%
[gentoo-commits] proj/pms:eapi-9 commit in: /
commit: edae70c9cc4b936670151088e9e97c51331b6440 Author: Ulrich Müller gentoo org> AuthorDate: Tue Aug 17 11:45:08 2021 + Commit: Ulrich Müller gentoo org> CommitDate: Tue Aug 17 11:45:08 2021 + URL:https://gitweb.gentoo.org/proj/pms.git/commit/?id=edae70c9 profiles.tex: Don't use \verb Signed-off-by: Ulrich Müller gentoo.org> profiles.tex | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/profiles.tex b/profiles.tex index d6e8649..30da81b 100644 --- a/profiles.tex +++ b/profiles.tex @@ -49,7 +49,7 @@ This file must not contain comments or make use of line continuations. This file is unusual in that it is not combined at a file level with the parent---instead, each variable is combined or overridden individually as described in section~\ref{sec:profile-variables}. -The file itself is a line-based key-value format. Each line contains a single \verb|VAR="value"| +The file itself is a line-based key-value format. Each line contains a single \t{VAR="value"} entry, where the value must be double quoted. A variable name must start with one of \t{a-zA-Z} and may contain \t{a-zA-Z0-9_} only. Additional syntax, which is a small subset of bash syntax, is allowed as follows:
[gentoo-commits] proj/pms:eapi-9 commit in: /
commit: 8ce3a9c94407c8bfcf27c8455fac32d3a38fc981 Author: Ulrich Müller gentoo org> AuthorDate: Fri Sep 24 12:12:38 2021 + Commit: Ulrich Müller gentoo org> CommitDate: Fri Sep 24 13:06:45 2021 + URL:https://gitweb.gentoo.org/proj/pms.git/commit/?id=8ce3a9c9 pkg-mgr-commands.tex: Update condition for econf --disable-static The help message produced by LT_INIT in libtool-2.4.6 always says --enable-static regardless of the default value, see m4/ltoptions.m4: AC_ARG_ENABLE([static], [AS_HELP_STRING([--enable-static@<:@=PKGS@:>@], [build static libraries @<:@default=]_LT_ENABLE_STATIC_DEFAULT[@:>@])], ...) This means that looking only for --disable-static in output of configure --help results in non-functional behaviour. Implementation in Portage (which predates the PMS wording) looks for --enable-static in addition. Bug: https://bugs.gentoo.org/814368 Signed-off-by: Ulrich Müller gentoo.org> pkg-mgr-commands.tex | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/pkg-mgr-commands.tex b/pkg-mgr-commands.tex index ebb4b7e..45706af 100644 --- a/pkg-mgr-commands.tex +++ b/pkg-mgr-commands.tex @@ -341,8 +341,8 @@ commands once the current phase function has returned. as using it. This option will only be passed if the string \t{-{}-disable-silent-rules} occurs in the output of \t{configure -{}-help}. \item \t{-{}-disable-static}, if the EAPI is listed in table~\ref{tab:econf-options-table} -as using it. This option will only be passed if the string \t{-{}-disable-static} occurs -in the output of \t{configure -{}-help}. +as using it. This option will only be passed if the string \t{-{}-disable-static} or +\t{-{}-enable-static} occurs in the output of \t{configure -{}-help}. \end{itemize} \ChangeWhenAddingAnEAPI{8}
[gentoo-commits] proj/pms:eapi-9 commit in: /
commit: 3c246ad9dd49c23f87ec12fc859ffd76cf2ca9f1 Author: Ulrich Müller gentoo org> AuthorDate: Wed Aug 18 16:21:41 2021 + Commit: Ulrich Müller gentoo org> CommitDate: Wed Aug 18 16:21:41 2021 + URL:https://gitweb.gentoo.org/proj/pms.git/commit/?id=3c246ad9 pms.tex: Delete some empty lines Signed-off-by: Ulrich Müller gentoo.org> pms.tex | 17 - 1 file changed, 17 deletions(-) diff --git a/pms.tex b/pms.tex index e0a41b5..630fc16 100644 --- a/pms.tex +++ b/pms.tex @@ -47,44 +47,27 @@ \listoftables \include{introduction} - \include{eapis} - \include{names} - \include{tree-layout} - \include{profiles} - \include{ebuild-format} - \include{ebuild-vars} - \include{dependencies} - \include{ebuild-functions} - \include{eclasses} - \include{ebuild-environment} - \include{commands} - \include{merge} - \include{metadata-cache} - \include{glossary} \bibliography{pms} \appendix \setcounter{secnumdepth}{0} - \include{appendices} - \include{eapi-differences} - \include{desk-reference} \end{document}
[gentoo-commits] proj/pms:eapi-9 commit in: /
commit: 140aac7de90b44e7a14b4f5aaf5952911ad074ea Author: Ulrich Müller gentoo org> AuthorDate: Wed Aug 4 10:10:59 2021 + Commit: Ulrich Müller gentoo org> CommitDate: Wed Aug 4 10:10:59 2021 + URL:https://gitweb.gentoo.org/proj/pms.git/commit/?id=140aac7d pkg-mgr-commands.tex: Fix econf --libdir logic Portage uses both --exec-prefix and --prefix in its econf logic, introduced in 2005: https://gitweb.gentoo.org/archive/proj/portage-cvs.git/commit/?h=portage_2_0=865508e5cb2fd3e6ef7c312b6a7bb88cf8799f9c Pkgcore agrees with Portage. Paludis uses --prefix first, then --exec-prefix. Closes: https://bugs.gentoo.org/806374 Signed-off-by: Ulrich Müller gentoo.org> pkg-mgr-commands.tex | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/pkg-mgr-commands.tex b/pkg-mgr-commands.tex index 0a34db9..4431435 100644 --- a/pkg-mgr-commands.tex +++ b/pkg-mgr-commands.tex @@ -386,7 +386,9 @@ commands once the current phase function has returned. \caption{\t{econf -{}-libdir} logic} \label{alg:econf-libdir} \begin{algorithmic}[1] \STATE let prefix=\$\{EPREFIX\}/usr -\IF{the caller specified -{}-prefix=\$p} +\IF{the caller specified -{}-exec-prefix=\$ep} +\STATE let prefix=\$ep +\ELSIF{the caller specified -{}-prefix=\$p} \STATE let prefix=\$p \ENDIF \STATE let libdir=
[gentoo-commits] proj/pms:eapi-9 commit in: /
commit: 88bd72dfbce9d889f9cf865cac72f26a06e8914e Author: Ulrich Müller gentoo org> AuthorDate: Sun Aug 15 12:14:44 2021 + Commit: Ulrich Müller gentoo org> CommitDate: Sun Aug 15 12:14:44 2021 + URL:https://gitweb.gentoo.org/proj/pms.git/commit/?id=88bd72df eapi-cheatsheet.tex: Define \i and \t commands These occur in external aux files used with the xr-hyper package and would normally cause an "undefined control sequence" error. The problem was hidden by LaTeX using its internal \i and \t macros instead. Signed-off-by: Ulrich Müller gentoo.org> eapi-cheatsheet.tex | 4 1 file changed, 4 insertions(+) diff --git a/eapi-cheatsheet.tex b/eapi-cheatsheet.tex index c5e795d..c333b32 100644 --- a/eapi-cheatsheet.tex +++ b/eapi-cheatsheet.tex @@ -19,6 +19,10 @@ \newcommand{\featureref}[1]{\textsc{#1} on page~\pageref{feat:#1}} \renewcommand{\familydefault}{\sfdefault} \urlstyle{sf} + +% These commands may occur in external aux files from pms +\renewcommand{\i}[1]{\textit{#1}} +\renewcommand{\t}[1]{\texttt{#1}} \externaldocument{pms} \title{EAPI Cheat Sheet}