1 |
commit: 5267d136c1e9131f550d85eb99275f2579554418 |
2 |
Author: Ulrich Müller <ulm <AT> gentoo <DOT> org> |
3 |
AuthorDate: Sat Feb 24 12:43:12 2018 +0000 |
4 |
Commit: Ulrich Müller <ulm <AT> gentoo <DOT> org> |
5 |
CommitDate: Sat Feb 24 12:43:12 2018 +0000 |
6 |
URL: https://gitweb.gentoo.org/proj/pms.git/commit/?id=5267d136 |
7 |
|
8 |
Make letter case more consistent. |
9 |
|
10 |
Write "algorithm", "listing" and "table" in sentence case throughout |
11 |
the document. |
12 |
|
13 |
names.tex | 14 +++++++------- |
14 |
pkg-mgr-commands.tex | 24 ++++++++++++------------ |
15 |
profiles.tex | 4 ++-- |
16 |
3 files changed, 21 insertions(+), 21 deletions(-) |
17 |
|
18 |
diff --git a/names.tex b/names.tex |
19 |
index d60e97b..be55698 100644 |
20 |
--- a/names.tex |
21 |
+++ b/names.tex |
22 |
@@ -75,7 +75,7 @@ This may optionally be followed by the suffix \t{-r} followed immediately by an |
23 |
\section{Version Comparison} |
24 |
|
25 |
Version specifications are compared component by component, moving from left to right, |
26 |
-as detailed in Algorithm~\ref{alg:version-comparison} and sub-algorithms. |
27 |
+as detailed in algorithm~\ref{alg:version-comparison} and sub-algorithms. |
28 |
If a sub-algorithm returns a decision, then that is the result of the whole comparison; |
29 |
if it terminates without returning a decision, the process continues from the point |
30 |
from which it was invoked. |
31 |
@@ -84,10 +84,10 @@ from which it was invoked. |
32 |
\caption{Version comparison top-level logic} \label{alg:version-comparison} |
33 |
\begin{algorithmic}[1] |
34 |
\STATE let $A$ and $B$ be the versions to be compared |
35 |
- \STATE compare numeric components using Algorithm~\ref{alg:version-comparison-numeric} |
36 |
- \STATE compare letter components using Algorithm~\ref{alg:version-comparison-letter} |
37 |
- \STATE compare suffixes using Algorithm~\ref{alg:version-comparison-suffix} |
38 |
- \STATE compare revision components using Algorithm~\ref{alg:version-comparison-revision} |
39 |
+ \STATE compare numeric components using algorithm~\ref{alg:version-comparison-numeric} |
40 |
+ \STATE compare letter components using algorithm~\ref{alg:version-comparison-letter} |
41 |
+ \STATE compare suffixes using algorithm~\ref{alg:version-comparison-suffix} |
42 |
+ \STATE compare revision components using algorithm~\ref{alg:version-comparison-revision} |
43 |
\RETURN $A=B$ |
44 |
\end{algorithmic} |
45 |
\end{algorithm} |
46 |
@@ -105,7 +105,7 @@ from which it was invoked. |
47 |
\STATE let $Ann$ be the number of numeric components of $A$ |
48 |
\STATE let $Bnn$ be the number of numeric components of $B$ |
49 |
\FORALL{$i$ such that $i\geq1$ and $i<Ann$ and $i<Bnn$, in ascending order} |
50 |
- \STATE compare $An_i$ and $Bn_i$ using Algorithm~\ref{alg:version-comparison-numeric-nonfirst} |
51 |
+ \STATE compare $An_i$ and $Bn_i$ using algorithm~\ref{alg:version-comparison-numeric-nonfirst} |
52 |
\ENDFOR |
53 |
\IF{$Ann>Bnn$} |
54 |
\RETURN $A>B$ |
55 |
@@ -158,7 +158,7 @@ from which it was invoked. |
56 |
\STATE let $Asn$ be the number of suffixes of $A$ |
57 |
\STATE let $Bsn$ be the number of suffixes of $B$ |
58 |
\FORALL{$i$ such that $i\geq0$ and $i<Asn$ and $i<Bsn$, in ascending order} |
59 |
- \STATE compare $As_i$ and $Bs_i$ using Algorithm~\ref{alg:version-comparison-suffix-each} |
60 |
+ \STATE compare $As_i$ and $Bs_i$ using algorithm~\ref{alg:version-comparison-suffix-each} |
61 |
\ENDFOR |
62 |
\IF{$Asn>Bsn$} |
63 |
\IF{$As_{Bsn}$ is of type \t{_p}} |
64 |
|
65 |
diff --git a/pkg-mgr-commands.tex b/pkg-mgr-commands.tex |
66 |
index 7883709..07abfbb 100644 |
67 |
--- a/pkg-mgr-commands.tex |
68 |
+++ b/pkg-mgr-commands.tex |
69 |
@@ -165,7 +165,7 @@ Ebuilds must not run any of these commands once the current phase function has r |
70 |
\begin{description} |
71 |
\item[eapply] \featurelabel{eapply} Takes zero or more GNU patch options, followed by one or more |
72 |
file or directory paths. Processes options and applies all patches found in specified locations |
73 |
- according to Algorithm~\ref{alg:eapply}. If applying the patches fails, it aborts the build |
74 |
+ according to algorithm~\ref{alg:eapply}. If applying the patches fails, it aborts the build |
75 |
using \t{die}, unless run using \t{nonfatal}, in which case it returns non-zero exit status. |
76 |
Only available in EAPIs listed in table~\ref{tab:patch-commands} as supporting \t{eapply}. |
77 |
|
78 |
@@ -263,7 +263,7 @@ current phase function has returned. |
79 |
\item -{}-host must be the value of the \t{CHOST} environment variable. |
80 |
\item -{}-target must be the value of the \t{CTARGET} environment variable. This option will |
81 |
only be passed if \t{CTARGET} is non-empty. |
82 |
- \item -{}-libdir must be set according to Algorithm~\ref{alg:econf-libdir}. |
83 |
+ \item -{}-libdir must be set according to algorithm~\ref{alg:econf-libdir}. |
84 |
\item -{}-disable-dependency-tracking, if the EAPI is listed in |
85 |
table~\ref{tab:econf-options-table} as using it. This option will only be passed if the |
86 |
string \t{-{}-disable-dependency-tracking} occurs in the output of \t{configure -{}-help}. |
87 |
@@ -292,8 +292,8 @@ current phase function has returned. |
88 |
\end{centertable} |
89 |
|
90 |
Note that the \t{\$\{EPREFIX\}} component represents the same offset-prefix as described in |
91 |
- Table~\ref{tab:defined-vars}. It facilitates offset-prefix installations which is supported by |
92 |
- EAPIs listed in Table~\ref{tab:offset-env-vars-table}. When no offset-prefix installation is in |
93 |
+ table~\ref{tab:defined-vars}. It facilitates offset-prefix installations which is supported by |
94 |
+ EAPIs listed in table~\ref{tab:offset-env-vars-table}. When no offset-prefix installation is in |
95 |
effect, \t{EPREFIX} becomes the empty string, making the behaviour of \t{econf} equal for both |
96 |
offset-prefix supporting and agnostic EAPIs. |
97 |
|
98 |
@@ -327,19 +327,19 @@ current phase function has returned. |
99 |
section~\ref{sec:guaranteed-system-commands}. \t{emake} must be an external program and cannot |
100 |
be a function or alias---it must be callable from e.\,g.\ \t{xargs}. Failure behaviour is EAPI |
101 |
dependent as per section~\ref{sec:failure-behaviour}. |
102 |
-\item[einstall] A shortcut for the command given in Listing~\ref{lst:einstall}. Any arguments given |
103 |
+\item[einstall] A shortcut for the command given in listing~\ref{lst:einstall}. Any arguments given |
104 |
to \t{einstall} are passed verbatim to \t{emake}, as shown. Failure behaviour is EAPI dependent |
105 |
as per section~\ref{sec:failure-behaviour}. |
106 |
In EAPIs listed in table~\ref{tab:banned-commands-table}, this command is banned as per |
107 |
section~\ref{sec:banned-commands}. |
108 |
|
109 |
- The variable \t{ED} is defined as in Table~\ref{tab:defined-vars} and depends on the use of an |
110 |
+ The variable \t{ED} is defined as in table~\ref{tab:defined-vars} and depends on the use of an |
111 |
offset-prefix. When such offset-prefix is absent, \t{ED} is equivalent to \t{D}\@. \t{ED} is |
112 |
always available in EAPIs that support offset-prefix installations as listed in |
113 |
- Table~\ref{tab:offset-env-vars-table}, hence EAPIs lacking offset-prefix support should use |
114 |
- \t{D} instead of \t{ED} in the command given in Listing~\ref{lst:einstall}. |
115 |
+ table~\ref{tab:offset-env-vars-table}, hence EAPIs lacking offset-prefix support should use |
116 |
+ \t{D} instead of \t{ED} in the command given in listing~\ref{lst:einstall}. |
117 |
Variable \t{libdir} is an auxiliary local variable whose value is determined by |
118 |
- Algorithm~\ref{alg:ebuild-libdir}. |
119 |
+ algorithm~\ref{alg:ebuild-libdir}. |
120 |
|
121 |
\begin{listing}[H] |
122 |
\caption{\t{einstall} command} \label{lst:einstall} |
123 |
@@ -457,7 +457,7 @@ can be extended or reduced (see below). The options that can be passed to \t{doh |
124 |
section~\ref{sec:failure-behaviour}. |
125 |
|
126 |
\item[dolib] For each argument, installs it into the appropriate library subdirectory under |
127 |
- \t{DESTTREE}, as determined by Algorithm~\ref{alg:ebuild-libdir}. Files are installed by default |
128 |
+ \t{DESTTREE}, as determined by algorithm~\ref{alg:ebuild-libdir}. Files are installed by default |
129 |
with file mode \t{0644}, or with the \t{install} options set by the most recent \t{libopts} |
130 |
call. Any symlinks are installed into the same directory as relative links to their original |
131 |
target. Failure behaviour is EAPI dependent as per section~\ref{sec:failure-behaviour}. |
132 |
@@ -927,7 +927,7 @@ has returned. |
133 |
|
134 |
\item[einstalldocs] \featurelabel{einstalldocs} Takes no arguments. Installs the files specified |
135 |
by the \t{DOCS} and \t{HTML_DOCS} variables or a default set of files, according to |
136 |
- Algorithm~\ref{alg:einstalldocs}. If called using \t{nonfatal} and any of the called commands |
137 |
+ algorithm~\ref{alg:einstalldocs}. If called using \t{nonfatal} and any of the called commands |
138 |
returns a non-zero exit status, returns immediately with the same exit status. Only available |
139 |
in EAPIs listed in table~\ref{tab:misc-commands} as supporting \t{einstalldocs}. |
140 |
|
141 |
@@ -960,7 +960,7 @@ has returned. |
142 |
\end{algorithm} |
143 |
|
144 |
\item[get_libdir] \featurelabel{get-libdir} Prints the libdir name obtained according to |
145 |
- Algorithm~\ref{alg:get-libdir}. Only available in EAPIs listed in table~\ref{tab:misc-commands} |
146 |
+ algorithm~\ref{alg:get-libdir}. Only available in EAPIs listed in table~\ref{tab:misc-commands} |
147 |
as supporting \t{get_libdir}. |
148 |
|
149 |
\begin{algorithm} |
150 |
|
151 |
diff --git a/profiles.tex b/profiles.tex |
152 |
index 88fc397..7299350 100644 |
153 |
--- a/profiles.tex |
154 |
+++ b/profiles.tex |
155 |
@@ -140,7 +140,7 @@ stable in a package. |
156 |
|
157 |
The precise manner in which the eight files interact is less simple, and is best described in terms |
158 |
of the algorithm used to determine whether a flag is masked for a given package version. This is |
159 |
-described in Algorithm~\ref{alg:use-masking}. |
160 |
+described in algorithm~\ref{alg:use-masking}. |
161 |
\begin{algorithm} |
162 |
\caption{\t{USE} masking logic} \label{alg:use-masking} |
163 |
\begin{algorithmic}[1] |
164 |
@@ -178,7 +178,7 @@ described in Algorithm~\ref{alg:use-masking}. |
165 |
\end{algorithmic} |
166 |
\end{algorithm} |
167 |
|
168 |
-Stable restrictions (``stable keyword in use'' in Algorithm~\ref{alg:use-masking}) are applied |
169 |
+Stable restrictions (``stable keyword in use'' in algorithm~\ref{alg:use-masking}) are applied |
170 |
exactly if replacing in \t{KEYWORDS} all stable keywords by the corresponding tilde prefixed |
171 |
keywords (see subsection~\ref{sec:keywords}) would result in the package installation being |
172 |
prevented due to the \t{KEYWORDS} setting. |