[gentoo-commits] proj/pms:eapi-6 commit in: /

["Ulrich Müller" <ulm@gentoo.org>]

commit:     70a153d64d99a7daeec55abd2d1aed326a8b19c7
Author:     Ulrich Müller <ulm <AT> gentoo <DOT> org>
AuthorDate: Tue Mar 24 18:36:05 2015 +0000
Commit:     Ulrich Müller <ulm <AT> gentoo <DOT> org>
CommitDate: Tue Mar 24 18:36:05 2015 +0000
URL:        https://gitweb.gentoo.org/proj/pms.git/commit/?id=70a153d6

Typographic fixes to make chktex happier.

 dependencies.tex      |  8 ++++----
 ebuild-env-vars.tex   | 26 ++++++++++++++------------
 ebuild-format.tex     | 10 +++++-----
 ebuild-functions.tex  |  4 ++--
 ebuild-vars.tex       |  4 ++--
 eclasses.tex          |  2 +-
 merge.tex             |  2 +-
 pkg-mgr-commands.tex  | 26 +++++++++++++-------------
 profile-variables.tex | 10 +++++-----
 profiles.tex          | 10 +++++-----
 tree-layout.tex       | 10 +++++-----
 11 files changed, 57 insertions(+), 55 deletions(-)

diff --git a/dependencies.tex b/dependencies.tex
index cf7f33e..0d22489 100644
--- a/dependencies.tex
+++ b/dependencies.tex
@@ -48,10 +48,10 @@ be surrounded on both sides by whitespace, except at the start and end of the st
 
 \begin{compactitem}
 \item A package dependency specification. Permitted in \t{DEPEND}, \t{RDEPEND}, \t{PDEPEND}.
-\item A URI, in the form \t{proto://host/path}. Permitted in \t{SRC\_URI} and \t{HOMEPAGE}. In EAPIs
-    listed in table~\ref{tab:uri-arrows-table} as supporting \t{SRC\_URI} arrows, may optionally be
-    followed by whitespace, then \t{->}, then whitespace, then a simple filename when in
-    \t{SRC\_URI}.  For \t{SRC\_URI} behaviour, see section~\ref{sec:src-uri-behaviour}.
+\item A URI, in the form \t{proto://host/path}. Permitted in \t{SRC\_URI} and \t{HOMEPAGE}\@.
+    In EAPIs listed in table~\ref{tab:uri-arrows-table} as supporting \t{SRC\_URI} arrows, may
+    optionally be followed by whitespace, then \t{->}, then whitespace, then a simple filename when
+    in \t{SRC\_URI}\@. For \t{SRC\_URI} behaviour, see section~\ref{sec:src-uri-behaviour}.
 \item A flat filename. Permitted in \t{SRC\_URI}.
 \item A license name (e.\,g.\ \t{GPL-2}). Permitted in \t{LICENSE}.
 \item A use flag name, optionally preceded by an exclamation mark. Permitted in \t{REQUIRED\_USE}.

diff --git a/ebuild-env-vars.tex b/ebuild-env-vars.tex
index 8969dd8..0cccd8f 100644
--- a/ebuild-env-vars.tex
+++ b/ebuild-env-vars.tex
@@ -131,10 +131,11 @@ variable.
     Yes &
     The normalised offset-prefix path of an offset installation.  When \t{EPREFIX} is not set in the
     calling environment, \t{EPREFIX} defaults to the built-in offset-prefix that was set during
-    installation of the package manager. When a different \t{EPREFIX} value than the built-in value is set
-    in the calling environment, a cross-prefix build is performed where using the existing utilities, a
-    package is built for the given \t{EPREFIX}, akin to \t{ROOT}. See also~\ref{sec:offset-vars}. Only
-    for EAPIs listed in table~\ref{tab:offset-env-vars-table} as supporting \t{EPREFIX}. \\
+    installation of the package manager. When a different \t{EPREFIX} value than the built-in value
+    is set in the calling environment, a cross-prefix build is performed where using the existing
+    utilities, a package is built for the given \t{EPREFIX}, akin to \t{ROOT}\@.
+    See also~\ref{sec:offset-vars}. Only for EAPIs listed in table~\ref{tab:offset-env-vars-table}
+    as supporting \t{EPREFIX}. \\
 \t{D} &
     \t{src\_install} &
     No &
@@ -396,14 +397,15 @@ contain at most one value.
     \end{tabular}
 \end{centertable}
 
-\featurelabel{offset-prefix-vars} Table~\ref{tab:offset-support-table} lists the EAPIs which support
-offset-prefix installations. This support was initially added in EAPI 3, in the form of three extra
-variables.  Two of these, \t{EROOT} and \t{ED}, are convenience variables using the variable
-\t{EPREFIX}. In EAPIs that do not support an offset-prefix, the installation offset is hardwired to
-\t{/usr}. In offset-prefix supporting EAPIs the installation offset is set as \t{\$\{EPREFIX\}/usr}
-and hence can be adjusted using the variable \t{EPREFIX}. Note that the behaviour of offset-prefix
-aware and agnostic is the same when \t{EPREFIX} is set to the empty string in offset-prefix aware
-EAPIs.  The latter do have the variables \t{ED} and \t{EROOT} properly set, though.
+\featurelabel{offset-prefix-vars} Table~\ref{tab:offset-support-table} lists the EAPIs which
+support offset-prefix installations. This support was initially added in EAPI 3, in the form of
+three extra variables. Two of these, \t{EROOT} and \t{ED}, are convenience variables using the
+variable \t{EPREFIX}\@. In EAPIs that do not support an offset-prefix, the installation offset is
+hardwired to \t{/usr}. In offset-prefix supporting EAPIs the installation offset is set as
+\t{\$\{EPREFIX\}/usr} and hence can be adjusted using the variable \t{EPREFIX}\@. Note that the
+behaviour of offset-prefix aware and agnostic is the same when \t{EPREFIX} is set to the empty
+string in offset-prefix aware EAPIs. The latter do have the variables \t{ED} and \t{EROOT} properly
+set, though.
 
 % vim: set filetype=tex fileencoding=utf8 et tw=100 spell spelllang=en :
 

diff --git a/ebuild-format.tex b/ebuild-format.tex
index befe679..3028e50 100644
--- a/ebuild-format.tex
+++ b/ebuild-format.tex
@@ -2,11 +2,11 @@
 \label{sec:ebuild-format}
 
 The ebuild file format is in its basic form a subset of the format of a bash script. The interpreter
-is assumed to be GNU bash, version 3.2 or later, see footnote \ref{fn:bash3.2} on page
-\pageref{fn:bash3.2}.  The file encoding must be UTF-8 with Unix-style newlines. When sourced, the
-ebuild must define certain variables and functions (see sections~\ref{sec:ebuild-vars} and
-\ref{sec:ebuild-functions} for specific information), and must not call any external programs, write
-anything to standard output or standard error, or modify the state of the system in any way.
+is assumed to be GNU bash, version 3.2 or later, see footnote~\ref{fn:bash3.2} on
+page~\pageref{fn:bash3.2}. The file encoding must be UTF-8 with Unix-style newlines. When sourced,
+the ebuild must define certain variables and functions (see sections~\ref{sec:ebuild-vars}
+and~\ref{sec:ebuild-functions} for specific information), and must not call any external programs,
+write anything to standard output or standard error, or modify the state of the system in any way.
 
 % vim: set filetype=tex fileencoding=utf8 et tw=100 spell spelllang=en :
 

diff --git a/ebuild-functions.tex b/ebuild-functions.tex
index 84847e9..c6c43b4 100644
--- a/ebuild-functions.tex
+++ b/ebuild-functions.tex
@@ -29,7 +29,7 @@ initial working directory for any phase is a trusted location that may only be w
 privileged user and group.
 
 \featurelabel{s-workdir-fallback} Some functions are described as having an initial working
-directory of \t{S} with an error or fallback to \t{WORKDIR}. For EAPIs listed in
+directory of \t{S} with an error or fallback to \t{WORKDIR}\@. For EAPIs listed in
 table~\ref{tab:s-fallback-table} as having the fallback, this means that if \t{S} is not a directory
 before the start of the phase function, the initial working directory shall be \t{WORKDIR} instead.
 For EAPIs where it is a conditional error, if \t{S} is not a directory before the start of the phase
@@ -272,7 +272,7 @@ non-zero the build must be aborted.
 \featurelabel{parallel-tests} For EAPIs listed in table~\ref{tab:src-test-table} as not supporting
 parallel tests, the \t{emake} command must be called with option \t{-j1}.
 
-The \t{src\_test} function may be disabled by \t{RESTRICT}. See section~\ref{sec:restrict}. It may
+The \t{src\_test} function may be disabled by \t{RESTRICT}\@. See section~\ref{sec:restrict}. It may
 be disabled by user too, using a PM-specific mechanism.
 
 \ChangeWhenAddingAnEAPI{5}

diff --git a/ebuild-vars.tex b/ebuild-vars.tex
index 53de53d..d626d24 100644
--- a/ebuild-vars.tex
+++ b/ebuild-vars.tex
@@ -44,7 +44,7 @@ All ebuilds must define at least the following variables:
 Ebuilds may define any of the following variables:
 
 \begin{description}
-\item[EAPI] The EAPI. See below.
+\item[EAPI] The EAPI\@. See below.
 \item[HOMEPAGE] The URI or URIs for a package's homepage, including protocols.
     See section~\ref{sec:dependencies} for full syntax.
 \item[SRC\_URI] A list of source URIs for the package. Valid protocols are \t{http://},
@@ -202,7 +202,7 @@ the ebuild portion, and any \t{DEPEND} value set in an eclass does not get treat
 
 \section{Magic Ebuild-defined Variables}
 
-The following variables must be defined by \t{inherit} (see section~\ref{sec:inherit}, and may be
+The following variables must be defined by \t{inherit} (see section~\ref{sec:inherit}), and may be
 considered to be part of the ebuild's metadata:
 
 \begin{description}

diff --git a/eclasses.tex b/eclasses.tex
index c8fee9e..2eb58ca 100644
--- a/eclasses.tex
+++ b/eclasses.tex
@@ -43,7 +43,7 @@ implicit \t{RDEPEND} rules in section~\ref{sec:rdepend-depend} are applied.
 \section{EXPORT\_FUNCTIONS}
 
 There is one command available in the eclass environment that is neither available nor meaningful
-in ebuilds---\t{EXPORT\_FUNCTIONS}. This can be used to alias ebuild phase functions from the
+in ebuilds---\t{EXPORT\_FUNCTIONS}\@. This can be used to alias ebuild phase functions from the
 eclass so that an ebuild inherits a default definition whilst retaining the ability to override and
 call the eclass-defined version from it. The use of it is best illustrated by an example; this is
 given in listing~\ref{lst:export-functions} and is a snippet from a hypothetical \t{foo.eclass}.

diff --git a/merge.tex b/merge.tex
index bc74193..28cde65 100644
--- a/merge.tex
+++ b/merge.tex
@@ -4,7 +4,7 @@
 
 \section{Overview}
 
-The merge process merges the contents of the \t{D} directory onto the filesystem under \t{ROOT}.
+The merge process merges the contents of the \t{D} directory onto the filesystem under \t{ROOT}\@.
 This is not a straight copy; there are various subtleties which must be addressed.
 
 The unmerge process removes an installed package's files. It is not covered in detail in this

diff --git a/pkg-mgr-commands.tex b/pkg-mgr-commands.tex
index ef65793..9c031fe 100644
--- a/pkg-mgr-commands.tex
+++ b/pkg-mgr-commands.tex
@@ -218,10 +218,10 @@ current phase function has returned.
     as per section~\ref{sec:failure-behaviour}.
 
     The variable \t{ED} is defined as in Table~\ref{tab:defined_vars} and depends on the use of an
-    offset-prefix. When such offset-prefix is absent, \t{ED} is equivalent to \t{D}. \t{ED} is always
-    available in EAPIs that support offset-prefix installations as listed in
-    Table~\ref{tab:offset-env-vars-table}, hence EAPIs lacking offset-prefix support should use \t{D}
-    instead of \t{ED} in the command given in Listing~\ref{lst:einstall}.
+    offset-prefix. When such offset-prefix is absent, \t{ED} is equivalent to \t{D}\@. \t{ED} is
+    always available in EAPIs that support offset-prefix installations as listed in
+    Table~\ref{tab:offset-env-vars-table}, hence EAPIs lacking offset-prefix support should use
+    \t{D} instead of \t{ED} in the command given in Listing~\ref{lst:einstall}.
     Variable \t{libdir} is an auxiliary local variable whose value is determined by
     Algorithm~\ref{alg:ebuild-libdir}.
 \begin{listing}[H]
@@ -386,7 +386,7 @@ can be extended or reduced (see below). The options that can be passed to \t{doh
 
 \item[domo] Installs the given \t{.mo} files with file mode \t{0644} into the appropriate
     subdirectory of \t{DESTTREE\slash share\slash locale}, generated by taking the basename of the
-    file, removing the \t{.*} suffix, and appending \t{/LC\_MESSAGES}. The name of the installed
+    file, removing the \t{.*} suffix, and appending \t{/LC\_MESSAGES}\@. The name of the installed
     files is the package name with \t{.mo} appended. Failure behaviour is EAPI dependent as per
     section~\ref{sec:failure-behaviour}.
 
@@ -566,13 +566,13 @@ has returned.
 \item[docinto] Sets the install subdirectory for \t{dodoc} et al. May create the directory, as specified
     for \t{into}.
 
-\item[insopts] Sets the options passed by \t{doins} et al. to the \t{install} command.
+\item[insopts] Sets the options passed by \t{doins} et al.\ to the \t{install} command.
 
-\item[diropts] Sets the options passed by \t{dodir} et al. to the \t{install} command.
+\item[diropts] Sets the options passed by \t{dodir} et al.\ to the \t{install} command.
 
-\item[exeopts] Sets the options passed by \t{doexe} et al. to the \t{install} command.
+\item[exeopts] Sets the options passed by \t{doexe} et al.\ to the \t{install} command.
 
-\item[libopts] Sets the options passed by \t{dolib} et al. to the \t{install} command.
+\item[libopts] Sets the options passed by \t{dolib} et al.\ to the \t{install} command.
 
 \end{description}
 
@@ -667,8 +667,8 @@ either behaviour is undefined or it is an error as decided by table~\ref{tab:use
     \t{-{}-with-\$\{opt\}=\$\{value\}} if the third argument was provided, and
     \t{-{}-with-\$\{opt\}} otherwise. If the flag is not set, then it outputs
     \t{-{}-without-\$\{opt\}}.
-\item[use\_enable] Works the same as \t{use\_with()}, but outputs \t{-{}-enable-} or \t{-{}-disable-}
-instead of \t{-{}-with-} or \t{-{}-without-}.
+\item[use\_enable] Works the same as \t{use\_with()}, but outputs \t{-{}-enable-} or
+    \t{-{}-disable-} instead of \t{-{}-with-} or \t{-{}-without-}.
 \item[usex] \featurelabel{usex} Accepts at least one and at most five arguments. The first argument
     is a USE flag name, any subsequent arguments (\t{\$\{arg2\}} to \t{\$\{arg5\}}) are string
     values. If not provided, \t{\$\{arg2\}} and \t{\$\{arg3\}} default to \t{yes} and \t{no},
@@ -817,8 +817,8 @@ has returned.
 
 \item[default]
     \featurelabel{default-func} Calls the \t{default\_} function for the current phase (see
-    section~\ref{sec:default-phase-funcs}).  Must not be called if the \t{default\_} function
-    does not exist for the current phase in the current EAPI.  Only available in EAPIs listed in
+    section~\ref{sec:default-phase-funcs}). Must not be called if the \t{default\_} function does
+    not exist for the current phase in the current EAPI\@. Only available in EAPIs listed in
     table~\ref{tab:default-function-table}.
 \end{description}
 

diff --git a/profile-variables.tex b/profile-variables.tex
index a52f21b..a76fdb7 100644
--- a/profile-variables.tex
+++ b/profile-variables.tex
@@ -65,12 +65,12 @@ The following variables have specific meanings when set in profiles.
     section~\ref{sec:use-iuse-handling} for details.
 \item[USE\_EXPAND\_UNPREFIXED] Similar to \t{USE\_EXPAND}, but no prefix is used. If the repository
     contains any package using an EAPI supporting profile-defined \t{IUSE} injection (see
-    table~\ref{tab:profile-iuse-injection-table}), this list must contain at least \t{ARCH}. See
-    section~\ref{sec:use-iuse-handling} for details.
+    table~\ref{tab:profile-iuse-injection-table}), this list must contain at least \t{ARCH}\@.
+    See section~\ref{sec:use-iuse-handling} for details.
 \item[USE\_EXPAND\_HIDDEN] Contains a (possibly empty) subset of names from \t{USE\_EXPAND} and
-    \t{USE\_EXPAND\_UNPREFIXED}. The package manager may use this set as a hint to avoid displaying
-    uninteresting or unhelpful information to an end user.
-\item[USE\_EXPAND\_IMPLICIT, IUSE\_IMPLICIT] Used to inject implicit values into \t{IUSE}. See
+    \t{USE\_EXPAND\_UNPREFIXED}\@. The package manager may use this set as a hint to avoid
+    displaying uninteresting or unhelpful information to an end user.
+\item[USE\_EXPAND\_IMPLICIT, IUSE\_IMPLICIT] Used to inject implicit values into \t{IUSE}\@. See
     section~\ref{sec:use-iuse-handling} for details.
 \end{description}
 

diff --git a/profiles.tex b/profiles.tex
index b33e1b1..ca3b1d7 100644
--- a/profiles.tex
+++ b/profiles.tex
@@ -29,11 +29,11 @@ This file must not contain comments, blank lines or make use of line continuatio
 
 \subsection{The eapi file}
 \label{sec:profile-eapi}
-A profile directory may contain an \t{eapi} file. This file, if it exists, must contain a single line
-with the name of an EAPI. This specifies the EAPI to use when handling the directory in question; a
-package manager must not attempt to use any profile using a directory which requires an EAPI it does
-not support. If no \t{eapi} file is present, EAPI 0 shall be used. The EAPI is not inherited via the
-\t{parent} file.
+A profile directory may contain an \t{eapi} file. This file, if it exists, must contain a single
+line with the name of an EAPI\@. This specifies the EAPI to use when handling the directory in
+question; a package manager must not attempt to use any profile using a directory which requires an
+EAPI it does not support. If no \t{eapi} file is present, EAPI 0 shall be used. The EAPI is not
+inherited via the \t{parent} file.
 
 \subsection{deprecated}
 If a profile contains a file named \t{deprecated}, it is treated as such. The first line of this

diff --git a/tree-layout.tex b/tree-layout.tex
index 134a0bb..388a7c9 100644
--- a/tree-layout.tex
+++ b/tree-layout.tex
@@ -53,7 +53,7 @@ A package directory contains the following:
 \item A \t{metadata.xml} file, as described in appendix~\ref{sec:metadata-xml}\@. Optional only for
     legacy support.
 \item A \t{ChangeLog}, in a format determined by the provider of the repository. Optional.
-\item A \t{Manifest} file, whose format is described in \cite{Glep44}.
+\item A \t{Manifest} file, whose format is described in~\cite{Glep44}.
 \item A \t{files} directory, containing any support files needed by the ebuilds. Optional.
 \end{compactitem}
 
@@ -86,9 +86,9 @@ contents of this directory, with the exception of \t{repo\_name}, are
 optional.
 
 The profiles directory may contain an \t{eapi} file. This file, if it exists, must contain a single
-line with the name of an EAPI. This specifies the EAPI to use when handling the profiles directory;
-a package manager must not attempt to use any repository whose profile directory requires an EAPI it
-does not support. If no \t{eapi} file is present, EAPI 0 shall be used.
+line with the name of an EAPI\@. This specifies the EAPI to use when handling the profiles
+directory; a package manager must not attempt to use any repository whose profile directory
+requires an EAPI it does not support. If no \t{eapi} file is present, EAPI 0 shall be used.
 
 If the repository is not intended to be stand-alone, the contents of these files are to be taken
 from or merged with the master repository as necessary.
@@ -195,7 +195,7 @@ differs from that described in \t{use.desc}.
 \subsection{The updates directory}
 \label{sec:updates-dir}
 The \t{updates} directory is used to inform the package manager that a package has moved categories,
-names, or that a version has changed SLOT. It contains one file per quarter year, named
+names, or that a version has changed SLOT\@. It contains one file per quarter year, named
 \t{[1-4]Q-[YYYY]} for the first to fourth quarter of a given year, for example \t{1Q-2004} or
 \t{3Q-2006}. The format of each file is again line-based, with each line having one of the following
 formats: