From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from pigeon.gentoo.org ([208.92.234.80] helo=lists.gentoo.org) by finch.gentoo.org with esmtp (Exim 4.60) (envelope-from ) id 1SUzQC-00079t-AX for garchives@archives.gentoo.org; Thu, 17 May 2012 12:03:09 +0000 Received: from pigeon.gentoo.org (localhost [127.0.0.1]) by pigeon.gentoo.org (Postfix) with SMTP id 2BE88E0921; Thu, 17 May 2012 12:02:26 +0000 (UTC) Received: from smtp.gentoo.org (smtp.gentoo.org [140.211.166.183]) by pigeon.gentoo.org (Postfix) with ESMTP id DD369E0913 for ; Thu, 17 May 2012 12:02:25 +0000 (UTC) Received: from hornbill.gentoo.org (hornbill.gentoo.org [94.100.119.163]) (using TLSv1 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by smtp.gentoo.org (Postfix) with ESMTPS id 2B0B91B4035 for ; Thu, 17 May 2012 12:02:25 +0000 (UTC) Received: from localhost.localdomain (localhost [127.0.0.1]) by hornbill.gentoo.org (Postfix) with ESMTP id E8406E5429 for ; Thu, 17 May 2012 12:02:23 +0000 (UTC) From: "Ulrich Mueller" To: gentoo-commits@lists.gentoo.org Content-type: text/plain; charset=UTF-8 Reply-To: gentoo-dev@lists.gentoo.org, "Ulrich Mueller" Message-ID: <1337250689.4630becfa4c792b96ddd2949536a8ccdba77ec91.ulm@gentoo> Subject: [gentoo-commits] proj/pms:eapi-5 commit in: / X-VCS-Repository: proj/pms X-VCS-Files: dependencies.tex eapi-differences.tex eapis.tex ebuild-env-vars.tex ebuild-functions.tex ebuild-vars.tex merge.tex pkg-mgr-commands.tex pms.cls pms.tex X-VCS-Directories: / X-VCS-Committer: ulm X-VCS-Committer-Name: Ulrich Mueller X-VCS-Revision: 4630becfa4c792b96ddd2949536a8ccdba77ec91 X-VCS-Branch: eapi-5 Date: Thu, 17 May 2012 12:02:23 +0000 (UTC) Precedence: bulk List-Post: List-Help: List-Unsubscribe: List-Subscribe: List-Id: Gentoo Linux mail X-BeenThere: gentoo-commits@lists.gentoo.org Content-Transfer-Encoding: quoted-printable X-Archives-Salt: 707cd717-f970-41ef-b76d-265eaa656a1d X-Archives-Hash: a464dfc6c71da984ad268608f785b7e9 commit: 4630becfa4c792b96ddd2949536a8ccdba77ec91 Author: Ciaran McCreesh googlemail com> AuthorDate: Sun May 6 16:03:49 2012 +0000 Commit: Ulrich Mueller gentoo org> CommitDate: Thu May 17 10:31:29 2012 +0000 URL: http://git.overlays.gentoo.org/gitweb/?p=3Dproj/pms.git;a=3Dc= ommit;h=3D4630becf Add \ChangeWhenAddingAnEAPI command. This gives us an easy way to grep and find every place that needs updating when we add a new EAPI. --- dependencies.tex | 4 ++++ eapi-differences.tex | 3 +++ eapis.tex | 1 + ebuild-env-vars.tex | 3 +++ ebuild-functions.tex | 8 ++++++++ ebuild-vars.tex | 4 ++++ merge.tex | 1 + pkg-mgr-commands.tex | 11 +++++++++++ pms.cls | 5 +++++ pms.tex | 3 +++ 10 files changed, 43 insertions(+), 0 deletions(-) diff --git a/dependencies.tex b/dependencies.tex index 0f74b3b..54305c5 100644 --- a/dependencies.tex +++ b/dependencies.tex @@ -76,6 +76,7 @@ be surrounded on both sides by whitespace, except at th= e start and end of the st =20 In particular, note that whitespace is not optional. =20 +\ChangeWhenAddingAnEAPI{4} \begin{centertable}{EAPIs supporting \t{SRC\_URI} arrows} \label{tab:uri= -arrows-table} \begin{tabular}{ l l } \toprule @@ -147,6 +148,7 @@ manager must warn or error if this feature is used wi= th an EAPI not supporting u =20 \note Order is important. The slot restriction must come before use depe= ndencies. =20 +\ChangeWhenAddingAnEAPI{4} \begin{centertable}{EAPIs supporting \t{SLOT} dependencies} \label{tab:s= lot-deps-table} \begin{tabular}{ l l } \toprule @@ -162,6 +164,7 @@ manager must warn or error if this feature is used wi= th an EAPI not supporting u \end{tabular} \end{centertable} =20 +\ChangeWhenAddingAnEAPI{4} \begin{centertable}{EAPIs supporting \t{USE} dependencies} \label{tab:us= e-deps-table} \begin{tabular}{ l l } \toprule @@ -212,6 +215,7 @@ ignored by the package manager, so long as any blocke= d package will be uninstall strong block must not be ignored. The mapping from one or two exclamatio= n marks to strength is described in table~\ref{tab:bang-strength-table}. =20 +\ChangeWhenAddingAnEAPI{4} \begin{centertable}{Exclamation mark strengths for EAPIs} \label{tab:ban= g-strength-table} \begin{tabular}{ l l l } \toprule diff --git a/eapi-differences.tex b/eapi-differences.tex index a451db1..33381e7 100644 --- a/eapi-differences.tex +++ b/eapi-differences.tex @@ -2,6 +2,7 @@ =20 \note This chapter is informative and for convenience only. Refer to the= main text for specifics. =20 +\ChangeWhenAddingAnEAPI{4} \begin{landscape} \newcolumntype{P}[1]{>{\setlength{\rightskip}{0pt plus 1fil}}p{#1}} \begin{longtable}{llP{5em}P{5em}P{8em}P{8em}P{8em}} @@ -235,6 +236,8 @@ EAPI 4 is EAPI 3 with the following changes: \item \t{use\_with} and \t{use\_enable} support empty third argument, \f= eatureref{use-with}. \end{compactitem} =20 +\ChangeWhenAddingAnEAPI{4} + % vim: set filetype=3Dtex fileencoding=3Dutf8 et tw=3D100 spell spelllan= g=3Den : =20 %%% Local Variables: diff --git a/eapis.tex b/eapis.tex index 5839768..5543988 100644 --- a/eapis.tex +++ b/eapis.tex @@ -19,6 +19,7 @@ EAPIs are also used for profile directories, as describ= ed in section~\ref{sec:pr =20 The following EAPIs are defined by this specification: =20 +\ChangeWhenAddingAnEAPI{4} \begin{description} \item[0] The `original' base EAPI. \item[1] EAPI `1' contains a number of extensions to EAPI `0'. Except wh= ere explicitly noted, it is diff --git a/ebuild-env-vars.tex b/ebuild-env-vars.tex index 640547c..dc4e648 100644 --- a/ebuild-env-vars.tex +++ b/ebuild-env-vars.tex @@ -214,6 +214,7 @@ variable. \end{longtable} \end{landscape} =20 +\ChangeWhenAddingAnEAPI{4} \begin{centertable}{EAPIs supporting various env variables} \label{tab:e= nv-vars-table} \begin{tabular}{ l l l l l l } \toprule @@ -233,6 +234,7 @@ variable. \end{tabular} \end{centertable} =20 +\ChangeWhenAddingAnEAPI{4} \begin{centertable}{EAPIs supporting offset-prefix env variables} \label{tab:offset-env-vars-table} \begin{tabular}{ l l l l } @@ -317,6 +319,7 @@ variable shall be defined in \t{pkg\_prerm} and \t{pk= g\_postrm}. It shall contai \subsection{Offset-prefix variables \t{EPREFIX}, \t{EROOT} and \t{ED}} \label{sec:offset-vars} =20 +\ChangeWhenAddingAnEAPI{4} \begin{centertable}{EAPIs supporting offset-prefix} \label{tab:offset-support-table} \begin{tabular}{ l l } diff --git a/ebuild-functions.tex b/ebuild-functions.tex index fe32004..24f7d69 100644 --- a/ebuild-functions.tex +++ b/ebuild-functions.tex @@ -44,6 +44,7 @@ fallback to \t{WORKDIR} is used: in \t{DEFINED\_PHASES}. \end{compactitem} =20 +\ChangeWhenAddingAnEAPI{4} \begin{centertable}{EAPIs with \t{S} to \t{WORKDIR} fallbacks} \label{ta= b:s-fallback-table} \begin{tabular}{ l l } \toprule @@ -77,6 +78,7 @@ before the next phase is executed. =20 \t{pkg\_pretend} must not write to the filesystem. =20 +\ChangeWhenAddingAnEAPI{4} \begin{centertable}{EAPIs supporting \t{pkg\_pretend}} \label{tab:pkg-pr= etend-table} \begin{tabular}{ l l } \toprule @@ -131,6 +133,7 @@ implementation does nothing. The initial working directory is \t{S}, with an error or fallback to \t{= WORKDIR} as discussed in section~\ref{sec:s-to-workdir-fallback}. =20 +\ChangeWhenAddingAnEAPI{4} \begin{centertable}{EAPIs supporting \t{src\_prepare}} \label{tab:src-pr= epare-table} \begin{tabular}{ l l } \toprule @@ -166,6 +169,7 @@ src_configure() { } \end{verbatim} =20 +\ChangeWhenAddingAnEAPI{4} \begin{centertable}{EAPIs supporting \t{src\_configure}} \label{tab:src-= configure-table} \begin{tabular}{ l l } \toprule @@ -232,6 +236,7 @@ src_compile() { } \end{verbatim} =20 +\ChangeWhenAddingAnEAPI{4} \begin{centertable}{\t{src\_compile} behaviour for EAPIs} \label{tab:src= -compile-table} \begin{tabular}{ l l } \toprule @@ -298,6 +303,7 @@ src_install() { For other EAPIs, the default implementation used when the ebuild lacks t= he \t{src\_install} function is a no-op. =20 +\ChangeWhenAddingAnEAPI{4} \begin{centertable}{\t{src\_install} behaviour for EAPIs} \label{tab:src= -install-table} \begin{tabular}{ l l } \toprule @@ -372,6 +378,7 @@ that dependencies may not be installed. =20 \t{pkg\_info} must not write to the filesystem. =20 +\ChangeWhenAddingAnEAPI{4} \begin{centertable}{EAPIs supporting \t{pkg\_info} on non-installed pack= ages} \label{tab:pkg-info-table} \begin{tabular}{ l l } \toprule @@ -405,6 +412,7 @@ named \t{default\_}(phase) that behaves as the defaul= t implementation for that E when executing any ebuild phase listed in the table. Ebuilds must not ca= ll these functions except when in the phase in question. =20 +\ChangeWhenAddingAnEAPI{4} \begin{centertable}{EAPIs supporting \t{default\_} phase functions} \lab= el{tab:default-phase-function-table} \begin{tabular}{ l >{\setlength{\rightskip}{0pt plus 1fil}}p{30em} } \toprule diff --git a/ebuild-vars.tex b/ebuild-vars.tex index 29b9dfa..0204c3a 100644 --- a/ebuild-vars.tex +++ b/ebuild-vars.tex @@ -54,6 +54,7 @@ If any of these variables are undefined, or if any of t= hese variables are set to the package manager's behaviour is undefined; ideally, an error in one e= build should not prevent operations upon other ebuilds or packages. =20 +\ChangeWhenAddingAnEAPI{4} \begin{centertable}{EAPIs supporting \t{IUSE} defaults} \label{tab:iuse-= defaults-table} \begin{tabular}{ l l } \toprule @@ -93,6 +94,7 @@ Ebuilds may define any of the following variables: table~\ref{tab:optional-vars-table} as supporting \t{REQUIRED\_USE}. \end{description} =20 +\ChangeWhenAddingAnEAPI{4} \begin{centertable}{EAPIs supporting various ebuild-defined variables} \label{tab:optional-vars-table} \begin{tabular}{ l l l } @@ -152,6 +154,7 @@ any \t{DEPEND} or \t{RDEPEND} set in an eclass does n= ot change the implicit \t{R the ebuild portion, and any \t{DEPEND} value set in an eclass does not g= et treated as being part of \t{RDEPEND}. =20 +\ChangeWhenAddingAnEAPI{4} \begin{centertable}{EAPIs with \t{RDEPEND=3DDEPEND} Default} \label{tab:= rdepend-depend-table} \begin{tabular}{ l l } \toprule @@ -196,6 +199,7 @@ this variable defined, and must treat an empty string= as ``this information is n \note Thus, by extension of section~\ref{sec:metadata-invariance}, phase= functions must not be defined based upon any variant condition. =20 +\ChangeWhenAddingAnEAPI{4} \begin{centertable}{EAPIs supporting \t{DEFINED\_PHASES}} \label{tab:def= ined-phases-table} \begin{tabular}{ l l } \toprule diff --git a/merge.tex b/merge.tex index 8b2648d..846e876 100644 --- a/merge.tex +++ b/merge.tex @@ -86,6 +86,7 @@ held under the original image directory. In other EAPIs, the behaviour with respect to file modification times is undefined. =20 +\ChangeWhenAddingAnEAPI{4} \begin{centertable}{Preservation of file modification times (mtimes)} \label{tab:mtime-preserve} \begin{tabular}{ l l } diff --git a/pkg-mgr-commands.tex b/pkg-mgr-commands.tex index 37c1b13..c2d8a9e 100644 --- a/pkg-mgr-commands.tex +++ b/pkg-mgr-commands.tex @@ -21,6 +21,7 @@ The following commands affect this behaviour: table~\ref{tab:commands-die-table} as supporting \t{nonfatal}. \end{description} =20 +\ChangeWhenAddingAnEAPI{4} \begin{centertable}{EAPI Command Failure Behaviour} \label{tab:commands-= die-table} \begin{tabular}{ l l l } \toprule @@ -43,6 +44,7 @@ The following commands affect this behaviour: \featurelabel{banned-commands} Some commands are banned in some EAPIs. I= f a banned command is called, the package manager must abort the build process indicating an e= rror. =20 +\ChangeWhenAddingAnEAPI{4} \begin{centertable}{Banned commands} \label{tab:banned-commands-table} \begin{tabular}{ l l l l } \toprule @@ -145,6 +147,7 @@ has returned. string \t{disable-dependency-tracking} occurs in the output of \= t{configure -{}-help}. \end{itemize} =20 + \ChangeWhenAddingAnEAPI{4} \begin{centertable}{Extra \t{econf} arguments for EAPIs} \label{tab:= econf-options-table} \begin{tabular}{ l l l } \toprule @@ -407,6 +410,7 @@ that can be passed to \t{dohtml} are as follows: =20 \end{description} =20 +\ChangeWhenAddingAnEAPI{4} \begin{centertable}{EAPIs supporting \t{dodoc -r}} \label{tab:dodoc-tabl= e} \begin{tabular}{ l l } \toprule @@ -422,6 +426,7 @@ that can be passed to \t{dohtml} are as follows: \end{tabular} \end{centertable} =20 +\ChangeWhenAddingAnEAPI{4} \begin{centertable}{EAPIs supporting symlinks for \t{doins}} \label{tab:= doins-table} \begin{tabular}{ l l } \toprule @@ -437,6 +442,7 @@ that can be passed to \t{dohtml} are as follows: \end{tabular} \end{centertable} =20 +\ChangeWhenAddingAnEAPI{4} \begin{centertable}{\t{doman} language support options for EAPIs} \label{tab:doman-table} \begin{tabular}{ l l l } @@ -539,6 +545,7 @@ exclusion list. Otherwise, add each argument to the i= nclusion list. Only availab in table~\ref{tab:compression-table} as supporting \t{docompress}. \end{description} =20 +\ChangeWhenAddingAnEAPI{4} \begin{centertable}{EAPIs supporting controllable compression} \label{ta= b:compression-table} \begin{tabular}{ l l l } \toprule @@ -582,6 +589,7 @@ either behaviour is undefined or it is an error as de= cided by table~\ref{tab:use instead of \t{-{}-with-} or \t{-{}-without-}. \end{description} =20 +\ChangeWhenAddingAnEAPI{4} \begin{centertable}{EAPI Behaviour for Use Queries not in IUSE\_EFFECTIV= E} \label{tab:use-list-strictness} \begin{tabular}{ l l } \toprule @@ -597,6 +605,7 @@ instead of \t{-{}-with-} or \t{-{}-without-}. \end{tabular} \end{centertable} =20 +\ChangeWhenAddingAnEAPI{4} \begin{centertable}{EAPIs supporting empty third argument in \t{use\_wit= h} and \t{use\_enable}} \label{tab:use-with-third-arg} \begin{tabular}{ l l } @@ -679,6 +688,7 @@ has returned. It is up to the ebuild to ensure that the relevant external utilitie= s are available, whether by being in the system set or via dependencies. =20 +\ChangeWhenAddingAnEAPI{4} \begin{centertable}{\t{unpack} extensions for EAPIs} \label{tab:unpack-e= xtensions-table} \begin{tabular}{ l l } \toprule @@ -703,6 +713,7 @@ has returned. table~\ref{tab:default-function-table}. \end{description} =20 +\ChangeWhenAddingAnEAPI{4} \begin{centertable}{EAPIs supporting the \t{default} function} \label{ta= b:default-function-table} \begin{tabular}{ l l } \toprule diff --git a/pms.cls b/pms.cls index db2fd48..a37d78a 100644 --- a/pms.cls +++ b/pms.cls @@ -147,6 +147,11 @@ % margin. \areaset[-30mm]{400pt}{700pt} =20 +% To find everywhere that needs updating when we add an EAPI +\newcommand{\CurrentEAPIIs}[1]{\def\TheCurrentEAPI{#1}} +\newcommand{\ChangeWhenAddingAnEAPI}[1]{\ifthenelse{\equal{\TheCurrentEA= PI}{#1}}{}{\errmessage{This +needs to be updated for EAPI \TheCurrentEAPI}}} + % vim: set filetype=3Dtex fileencoding=3Dutf8 et tw=3D100 spell spelllan= g=3Den : =20 %%% Local Variables: diff --git a/pms.tex b/pms.tex index 4ada8ec..1c9ed30 100644 --- a/pms.tex +++ b/pms.tex @@ -1,5 +1,8 @@ \documentclass{pms} =20 +\CurrentEAPIIs{4} +\ChangeWhenAddingAnEAPI{4} + \begin{document} \maketitle =20