[gentoo-commits] proj/pms:master commit in: /

["Ulrich Mueller" <ulm@gentoo.org>]

commit:     a460436e1722831d36d9316de853a529c74a7929
Author:     Ulrich Müller <ulm <AT> gentoo <DOT> org>
AuthorDate: Sat Sep 15 12:42:33 2012 +0000
Commit:     Ulrich Mueller <ulm <AT> gentoo <DOT> org>
CommitDate: Sun Sep 16 21:12:25 2012 +0000
URL:        http://git.overlays.gentoo.org/gitweb/?p=proj/pms.git;a=commit;h=a460436e

Tune LaTeX formatting to suppress overfull boxes in output.

- Change teletype font from Courier to Computer Modern Typewriter which
  is narrower.
- Be more tolerant when formatting paragraphs, to avoid overfull boxes.
  Do this by increasing \tolerance, \hfuzz, and \emergencystretch.
- Allow line breaks after underscores (but with a large penalty).
- The second column of the "defined variables" table was too narrow.
- Increase the width of margin notes to 40 mm (was about 33 mm before).
- Rename the two longest featurelabels (profile-iuse-injection and
  controllable-compress) because they still didn't fit into the margin.
- I'd rather have avoided explicit \allowbreak commands, but in very few
  cases there is no other way.

---
 eapi-cheatsheet.tex  |    2 +-
 eapi-differences.tex |   10 +++++-----
 ebuild-env-vars.tex  |    7 +++----
 pkg-mgr-commands.tex |   15 ++++++++-------
 pms.cls              |   12 +++++++++++-
 profiles.tex         |   17 +++++++++--------
 tree-layout.tex      |    7 ++++---
 7 files changed, 41 insertions(+), 29 deletions(-)

diff --git a/eapi-cheatsheet.tex b/eapi-cheatsheet.tex
index 927c5f3..57c95a1 100644
--- a/eapi-cheatsheet.tex
+++ b/eapi-cheatsheet.tex
@@ -190,7 +190,7 @@ nonetheless.
     \code{/usr/share/doc/\$\{PF\}/html}.  \code{docompress path \dots}
     adds paths to the inclusion list for compression.
     \code{docompress -x path \dots} adds paths to the exclusion list.
-    See \featureref{controllable-compress}.
+    See \featureref{docompress}.
     \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}.

diff --git a/eapi-differences.tex b/eapi-differences.tex
index 2b28ff2..3a33bce 100644
--- a/eapi-differences.tex
+++ b/eapi-differences.tex
@@ -124,7 +124,7 @@ Parallel tests & \compactfeatureref{parallel-tests} &
 \t{MERGE\_TYPE} & \compactfeatureref{merge-type} &
     No & No & No & No & Yes & Yes \\
 
-Profile \t{IUSE} injection & \compactfeatureref{profile-iuse-injection} &
+Profile \t{IUSE} injection & \compactfeatureref{profile-iuse-inject} &
     No & No & No & No & No & Yes \\
 
 \t{REPLACING\_VERSIONS} & \compactfeatureref{replace-version-vars} &
@@ -175,10 +175,10 @@ Option \t{-{}-host-root} & \compactfeatureref{host-root-option} &
 \t{new*} support stdin & \compactfeatureref{newfoo-stdin} &
     No & No & No & No & No & Yes \\
 
-Controllable compression & \compactfeatureref{controllable-compress} &
+Controllable compression & \compactfeatureref{docompress} &
     No & No & No & No & Yes & Yes \\
 
-\t{docompress} & \compactfeatureref{controllable-compress} &
+\t{docompress} & \compactfeatureref{docompress} &
     No & No & No & No & Yes & Yes \\
 
 \t{use\_with} empty third arg & \compactfeatureref{use-with} &
@@ -269,7 +269,7 @@ EAPI 4 is EAPI 3 with the following changes:
 \item \t{dodoc -r} support, \featureref{dodoc}.
 \item \t{doins} supports symlinks, \featureref{doins}.
 \item \t{doman -i18n} option takes precedence, \featureref{doman-langs}.
-\item Controllable compression and \t{docompress}, \featureref{controllable-compress}.
+\item Controllable compression and \t{docompress}, \featureref{docompress}.
 \item \t{use\_with} and \t{use\_enable} support empty third argument, \featureref{use-with}.
 \end{compactitem}
 
@@ -284,7 +284,7 @@ EAPI 5 is EAPI 4 with the following changes:
 \item \t{SLOT} now supports an optional sub-slot part, \featureref{sub-slot}.
 \item \t{src\_test} supports parallel tests, \featureref{parallel-tests}.
 \item \t{EBUILD\_PHASE\_FUNC}, \featureref{ebuild-phase-func}.
-\item \t{USE} is calculated differently, \featureref{profile-iuse-injection}.
+\item \t{USE} is calculated differently, \featureref{profile-iuse-inject}.
 \item \t{find} is guaranteed to be GNU, \featureref{gnu-find}.
 \item \t{best\_version} and \t{has\_version} support the \t{-{}-host-root} option,
     \featureref{host-root-option}.

diff --git a/ebuild-env-vars.tex b/ebuild-env-vars.tex
index 060d502..ae6321d 100644
--- a/ebuild-env-vars.tex
+++ b/ebuild-env-vars.tex
@@ -12,7 +12,7 @@ different \t{pkg\_*} phases. Ebuilds must recalculate any variable they derive f
 variable.
 
 \begin{landscape}
-\begin{longtable}{l p{0.15\textwidth} l p{0.5\textwidth}}
+\begin{longtable}{l p{0.175\textwidth} l p{0.5\textwidth}}
 \caption{Defined variables\label{tab:defined_vars}}\\
 \toprule
 \multicolumn{1}{c}{\b{Variable}} &
@@ -325,9 +325,8 @@ For EAPIs listed in table~\ref{tab:profile-iuse-injection-table} as not supporti
     the profile \t{USE\_EXPAND} variable followed by an underscore.
 \end{compactitem}
 
-\featurelabel{profile-iuse-injection} For EAPIs listed in
-table~\ref{tab:profile-iuse-injection-table} as supporting profile defined \t{IUSE} injection,
-\t{IUSE\_EFFECTIVE} contains the following values:
+\featurelabel{profile-iuse-inject} For EAPIs listed in table~\ref{tab:profile-iuse-injection-table}
+as supporting profile defined \t{IUSE} injection, \t{IUSE\_EFFECTIVE} contains the following values:
 
 \begin{compactitem}
 \item All values in the calculated \t{IUSE} value.

diff --git a/pkg-mgr-commands.tex b/pkg-mgr-commands.tex
index 0175699..772613e 100644
--- a/pkg-mgr-commands.tex
+++ b/pkg-mgr-commands.tex
@@ -384,9 +384,10 @@ that can be passed to \t{dohtml} are as follows:
     precedence over the language code in the filename.
 
 \item[domo] Installs a \t{.mo} file with file mode \t{0644} into the appropriate subdirectory of
-    \t{DESTTREE/share/locale}, generated by taking the basename of the 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}.
+    \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 files is the
+    package name with \t{.mo} appended. Failure behaviour is EAPI dependent as per
+    section~\ref{sec:failure-behaviour}.
 
 \item[dosbin] As \t{dobin}, but installs to \t{DESTTREE/sbin}.
 
@@ -576,10 +577,10 @@ has returned.
 
 \subsubsection{Commands affecting install compression}
 
-\featurelabel{controllable-compress} In EAPIs listed in table~\ref{tab:compression-table} as
-supporting controllable compression, the package manager may optionally compress a subset of the files
-under the \t{ED} directory in offset-prefix aware EAPIs or the \t{D} directory in offset-prefix
-agnostic EAPIs. To control which directories may or may not be compressed, the package manager shall
+\featurelabel{docompress} In EAPIs listed in table~\ref{tab:compression-table} as supporting
+controllable compression, the package manager may optionally compress a subset of the files under
+the \t{ED} directory in offset-prefix aware EAPIs or the \t{D} directory in offset-prefix agnostic
+EAPIs. To control which directories may or may not be compressed, the package manager shall
 maintain two lists:
 
 \begin{compactitem}

diff --git a/pms.cls b/pms.cls
index 5073c77..b948213 100644
--- a/pms.cls
+++ b/pms.cls
@@ -55,7 +55,6 @@
 \ifx\HCode\undefined
     \RequirePackage{%
         mathptmx,
-        courier,
         pdfpages	% Insert whole PDF documents as separate pages
     }
     \RequirePackage[scaled=.90]{helvet}
@@ -94,6 +93,11 @@
 \newcommand{\e}[1]{\emph{#1}}
 \newcommand{\note}[1]{\paragraph{Note:} #1}
 
+% Allow line breaks after underscores (but with a large penalty)
+\newcommand{\origunderscore}{}
+\let\origunderscore\_
+\renewcommand{\_}{\origunderscore\penalty500\hskip0pt}
+
 % Because we are lazy, we define a table environment to fulfil our needs
 \newenvironment{centertable}[1]%
 {
@@ -109,6 +113,11 @@
 \renewcommand*{\l@figure}{\@dottedtocline{1}{1.5em}{2.8em}} % was 2.3em
 \let\l@table\l@figure
 
+% Be more tolerant when formatting paragraphs, to avoid overfull boxes
+\tolerance=400                   % was 200
+\setlength\hfuzz{0.2pt}          % was 0.1pt
+\setlength\emergencystretch{1em} % was 0
+
 % Define some PDF meta-data.
 % tex4ht workaround: this needs to happen after loading hyperref
 \g@addto@macro\@documentclasshook{
@@ -137,6 +146,7 @@
 % and then move it 30mm to the left to increase the right (outer)
 % margin.
 \areaset[-30mm]{400pt}{700pt}
+\setlength{\marginparwidth}{40mm}
 
 % To find everywhere that needs updating when we add an EAPI
 \newcommand{\CurrentEAPIIs}[1]{\def\TheCurrentEAPI{#1}}

diff --git a/profiles.tex b/profiles.tex
index 8fb7674..ffdcdec 100644
--- a/profiles.tex
+++ b/profiles.tex
@@ -110,8 +110,8 @@ the forms defined by the directory's EAPI.
 \label{sec:use-masking}
 This section covers the eight files \t{use.mask}, \t{use.force}, \t{use.stable.mask},
 \t{use.stable.force}, \t{package.use.mask}, \t{package.use.force}, \t{package.use.stable.mask},
-and \t{package.use.stable.force}. They are described together because they interact in a non-trivial
-manner.
+and \t{package.use.\allowbreak stable.force}. They are described together because they interact in
+a non-trivial manner.
 
 Simply speaking, \t{use.mask} and \t{use.force} are used to say that a given USE flag must never or
 always, respectively, be enabled when using this profile. \t{package.use.mask} and
@@ -120,9 +120,10 @@ always, respectively, be enabled when using this profile. \t{package.use.mask} a
 \featurelabel{stablemask}
 In profile directories with an EAPI supporting stable masking, as listed in
 table~\ref{tab:profile-stablemask}, the same is true for \t{use.stable.mask}, \t{use.stable.force},
-\t{package.use.stable.mask} and \t{package.use.stable.force}. These files, however, only act on
-packages that are merged due to a stable keyword in the sense of subsection~\ref{sec:keywords}.
-Thus, these files can be used to restrict the feature set deemed stable in a package.
+\t{package.use.stable.mask} and \t{package.use.\allowbreak stable.force}. These files, however,
+only act on packages that are merged due to a stable keyword in the sense of
+subsection~\ref{sec:keywords}. Thus, these files can be used to restrict the feature set deemed
+stable in a package.
 
 \ChangeWhenAddingAnEAPI{5}
 \begin{centertable}{Profile directory support for masking/forcing use flags in stable
@@ -187,9 +188,9 @@ exactly if replacing in \t{KEYWORDS} all stable keywords by the corresponding ti
 keywords (see subsection~\ref{sec:keywords}) would result in the package installation being
 prevented due to the \t{KEYWORDS} setting.
 
-The logic for \t{use.force}, \t{use.stable. force}, \t{package.use.force}, and
-\t{package.use.stable.force} is identical. If a flag is both masked and forced, the mask is
-considered to take precedence.
+The logic for \t{use.force}, \t{use.stable.force}, \t{package.use.force}, and
+\t{package.use.\allowbreak stable.force} is identical. If a flag is both masked and forced, the
+mask is considered to take precedence.
 
 \t{USE\_EXPAND} values may be forced or masked by using \t{expand\_name\_value}.
 

diff --git a/tree-layout.tex b/tree-layout.tex
index ed66918..134a0bb 100644
--- a/tree-layout.tex
+++ b/tree-layout.tex
@@ -161,10 +161,11 @@ line is:
 \begin{verbatim}
 <mirror name> <mirror 1> <mirror 2> ... <mirror n>
 \end{verbatim}
-Fields are whitespace-delimited. When parsing a URI of the form \t{mirror://name/path/filename},
+Fields are whitespace-delimited. When parsing a URI of the form
+\t{mirror:/\slash name\slash path\slash filename},
 where the \t{path/} part is optional, the \t{thirdpartymirrors} file is searched for a line whose
-first field is \t{name}. Then the download URIs in the subsequent fields have \t{path/filename}
-appended to them to generate the URIs from which a download is attempted.
+first field is \t{name}. Then the download URIs in the subsequent fields have
+\t{path\slash filename} appended to them to generate the URIs from which a download is attempted.
 
 Each mirror name may appear at most once in a file. Behaviour when a mirror name appears multiple
 times is undefined. Behaviour when a mirror is defined in terms of another mirror is undefined. A