1 |
commit: 525c0460eb2bc9cbe65755f5df4ab833b2107d65 |
2 |
Author: Ulrich Müller <ulm <AT> gentoo <DOT> org> |
3 |
AuthorDate: Sun Aug 12 13:17:27 2018 +0000 |
4 |
Commit: Ulrich Müller <ulm <AT> gentoo <DOT> org> |
5 |
CommitDate: Sun Aug 12 13:17:27 2018 +0000 |
6 |
URL: https://gitweb.gentoo.org/proj/pms.git/commit/?id=525c0460 |
7 |
|
8 |
Fix whitespace in list items. |
9 |
|
10 |
dependencies.tex | 14 +++++++------- |
11 |
ebuild-vars.tex | 13 +++++++------ |
12 |
eclasses.tex | 2 +- |
13 |
introduction.tex | 2 +- |
14 |
merge.tex | 6 +++--- |
15 |
pkg-mgr-commands.tex | 36 +++++++++++++++++++----------------- |
16 |
profiles.tex | 11 ++++++----- |
17 |
tree-layout.tex | 6 +++--- |
18 |
8 files changed, 47 insertions(+), 43 deletions(-) |
19 |
|
20 |
diff --git a/dependencies.tex b/dependencies.tex |
21 |
index 39b43f5..deb5d9c 100644 |
22 |
--- a/dependencies.tex |
23 |
+++ b/dependencies.tex |
24 |
@@ -60,7 +60,7 @@ as supporting \t{BDEPEND}, the build dependencies are split into two subclasses: |
25 |
\item \t{BDEPEND} build dependencies that are binary compatible with the native build system |
26 |
(\t{CBUILD}). The ebuild is allowed to call binary executables installed by this kind of |
27 |
dependency. |
28 |
- \item \t{DEPEND} build dependencies that are binary compatible with the system being built |
29 |
+\item \t{DEPEND} build dependencies that are binary compatible with the system being built |
30 |
(\t{CHOST}). The ebuild must not execute binary executables installed by this kind of |
31 |
dependency. |
32 |
\end{compactitem} |
33 |
@@ -335,14 +335,14 @@ the following operators: |
34 |
|
35 |
\begin{description} |
36 |
\item[*] Indicates that any slot value is acceptable. In addition, for runtime dependencies, |
37 |
-indicates that the package will not break if the matched package is uninstalled and replaced by |
38 |
-a different matching package in a different slot. |
39 |
+ indicates that the package will not break if the matched package is uninstalled and replaced by |
40 |
+ a different matching package in a different slot. |
41 |
\item[=] Indicates that any slot value is acceptable. In addition, for runtime dependencies, |
42 |
-indicates that the package will break unless a matching package with slot and sub-slot equal to the |
43 |
-slot and sub-slot of the best version installed as a build-time (\t{DEPEND}) dependency is |
44 |
-available. |
45 |
+ indicates that the package will break unless a matching package with slot and sub-slot equal to |
46 |
+ the slot and sub-slot of the best version installed as a build-time (\t{DEPEND}) dependency is |
47 |
+ available. |
48 |
\item[slot=] Indicates that only a specific slot value is acceptable, and otherwise behaves |
49 |
-identically to the plain equals slot operator. |
50 |
+ identically to the plain equals slot operator. |
51 |
\end{description} |
52 |
|
53 |
To implement the equals slot operator, the package manager will need to store the slot/sub-slot |
54 |
|
55 |
diff --git a/ebuild-vars.tex b/ebuild-vars.tex |
56 |
index faecf8f..497bd77 100644 |
57 |
--- a/ebuild-vars.tex |
58 |
+++ b/ebuild-vars.tex |
59 |
@@ -211,12 +211,13 @@ The following are special variables defined by the package manager for internal |
60 |
not be exported to the ebuild environment: |
61 |
|
62 |
\begin{description} |
63 |
-\item[DEFINED_PHASES] \featurelabel{defined-phases} A space separated arbitrarily ordered list of |
64 |
-phase names (e.\,g.\ \t{configure setup unpack}) whose phase functions are defined by the ebuild or |
65 |
-an eclass inherited by the ebuild. If no phase functions are defined, a single hyphen is used |
66 |
-instead of an empty string. For EAPIs listed in table~\ref{tab:defined-phases-table} as having |
67 |
-optional \t{DEFINED_PHASES} support, package managers may not rely upon the metadata cache having |
68 |
-this variable defined, and must treat an empty string as ``this information is not available''. |
69 |
+\item[DEFINED_PHASES] \featurelabel{defined-phases} A space separated arbitrarily ordered list |
70 |
+ of phase names (e.\,g.\ \t{configure setup unpack}) whose phase functions are defined by the |
71 |
+ ebuild or an eclass inherited by the ebuild. If no phase functions are defined, a single hyphen |
72 |
+ is used instead of an empty string. For EAPIs listed in table~\ref{tab:defined-phases-table} |
73 |
+ as having optional \t{DEFINED_PHASES} support, package managers may not rely upon the metadata |
74 |
+ cache having this variable defined, and must treat an empty string as ``this information is not |
75 |
+ available''. |
76 |
\end{description} |
77 |
|
78 |
\note{Thus, by extension of section~\ref{sec:metadata-invariance}, phase functions must not be |
79 |
|
80 |
diff --git a/eclasses.tex b/eclasses.tex |
81 |
index 7a8bfbd..8305504 100644 |
82 |
--- a/eclasses.tex |
83 |
+++ b/eclasses.tex |
84 |
@@ -29,7 +29,7 @@ The \t{inherit} command must also ensure that: |
85 |
\begin{compactitem} |
86 |
\item The \t{ECLASS} variable is set to the name of the current eclass, when sourcing that eclass. |
87 |
\item Once all inheriting has been done, the \t{INHERITED} metadata variable contains the name of |
88 |
- every eclass used, separated by whitespace. |
89 |
+ every eclass used, separated by whitespace. |
90 |
\end{compactitem} |
91 |
|
92 |
\section{Eclass-defined Metadata Keys} |
93 |
|
94 |
diff --git a/introduction.tex b/introduction.tex |
95 |
index afbe708..b5b63c6 100644 |
96 |
--- a/introduction.tex |
97 |
+++ b/introduction.tex |
98 |
@@ -38,7 +38,7 @@ Patches will be reviewed by the PMS team, who will do one of the following: |
99 |
\begin{compactitem} |
100 |
\item Accept and apply the patch. |
101 |
\item Explain why the patch cannot be applied as-is. The patch may then be updated and resubmitted |
102 |
-if appropriate. |
103 |
+ if appropriate. |
104 |
\item Reject the patch outright. |
105 |
\item Take special action merited by the individual circumstances. |
106 |
\end{compactitem} |
107 |
|
108 |
diff --git a/merge.tex b/merge.tex |
109 |
index d23d5f0..6649d35 100644 |
110 |
--- a/merge.tex |
111 |
+++ b/merge.tex |
112 |
@@ -112,9 +112,9 @@ In order to ensure interoperability with configuration update tools, the followi |
113 |
used by all package managers when merging any regular file: |
114 |
|
115 |
\begin{compactenum} |
116 |
-\item If the directory containing the file to be merged is not listed in \t{CONFIG_PROTECT}, and |
117 |
- is not a subdirectory of any such directory, and if the file is not listed in \t{CONFIG_PROTECT}, |
118 |
- the file is merged normally. |
119 |
+\item If the directory containing the file to be merged is not listed in \t{CONFIG_PROTECT}, and is |
120 |
+ not a subdirectory of any such directory, and if the file is not listed in \t{CONFIG_PROTECT}, |
121 |
+ the file is merged normally. |
122 |
\item If the directory containing the file to be merged is listed in \t{CONFIG_PROTECT_MASK}, or |
123 |
is a subdirectory of such a directory, or if the file is listed in \t{CONFIG_PROTECT_MASK}, |
124 |
the file is merged normally. |
125 |
|
126 |
diff --git a/pkg-mgr-commands.tex b/pkg-mgr-commands.tex |
127 |
index 74c8983..1e414d4 100644 |
128 |
--- a/pkg-mgr-commands.tex |
129 |
+++ b/pkg-mgr-commands.tex |
130 |
@@ -443,12 +443,13 @@ the current phase function has returned. |
131 |
dependent as per section~\ref{sec:failure-behaviour}. |
132 |
|
133 |
\item[dodoc] \featurelabel{dodoc} Installs the given files into a subdirectory under |
134 |
- \t{/usr/share/doc/\$\{PF\}/} with file mode \t{0644}. The subdirectory is set by the most recent |
135 |
- call to \t{docinto}. If \t{docinto} has not yet been called, instead installs to the directory |
136 |
- \t{/usr/share/doc/\$\{PF\}/}. For EAPIs listed in table~\ref{tab:dodoc-table} as supporting \t{-r}, |
137 |
- if the first argument is \t{-r}, any subsequent arguments that are directories are installed |
138 |
- recursively to the appropriate location; in any other case, it is an error for a directory to be |
139 |
- specified. Failure behaviour is EAPI dependent as per section~\ref{sec:failure-behaviour}. |
140 |
+ \t{/usr/share/doc/\$\{PF\}/} with file mode \t{0644}. The subdirectory is set by the most |
141 |
+ recent call to \t{docinto}. If \t{docinto} has not yet been called, instead installs to the |
142 |
+ directory \t{/usr/share/doc/\$\{PF\}/}. For EAPIs listed in table~\ref{tab:dodoc-table} |
143 |
+ as supporting \t{-r}, if the first argument is \t{-r}, any subsequent arguments that are |
144 |
+ directories are installed recursively to the appropriate location; in any other case, it is |
145 |
+ an error for a directory to be specified. Failure behaviour is EAPI dependent as per |
146 |
+ section~\ref{sec:failure-behaviour}. |
147 |
|
148 |
\item[doenvd] Installs the given environment files into \t{/etc/env.d/}, by default with file mode |
149 |
\t{0644}, or with the \t{install} options set by the most recent \t{insopts} call. |
150 |
@@ -1003,12 +1004,12 @@ has returned. |
151 |
|
152 |
\begin{description} |
153 |
\item[dosed] Takes any number of arguments, which can be files or \t{sed} expressions. For each |
154 |
- argument, if it names, relative to \t{ED} (offset-prefix aware EAPIs) or \t{D} (offset-prefix agnostic |
155 |
- EAPIs) a file which exists, then \t{sed} is run with the current expression on that file. Otherwise, |
156 |
- the current expression is set to the text of the argument. The initial value of the expression is |
157 |
- \t{s:\$\{ED\}::g} in offset-prefix aware EAPIs and \t{s:\$\{D\}::g} in offset-prefix agnostic |
158 |
- EAPIs. In EAPIs listed in table~\ref{tab:banned-commands-table}, this command is banned as per |
159 |
- section~\ref{sec:banned-commands}. |
160 |
+ argument, if it names, relative to \t{ED} (offset-prefix aware EAPIs) or \t{D} (offset-prefix |
161 |
+ agnostic EAPIs) a file which exists, then \t{sed} is run with the current expression on that |
162 |
+ file. Otherwise, the current expression is set to the text of the argument. The initial value |
163 |
+ of the expression is \t{s:\$\{ED\}::g} in offset-prefix aware EAPIs and \t{s:\$\{D\}::g} in |
164 |
+ offset-prefix agnostic EAPIs. In EAPIs listed in table~\ref{tab:banned-commands-table}, this |
165 |
+ command is banned as per section~\ref{sec:banned-commands}. |
166 |
|
167 |
\item[unpack] Unpacks one or more source archives, in order, into the current directory. |
168 |
For compressed files, creates the target file in the current directory, with the compression |
169 |
@@ -1036,19 +1037,20 @@ has returned. |
170 |
\item tar files (\t{*.tar}). Ebuilds must ensure that GNU tar is installed. |
171 |
\item gzip-compressed files (\t{*.gz, *.Z}). Ebuilds must ensure that GNU gzip is installed. |
172 |
\item gzip-compressed tar files (\t{*.tar.gz, *.tgz, *.tar.Z}). Ebuilds must ensure that |
173 |
- GNU gzip and GNU tar are installed. |
174 |
+ GNU gzip and GNU tar are installed. |
175 |
\item bzip2-compressed files (\t{*.bz2, *.bz}). Ebuilds must ensure that bzip2 is installed. |
176 |
\item bzip2-compressed tar files (\t{*.tar.bz2, *.tbz2, *.tar.bz, *.tbz}). Ebuilds must ensure |
177 |
- that bzip2 and GNU tar are installed. |
178 |
+ that bzip2 and GNU tar are installed. |
179 |
\item zip files (\t{*.zip, *.ZIP, *.jar}). Ebuilds must ensure that Info-ZIP Unzip is installed. |
180 |
\item 7zip files (\t{*.7z, *.7Z}). Ebuilds must ensure that P7ZIP is installed. |
181 |
\item rar files (\t{*.rar, *.RAR}). Ebuilds must ensure that RARLAB's unrar is installed. |
182 |
\item LHA archives (\t{*.LHA, *.LHa, *.lha, *.lzh}). Ebuilds must ensure that the lha program is |
183 |
- installed. |
184 |
+ installed. |
185 |
\item ar archives (\t{*.a}). Ebuilds must ensure that GNU binutils is installed. |
186 |
\item deb packages (\t{*.deb}). Ebuilds must ensure that the deb2targz program is installed on |
187 |
- those platforms where the GNU binutils ar program is not available and the installed ar program is |
188 |
- incompatible with GNU archives. Otherwise, ebuilds must ensure that GNU binutils is installed. |
189 |
+ those platforms where the GNU binutils ar program is not available and the installed ar |
190 |
+ program is incompatible with GNU archives. Otherwise, ebuilds must ensure that GNU binutils |
191 |
+ is installed. |
192 |
\item lzma-compressed files (\t{*.lzma}). Ebuilds must ensure that XZ Utils is installed. |
193 |
\item lzma-compressed tar files (\t{*.tar.lzma}). Ebuilds must ensure that XZ Utils and GNU tar |
194 |
are installed. |
195 |
|
196 |
diff --git a/profiles.tex b/profiles.tex |
197 |
index 58c6d3b..b423697 100644 |
198 |
--- a/profiles.tex |
199 |
+++ b/profiles.tex |
200 |
@@ -55,11 +55,12 @@ and may contain \t{a-zA-Z0-9_} only. Additional syntax, which is a small subset |
201 |
bash syntax, is allowed as follows: |
202 |
|
203 |
\begin{compactitem} |
204 |
-\item Variables to the right of the equals sign in the form \t{\$\{foo\}} or \t{\$foo} are recognised and |
205 |
- expanded from variables previously set in this or earlier \t{make.defaults} files. |
206 |
-\item One logical line may be continued over multiple physical lines by escaping the newline with a |
207 |
- backslash. A quoted string may be continued over multiple physical lines by either a simple |
208 |
- newline or a backslash-escaped newline. |
209 |
+\item Variables to the right of the equals sign in the form \t{\$\{foo\}} or \t{\$foo} are |
210 |
+ recognised and expanded from variables previously set in this or earlier \t{make.defaults} |
211 |
+ files. |
212 |
+\item One logical line may be continued over multiple physical lines by escaping the newline with |
213 |
+ a backslash. A quoted string may be continued over multiple physical lines by either a simple |
214 |
+ newline or a backslash-escaped newline. |
215 |
\item Backslashes, except for line continuations, are not allowed. |
216 |
\end{compactitem} |
217 |
|
218 |
|
219 |
diff --git a/tree-layout.tex b/tree-layout.tex |
220 |
index 9e60af4..9397e4b 100644 |
221 |
--- a/tree-layout.tex |
222 |
+++ b/tree-layout.tex |
223 |
@@ -30,9 +30,9 @@ be contained in one directory, whose name shall be that of the |
224 |
category. Each category directory shall contain: |
225 |
\begin{compactitem} |
226 |
\item A \t{metadata.xml} file, as described in appendix~\ref{sec:metadata-xml}\@. Optional. |
227 |
-\item Zero or more package directories, one for each package in the |
228 |
- category, as described in section~\ref{sec:package-dirs}. The name of |
229 |
- the package directory shall be the corresponding package name. |
230 |
+\item Zero or more package directories, one for each package in the category, as described in |
231 |
+ section~\ref{sec:package-dirs}. The name of the package directory shall be the corresponding |
232 |
+ package name. |
233 |
\end{compactitem} |
234 |
|
235 |
Category directories may contain additional files, whose purpose is not covered by this |