Gentoo Archives: gentoo-pms

From: Ulrich Mueller <ulm@g.o>
To: gentoo-pms@l.g.o
Cc: Christian Faulhammer <fauli@g.o>
Subject: [gentoo-pms] [PATCH 1/2] Reformat the cheat sheet and condense its wording to make room for EAPI 5.
Date: Sun, 16 Sep 2012 14:58:31
Message-Id: 20565.59655.824541.828548@a1i15.kph.uni-mainz.de
1 Mostly formatting changes and minor changes of wording, to save a line
2 in the output here and there.
3
4 I've also removed a footnote and two paragraphs which I believe are
5 outdated or inaccurate.
6
7 Please review.
8
9 Ulrich
10
11
12 From 4e81986b681b7749f80262b4cdfa7f1aa5c2c28a Mon Sep 17 00:00:00 2001
13 From: =?UTF-8?q?Ulrich=20M=C3=BCller?= <ulm@g.o>
14 Date: Sun, 16 Sep 2012 16:33:08 +0200
15 Subject: [PATCH 1/2] Reformat the cheat sheet and condense its wording to
16 make room for EAPI 5.
17
18 ---
19 eapi-cheatsheet.tex | 50 +++++++++++++++++++++++++-------------------------
20 1 file changed, 25 insertions(+), 25 deletions(-)
21
22 diff --git a/eapi-cheatsheet.tex b/eapi-cheatsheet.tex
23 index 57c95a1..e14bc90 100644
24 --- a/eapi-cheatsheet.tex
25 +++ b/eapi-cheatsheet.tex
26 @@ -59,9 +59,9 @@
27 the previous EAPI. All labels refer to the PMS document itself,
28 built from the same checkout as this overview.
29
30 - Please report mistakes in or enhancements to this document via the
31 - Gentoo bug tracking system\footnote{\url{http://bugs.gentoo.org/}}
32 - to the original author or the PMS team.
33 + % Please report mistakes in or enhancements to this document via the
34 + % Gentoo bug tracking system\footnote{\url{http://bugs.gentoo.org/}}
35 + % to the original author or the PMS team.
36
37 This document is released under the Creative Commons
38 Attribution-Share Alike 3.0
39 @@ -70,11 +70,11 @@
40 \section{EAPI 0}
41 \label{sec:cs:eapi0}
42 If there is no EAPI explicitly specified, EAPI 0 is assumed.
43 -Currently there is no full specification what EAPI 0 includes.
44 -Portage, official ebuild documentation and existing ebuilds set the
45 -standard. If you think you found a bug, you should file a bug report
46 -nonetheless.
47 -\newpage
48 +% Currently there is no full specification what EAPI 0 includes.
49 +% Portage, official ebuild documentation and existing ebuilds set the
50 +% standard. If you think you found a bug, you should file a bug report
51 +% nonetheless.
52 +
53 \section{EAPI 1}
54 \label{sec:cs:eapi1}
55 \subsection{Additions/Changes}
56 @@ -84,33 +84,35 @@ nonetheless.
57 not disabled explicitly by user configuration) with a \code{+}
58 sign in front. See \featureref{iuse-defaults}.
59 \item[Named slot dependencies] Dependencies can explicitly request
60 - a specific slot by using the \code{dev-libs/foo:\emph{SLOT\_name}}
61 - syntax. See \featureref{slot-deps}.
62 + a specific slot by using the
63 + \code{dev-libs/foo:}\allowbreak\emph{SLOT\_name} syntax.
64 + See \featureref{slot-deps}.
65 \end{description}
66 +
67 \section{EAPI 2 (2008-09-25)}
68 \label{sec:cs:eapi2}
69 \subsection{Additions/Changes}
70 \label{sec:cs:eapi2-additions}
71 \begin{description}
72 \item[\code{SRC\_URI} arrows] Allows redirection of upstream file
73 - naming scheme. By using \code{SRC\_URI="http://some/url -> foo"}
74 - the file is saved as \code{foo} in DISTDIR. See
75 - \featureref{src-uri-arrows}.
76 + naming scheme. By using
77 + \code{SRC\_URI="http:/\slash some\slash url -> foo"} the file is
78 + saved as \code{foo} in DISTDIR.
79 + See \featureref{src-uri-arrows}.
80 \item[USE dependencies] Dependencies can specify USE flag
81 requirements on their target, removing the need for
82 - \code{built\_with\_use} checks. A more powerful syntax that does
83 - not require the flag to be in IUSE is in EAPI 4.
84 + \code{built\_with\_use} checks.
85 \begin{description}
86 \item[{[opt]}] The flag must be enabled.
87 - \item[{[opt=]}] The flag must be enabled if the flag is
88 + \item[{[opt=]}] The flag must be enabled if it is
89 enabled for the package with the dependency, or disabled
90 otherwise.
91 - \item[{[!opt=]}] The flag must be disabled if the flag is
92 + \item[{[!opt=]}] The flag must be disabled if it is
93 enabled for the package with the dependency, or enabled
94 otherwise.
95 - \item[{[opt?]}] The flag must be enabled if the flag is
96 + \item[{[opt?]}] The flag must be enabled if it is
97 enabled for the package with the dependency.
98 - \item[{[!opt?]}] The flag must be disabled if the use flag is
99 + \item[{[!opt?]}] The flag must be disabled if it is
100 disabled for the package with the dependency.
101 \item[{[-opt]}] The flag must be disabled.
102 \end{description}
103 @@ -125,11 +127,11 @@ nonetheless.
104 Patching and similar preparation must now be done in
105 \code{src\_prepare}, not \code{src\_unpack}. See
106 \featureref{src-prepare} and \featureref{src-configure}.
107 - \item[Default phase functions] The default functions for the
108 + \item[Default phase functions] The default functions for
109 phases \code{pkg\_nofetch}, \code{src\_unpack},
110 \code{src\_prepare}, \code{src\_configure}, \code{src\_compile}
111 and \code{src\_test} can be called via
112 - \code{default\_\emph{phasename}}, so duplicating the standard
113 + \code{default\_}\emph{phasename}, so duplicating the standard
114 implementation is no longer necessary for small additions. The
115 short-hand \code{default} function calls the current phase's
116 \code{default\_} function automatically, so any small additions
117 @@ -141,7 +143,6 @@ nonetheless.
118 behaves accordingly. This behaviour can be inhibited by the
119 \code{-i18n} switch with EAPI 4. See \featureref{doman-langs}.
120 \end{description}
121 -\newpage
122
123 \section{EAPI 3 (2010-01-18)}
124 \label{sec:cs:eapi3}
125 @@ -152,8 +153,7 @@ nonetheless.
126 \code{.tar.xz} files is possible without any custom
127 \code{src\_unpack} functions. See \featureref{unpack-extensions}.
128 \item[Offset prefix] Supporting installation on Prefix-enabled
129 - systems\footnote{\url{http://prefix.gentoo.org/}} will be easier
130 - with this EAPI.
131 + systems will be easier with this EAPI.
132 \end{description}
133
134 \section{EAPI 4 (2011-01-17)}
135 @@ -200,7 +200,7 @@ nonetheless.
136 \item[\code{nonfatal} for commands] If you call \code{nonfatal}
137 the command given as argument will not abort the build process in
138 case of a failure (as is the default) but will return non-zero on
139 - failure rather than aborting the build.
140 + failure.
141 See \featureref{nonfatal}.
142 \item[\code{PROPERTIES}] Is mandatory for all package managers now
143 to support interactive installs.
144 --
145 1.7.12

Replies

Subject Author
[gentoo-pms] [PATCH 2/2] Add EAPI 5 to cheat sheet. Ulrich Mueller <ulm@g.o>