From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from lists.gentoo.org (pigeon.gentoo.org [208.92.234.80]) by finch.gentoo.org (Postfix) with ESMTP id E2ADD1384B4 for ; Sun, 8 Nov 2015 19:37:17 +0000 (UTC) Received: from pigeon.gentoo.org (localhost [127.0.0.1]) by pigeon.gentoo.org (Postfix) with SMTP id 2346E21C01A; Sun, 8 Nov 2015 19:37:04 +0000 (UTC) Received: from smtp.gentoo.org (smtp.gentoo.org [140.211.166.183]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by pigeon.gentoo.org (Postfix) with ESMTPS id 26A8C21C018 for ; Sun, 8 Nov 2015 19:36:58 +0000 (UTC) Received: from oystercatcher.gentoo.org (unknown [IPv6:2a01:4f8:202:4333:225:90ff:fed9:fc84]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by smtp.gentoo.org (Postfix) with ESMTPS id 498FE340662 for ; Sun, 8 Nov 2015 19:36:57 +0000 (UTC) Received: from localhost.localdomain (localhost [127.0.0.1]) by oystercatcher.gentoo.org (Postfix) with ESMTP id 99CCE22D8 for ; Sun, 8 Nov 2015 19:36:53 +0000 (UTC) From: "Ulrich Müller" To: gentoo-commits@lists.gentoo.org Content-Transfer-Encoding: 8bit Content-type: text/plain; charset=UTF-8 Reply-To: gentoo-dev@lists.gentoo.org, "Ulrich Müller" Message-ID: <1447010960.288893d980dbcbf09ea02239c8c1160db73754de.ulm@gentoo> Subject: [gentoo-commits] proj/pms:eapi-6 commit in: / X-VCS-Repository: proj/pms X-VCS-Files: eapi-cheatsheet.tex X-VCS-Directories: / X-VCS-Committer: ulm X-VCS-Committer-Name: Ulrich Müller X-VCS-Revision: 288893d980dbcbf09ea02239c8c1160db73754de X-VCS-Branch: eapi-6 Date: Sun, 8 Nov 2015 19:36:53 +0000 (UTC) Precedence: bulk List-Post: List-Help: List-Unsubscribe: List-Subscribe: List-Id: Gentoo Linux mail X-BeenThere: gentoo-commits@lists.gentoo.org X-Archives-Salt: 46d641a1-9a0d-4008-b0f3-d79a448a4eb6 X-Archives-Hash: a07afb060a3d0eaa496df91d35169245 commit: 288893d980dbcbf09ea02239c8c1160db73754de Author: Ulrich Müller gentoo org> AuthorDate: Thu Oct 15 16:49:26 2015 +0000 Commit: Ulrich Müller gentoo org> CommitDate: Sun Nov 8 19:29:20 2015 +0000 URL: https://gitweb.gentoo.org/proj/pms.git/commit/?id=288893d9 Cheat sheet: Remove EAPIs 0, 1, and 2 to make room for EAPI 6. Also some rearrangement of items and one minor wording change, in order to fit the EAPI 4 section in two (small) pages. eapi-cheatsheet.tex | 162 ++++++++++++++++++++++++++-------------------------- 1 file changed, 82 insertions(+), 80 deletions(-) diff --git a/eapi-cheatsheet.tex b/eapi-cheatsheet.tex index 136ac5f..a8171a3 100644 --- a/eapi-cheatsheet.tex +++ b/eapi-cheatsheet.tex @@ -67,82 +67,84 @@ Attribution-Share Alike 3.0 Licence\footnote{\url{http://creativecommons.org/licenses/by-sa/3.0/}}. \end{abstract} -\section{EAPI 0} -\label{sec:cs:eapi0} -If there is no EAPI explicitly specified, EAPI 0 is assumed. -% Currently there is no full specification what EAPI 0 includes. -% Portage, official ebuild documentation and existing ebuilds set the -% standard. If you think you found a bug, you should file a bug report -% nonetheless. -\section{EAPI 1} -\label{sec:cs:eapi1} -\subsection{Additions/Changes} -\label{sec:cs:eapi1-additions} -\begin{description} - \item[IUSE defaults] A USE flag can be marked as mandatory (if - not disabled explicitly by user configuration) with a \code{+} - sign in front. See \featureref{iuse-defaults}. - \item[Named slot dependencies] Dependencies can explicitly request - a specific slot by using the - \code{dev-libs/foo:}\allowbreak\emph{SLOT\_name} syntax. - See \featureref{slot-deps}. -\end{description} +\section{EAPIs 0, 1, and 2} +\label{sec:cs:eapi0-2} +Omitted for lack of space. See version~5.0 of this document for +differences between these previous EAPIs. -\section{EAPI 2 (2008-09-25)} -\label{sec:cs:eapi2} -\subsection{Additions/Changes} -\label{sec:cs:eapi2-additions} -\begin{description} - \item[\code{SRC\_URI} arrows] Allows redirection of upstream file - naming scheme. By using - \code{SRC\_URI="http:/\slash some\slash url -> foo"} the file is - saved as \code{foo} in DISTDIR\@. - See \featureref{src-uri-arrows}. - \item[USE dependencies] Dependencies can specify USE flag - requirements on their target, removing the need for - \code{built\_with\_use} checks. - \begin{description} - \item[{[opt]}] The flag must be enabled. - \item[{[opt=]}] The flag must be enabled if it is - enabled for the package with the dependency, or disabled - otherwise. - \item[{[!opt=]}] The flag must be disabled if it is - enabled for the package with the dependency, or enabled - otherwise. - \item[{[opt?]}] The flag must be enabled if it is - enabled for the package with the dependency. - \item[{[!opt?]}] The flag must be disabled if it is - disabled for the package with the dependency. - \item[{[-opt]}] The flag must be disabled. - \end{description} - See \featureref{use-deps}. - \item[Blocker syntax] A single exclamation mark as a blocker may - be ignored by the package manager as long as the stated package is - uninstalled later on. Two exclamation marks are a strong blocker - and will always be respected. See \featureref{bang-strength}. - \item[\code{src\_configure, src\_prepare}] Both new phases provide - finer granularity in the ebuild's structure. Configure calls - should be moved from \code{src\_compile} to \code{src\_configure}. - Patching and similar preparation must now be done in - \code{src\_prepare}, not \code{src\_unpack}. See - \featureref{src-prepare} and \featureref{src-configure}. - \item[Default phase functions] The default functions for - phases \code{pkg\_nofetch}, \code{src\_unpack}, - \code{src\_prepare}, \code{src\_configure}, \code{src\_compile} - and \code{src\_test} can be called via - \code{default\_}\emph{phasename}, so duplicating the standard - implementation is no longer necessary for small additions. The - short-hand \code{default} function calls the current phase's - \code{default\_} function automatically, so any small additions - you need will not be accompanied by a complete reimplementation of - the phase. See \featureref{default-phase-funcs} and - \featureref{default-func}. - \item[\code{doman} language support] The \code{doman} installation - function recognizes language specific man page extensions and - behaves accordingly. This behaviour can be inhibited by the - \code{-i18n} switch with EAPI 4. See \featureref{doman-langs}. -\end{description} +% \section{EAPI 0} +% \label{sec:cs:eapi0} +% If there is no EAPI explicitly specified, EAPI 0 is assumed. + +% \section{EAPI 1} +% \label{sec:cs:eapi1} +% \subsection{Additions/Changes} +% \label{sec:cs:eapi1-additions} +% \begin{description} +% \item[IUSE defaults] A USE flag can be marked as mandatory (if +% not disabled explicitly by user configuration) with a \code{+} +% sign in front. See \featureref{iuse-defaults}. +% \item[Named slot dependencies] Dependencies can explicitly request +% a specific slot by using the +% \code{dev-libs/foo:}\allowbreak\emph{SLOT\_name} syntax. +% See \featureref{slot-deps}. +% \end{description} + +% \section{EAPI 2 (2008-09-25)} +% \label{sec:cs:eapi2} +% \subsection{Additions/Changes} +% \label{sec:cs:eapi2-additions} +% \begin{description} +% \item[\code{SRC\_URI} arrows] Allows redirection of upstream file +% naming scheme. By using +% \code{SRC\_URI="http:/\slash some\slash url -> foo"} the file is +% saved as \code{foo} in DISTDIR\@. +% See \featureref{src-uri-arrows}. +% \item[USE dependencies] Dependencies can specify USE flag +% requirements on their target, removing the need for +% \code{built\_with\_use} checks. +% \begin{description} +% \item[{[opt]}] The flag must be enabled. +% \item[{[opt=]}] The flag must be enabled if it is +% enabled for the package with the dependency, or disabled +% otherwise. +% \item[{[!opt=]}] The flag must be disabled if it is +% enabled for the package with the dependency, or enabled +% otherwise. +% \item[{[opt?]}] The flag must be enabled if it is +% enabled for the package with the dependency. +% \item[{[!opt?]}] The flag must be disabled if it is +% disabled for the package with the dependency. +% \item[{[-opt]}] The flag must be disabled. +% \end{description} +% See \featureref{use-deps}. +% \item[Blocker syntax] A single exclamation mark as a blocker may +% be ignored by the package manager as long as the stated package is +% uninstalled later on. Two exclamation marks are a strong blocker +% and will always be respected. See \featureref{bang-strength}. +% \item[\code{src\_configure, src\_prepare}] Both new phases provide +% finer granularity in the ebuild's structure. Configure calls +% should be moved from \code{src\_compile} to \code{src\_configure}. +% Patching and similar preparation must now be done in +% \code{src\_prepare}, not \code{src\_unpack}. See +% \featureref{src-prepare} and \featureref{src-configure}. +% \item[Default phase functions] The default functions for +% phases \code{pkg\_nofetch}, \code{src\_unpack}, +% \code{src\_prepare}, \code{src\_configure}, \code{src\_compile} +% and \code{src\_test} can be called via +% \code{default\_}\emph{phasename}, so duplicating the standard +% implementation is no longer necessary for small additions. The +% short-hand \code{default} function calls the current phase's +% \code{default\_} function automatically, so any small additions +% you need will not be accompanied by a complete reimplementation of +% the phase. See \featureref{default-phase-funcs} and +% \featureref{default-func}. +% \item[\code{doman} language support] The \code{doman} installation +% function recognizes language specific man page extensions and +% behaves accordingly. This behaviour can be inhibited by the +% \code{-i18n} switch with EAPI 4. See \featureref{doman-langs}. +% \end{description} \section{EAPI 3 (2010-01-18)} \label{sec:cs:eapi3} @@ -191,17 +193,17 @@ If there is no EAPI explicitly specified, EAPI 0 is assumed. adds paths to the inclusion list for compression. \code{docompress -x path \dots} adds paths to the exclusion list. See \featureref{docompress}. + \item[\code{nonfatal} for commands] If you call \code{nonfatal} + the command given as argument will not abort the build process in + case of a failure (as is the default) but will return non-zero on + failure. + See \featureref{nonfatal}. \item[\code{dodoc} recursion] If the \code{-r} switch is given as first argument and followed by directories, files from there are installed recursively. See \featureref{dodoc}. \item[\code{doins} symlink support] Symbolic links are now properly installed when using recursion (\code{-r} switch). See \featureref{doins}. - \item[\code{nonfatal} for commands] If you call \code{nonfatal} - the command given as argument will not abort the build process in - case of a failure (as is the default) but will return non-zero on - failure. - See \featureref{nonfatal}. \item[\code{PROPERTIES}] Is mandatory for all package managers now to support interactive installs. \item[\code{REQUIRED\_USE}] This variable can be used similar to @@ -209,7 +211,7 @@ If there is no EAPI explicitly specified, EAPI 0 is assumed. combinations that are not allowed. All elements can be further nested to achieve more functionality. \begin{description} - \item[Forbidden combination] To prevent activation of + \item[Illegal combination] To prevent activation of \code{flag1} if \code{flag2} is enabled use "\code{flag2?\ ( !flag1 )}". \item[OR] If at least one USE flag out of many must be