[gentoo-commits] proj/pms:eapi-5 commit in: /

["Ulrich Mueller" <ulm@gentoo.org>]

commit:     5d6749ac9e5ddc5b1daaad7737b65fa81c6ece47
Author:     Zac Medico <zmedico <AT> gentoo <DOT> org>
AuthorDate: Thu Aug 16 05:15:05 2012 +0000
Commit:     Ulrich Mueller <ulm <AT> gentoo <DOT> org>
CommitDate: Fri Aug 17 06:49:17 2012 +0000
URL:        http://git.overlays.gentoo.org/gitweb/?p=proj/pms.git;a=commit;h=5d6749ac

Extend slot-operator-deps with sub-slot support

---
 dependencies.tex     |   40 +++++++++++++++++++++++++---------------
 eapi-differences.tex |    1 +
 ebuild-vars.tex      |    8 ++++++++
 3 files changed, 34 insertions(+), 15 deletions(-)

diff --git a/dependencies.tex b/dependencies.tex
index 1e5b6e8..47c0261 100644
--- a/dependencies.tex
+++ b/dependencies.tex
@@ -184,18 +184,20 @@ 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{5}
-\begin{centertable}{EAPIs supporting \t{SLOT} dependencies} \label{tab:slot-deps-table}
-    \begin{tabular}{ l l }
+\begin{centertable}{Support for \t{SLOT} dependencies and sub-slots in EAPIs}
+    \label{tab:slot-deps-table}
+    \begin{tabular}{ l l l }
         \toprule
             \multicolumn{1}{c}{\textbf{EAPI}} &
-            \multicolumn{1}{c}{\textbf{Supports \t{SLOT} dependencies?}} \\
+            \multicolumn{1}{c}{\textbf{Supports \t{SLOT} dependencies?}} &
+            \multicolumn{1}{c}{\textbf{Supports sub-slots?}} \\
             \midrule
-    \t{0} & No \\
-    \t{1} & Named only \\
-    \t{2} & Named only \\
-    \t{3} & Named only \\
-    \t{4} & Named only \\
-    \t{5} & Named and operator \\
+    \t{0} & No & No \\
+    \t{1} & Named only & No \\
+    \t{2} & Named only & No \\
+    \t{3} & Named only & No \\
+    \t{4} & Named only & No \\
+    \t{5} & Named and operator & Yes \\
     \bottomrule
     \end{tabular}
 \end{centertable}
@@ -278,6 +280,10 @@ specification with a named slot dependency matches only if the slot of the match
 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.
 
+\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
+delimited by a \t{/} character.
+
 \featurelabel{slot-operator-deps} An operator slot dependency consists of a colon followed by one of
 the following operators:
 
@@ -286,14 +292,18 @@ the following operators:
 indicates that the package will not break if the matched package is uninstalled and replaced by
 a different matching package in a different slot.
 \item[=] Indicates that any slot value is acceptable. In addition, for runtime dependencies,
-indicates that the package will break unless a matching package with slot equal to the slot of
-the best installed version at the time the package was installed is available.
+indicates that the package will break unless a matching package with slot and sub-slot equal to the
+slot and sub-slot of the best installed version at the time the package was installed is available.
+\item[slot=] Indicates that only a specific slot value is acceptable, and otherwise behaves
+identically to the plain equals slot operator.
 \end{description}
 
-To implement the equals slot operator, the package manager will need to store the slot of the
-best installed version of the matching package. The package manager may do this by appending
-the appropriate slot after the equals sign when saving the package's dependencies. This syntax
-is only for package manager use and must not be used by ebuilds.
+To implement the equals slot operator, the package manager will need to store the slot/sub-slot
+pair of the best installed version of the matching package. This syntax is only for package manager
+use and must not be used by ebuilds. The package manager may do this by inserting the appropriate
+slot/sub-slot pair between the colon and equals sign when saving the package's dependencies. The
+sub-slot part must not be omitted here (when the SLOT variable omits the sub-slot part, the package
+is considered to have an implicit sub-slot which is equal to the regular slot).
 
 \subsubsection{2-Style and 4-Style Use Dependencies}
 \label{sec:use-dep}

diff --git a/eapi-differences.tex b/eapi-differences.tex
index 748e2b4..f35afc9 100644
--- a/eapi-differences.tex
+++ b/eapi-differences.tex
@@ -280,6 +280,7 @@ EAPI 5 is EAPI 4 with the following changes:
 \item \t{USE} is calculated differently, \featureref{profile-iuse-injection}.
 \item \t{IMAGE} is gone, \featureref{image}.
 \item \t{REQUIRED\_USE} now supports \t{??} groups, \featureref{at-most-one-of}.
+\item \t{SLOT} now supports an optional sub-slot part, \featureref{sub-slot}.
 \item \t{apply\_user\_patches} function, with \t{src\_prepare} changes,
     \featureref{apply-user-patches}.
 \item \t{EBUILD\_PHASE\_FUNC}, \featureref{ebuild-phase-func}.

diff --git a/ebuild-vars.tex b/ebuild-vars.tex
index 01d2393..53de53d 100644
--- a/ebuild-vars.tex
+++ b/ebuild-vars.tex
@@ -29,6 +29,14 @@ All ebuilds must define at least the following variables:
     eclass. Must not be empty.
 \item[SLOT] The package's slot. Must be a valid slot name, as per section~\ref{sec:slot-names}.
     May be defined by an eclass. Must not be empty.
+
+    In EAPIs shown in table~\ref{tab:slot-deps-table} as supporting sub-slots, the \t{SLOT} variable
+    may contain an optional sub-slot part that follows the regular slot and is delimited by a \t{/}
+    character. The sub-slot must be a valid slot name, as per section~\ref{sec:slot-names}.
+    The sub-slot is used to represent cases in which an upgrade to a new version of a package with
+    a different sub-slot may require dependent packages to be rebuilt. When the sub-slot part is
+    omitted from the \t{SLOT} definition, the package is considered to have an implicit sub-slot
+    which is equal to the regular slot.
 \end{description}
 
 \section{Optional Ebuild-defined Variables}