summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorUlrich Müller <ulm@gentoo.org>2018-03-29 21:29:14 +0200
committerUlrich Müller <ulm@gentoo.org>2018-03-29 21:29:14 +0200
commitbd0323fb313fed1349a3d79fdb4a7bfcb1c8f597 (patch)
tree3f083024b792a3d3ffd541ee26c88ca35546f8dd
parentdependencies.tex: Clarify wording for = slot operator. (diff)
downloadpms-bd0323fb.tar.gz
pms-bd0323fb.tar.bz2
pms-bd0323fb.zip
pms.cls: Update \note command to suppress vertical space.
Use the command correctly throughout; it requires an argument.
-rw-r--r--dependencies.tex6
-rw-r--r--eapi-differences.tex6
-rw-r--r--ebuild-env-state.tex4
-rw-r--r--ebuild-functions.tex4
-rw-r--r--ebuild-vars.tex12
-rw-r--r--names.tex10
-rw-r--r--pms.cls2
-rw-r--r--profiles.tex4
8 files changed, 24 insertions, 24 deletions
diff --git a/dependencies.tex b/dependencies.tex
index 381dc04..065034f 100644
--- a/dependencies.tex
+++ b/dependencies.tex
@@ -176,7 +176,7 @@ or 4-style \t{USE} dependencies, a specification may additionally be suffixed by
2-style or 4-style \t{[use]} restriction, as described in section~\ref{sec:use-dep}. A package
manager must warn or error if this feature is used with an EAPI not supporting use dependencies.
-\note Order is important. The slot restriction must come before use dependencies.
+\note{Order is important. The slot restriction must come before use dependencies.}
\ChangeWhenAddingAnEAPI{6}
\begin{centertable}{Support for \t{SLOT} dependencies and sub-slots in EAPIs}
@@ -327,9 +327,9 @@ the latter, present and disabled.
Unless a 4-style default is specified, it is an error for a use dependency to be applied to an
ebuild which does not have the flag in question in \t{IUSE_REFERENCEABLE}.
-\note By extension of the above, a default that could reference an ebuild using an EAPI not
+\note{By extension of the above, a default that could reference an ebuild using an EAPI not
supporting profile \t{IUSE} injections cannot rely upon any particular behaviour for flags that
-would not have to be part of \t{IUSE}.
+would not have to be part of \t{IUSE}.}
It is an error for an ebuild to use a conditional use dependency when that ebuild does not have the
flag in \t{IUSE_EFFECTIVE}.
diff --git a/eapi-differences.tex b/eapi-differences.tex
index 2b74e05..8a2c3af 100644
--- a/eapi-differences.tex
+++ b/eapi-differences.tex
@@ -1,9 +1,9 @@
\chapter{Feature Availability by EAPI}
-\note This chapter is informative and for convenience only. Refer to the main text for specifics.
+\note{This chapter is informative and for convenience only. Refer to the main text for specifics.
For lack of space, EAPIs 0, 1, and~2 have been consolidated into a single column in the table
below; entries marked with an asterisk differ between these EAPIs. See the 2012-09-20 edition
-of this document for a complete table of previous EAPIs.
+of this document for a complete table of previous EAPIs.}
\ChangeWhenAddingAnEAPI{6}
\begin{landscape}
@@ -247,7 +247,7 @@ File mtimes preserved & \compactfeatureref{mtime-preserve} &
\chapter{Differences Between EAPIs}
-\note This chapter is informative and for convenience only. Refer to the main text for specifics.
+\note{This chapter is informative and for convenience only. Refer to the main text for specifics.}
\section{EAPI 0}
diff --git a/ebuild-env-state.tex b/ebuild-env-state.tex
index 2333b01..34c41c4 100644
--- a/ebuild-env-state.tex
+++ b/ebuild-env-state.tex
@@ -5,8 +5,8 @@ Exported and default scope variables are saved between functions. A non-local va
function earlier in the call sequence must have its value preserved for later functions, including
functions executed as part of a later uninstall.
-\note \t{pkg_pretend} is \e{not} part of the normal call sequence, and does not take part in
-environment saving.
+\note{\t{pkg_pretend} is \e{not} part of the normal call sequence, and does not take part in
+environment saving.}
Variables that were exported must remain exported in later functions; variables with default
visibility may retain default visibility or be exported. Variables with special meanings to the
diff --git a/ebuild-functions.tex b/ebuild-functions.tex
index e90c050..6240cf5 100644
--- a/ebuild-functions.tex
+++ b/ebuild-functions.tex
@@ -516,9 +516,9 @@ The call order for upgrading, downgrading or reinstalling a package is:
\item \t{pkg_postinst}
\end{compactitem}
-Note: When up- or downgrading a package in EAPI 0 or 1, the last four phase functions can
+\note{When up- or downgrading a package in EAPI 0 or 1, the last four phase functions can
alternatively be called in the order \t{pkg_preinst}, \t{pkg_postinst}, \t{pkg_prerm},
-\t{pkg_postrm}. This behaviour is deprecated.
+\t{pkg_postrm}. This behaviour is deprecated.}
The \t{pkg_config}, \t{pkg_info} and \t{pkg_nofetch} functions are not called in a normal
sequence. The \t{pkg_pretend} function is called some unspecified time before a (possibly
diff --git a/ebuild-vars.tex b/ebuild-vars.tex
index d653d09..0a3051c 100644
--- a/ebuild-vars.tex
+++ b/ebuild-vars.tex
@@ -1,8 +1,8 @@
\chapter{Ebuild-defined Variables}
\label{sec:ebuild-vars}
-\note This section describes variables that may or must be defined by ebuilds. For
-variables that are passed from the package manager to the ebuild, see section~\ref{sec:ebuild-env-vars}.
+\note{This section describes variables that may or must be defined by ebuilds. For variables that
+are passed from the package manager to the ebuild, see section~\ref{sec:ebuild-env-vars}.}
If any of these variables are set to invalid values, or if any of the mandatory variables are
undefined, the package manager's behaviour is undefined; ideally, an error in one ebuild should not
@@ -203,8 +203,8 @@ considered to be part of the ebuild's metadata:
\item[INHERITED] List of inherited eclass names. Again, this is handled magically by \t{inherit}.
\end{description}
-\note Thus, by extension of section~\ref{sec:metadata-invariance}, \t{inherit} may not be used
- conditionally, except upon constant conditions.
+\note{Thus, by extension of section~\ref{sec:metadata-invariance}, \t{inherit} may not be used
+conditionally, except upon constant conditions.}
The following are special variables defined by the package manager for internal use and may or may
not be exported to the ebuild environment:
@@ -218,8 +218,8 @@ optional \t{DEFINED_PHASES} support, package managers may not rely upon the meta
this variable defined, and must treat an empty string as ``this information is not available''.
\end{description}
-\note Thus, by extension of section~\ref{sec:metadata-invariance}, phase functions must not be defined
-based upon any variant condition.
+\note{Thus, by extension of section~\ref{sec:metadata-invariance}, phase functions must not be
+defined based upon any variant condition.}
\ChangeWhenAddingAnEAPI{6}
\begin{centertable}{EAPIs supporting \t{DEFINED_PHASES}}
diff --git a/names.tex b/names.tex
index be55698..c8e1129 100644
--- a/names.tex
+++ b/names.tex
@@ -9,8 +9,8 @@ name. A package manager should indicate or reject any name that is invalid accor
A category name may contain any of the characters [\t{A-Za-z0-9+_.-}]. It must not begin with
a hyphen, a dot or a plus sign.
-\note A hyphen is \e{not} required because of the \t{virtual} category. Usually, however, category
-names will contain a hyphen.
+\note{A hyphen is \e{not} required because of the \t{virtual} category. Usually, however, category
+names will contain a hyphen.}
\subsection{Package names}
\label{sec:package-names}
@@ -18,8 +18,8 @@ A package name may contain any of the characters [\t{A-Za-z0-9+_-}]. It must not
hyphen or a plus sign, and must not end in a hyphen followed by anything matching the version
syntax described in section~\ref{sec:version-spec}.
-\note A package name does not include the category. The term \i{qualified package name} is used
-where a \t{category/package} pair is meant.
+\note{A package name does not include the category. The term \i{qualified package name} is used
+where a \t{category/package} pair is meant.}
\subsection{Slot names}
\label{sec:slot-names}
@@ -31,7 +31,7 @@ A USE flag name may contain any of the characters [\t{A-Za-z0-9+_@-}]. It must b
alphanumeric character. Underscores should be considered reserved for \t{USE_EXPAND}, as
described in section~\ref{sec:use-iuse-handling}.
-\note Usage of the at-sign is deprecated. It was previously required for \t{LINGUAS}.
+\note{Usage of the at-sign is deprecated. It was previously required for \t{LINGUAS}.}
\subsection{Repository names}
\label{sec:repository-names}
diff --git a/pms.cls b/pms.cls
index 89e7d5a..66e1828 100644
--- a/pms.cls
+++ b/pms.cls
@@ -121,7 +121,7 @@
\renewcommand{\t}[1]{\texttt{#1}}
}
\newcommand{\e}[1]{\emph{#1}}
-\newcommand{\note}[1]{\paragraph{Note:} #1}
+\newcommand{\note}[1]{\begin{trivlist}\item\textbf{Note:} #1\end{trivlist}}
% Because we are lazy, we define a table environment to fulfil our needs
\newenvironment{centertable}[1]%
diff --git a/profiles.tex b/profiles.tex
index 7299350..9263418 100644
--- a/profiles.tex
+++ b/profiles.tex
@@ -89,8 +89,8 @@ installed unless unmasked by the user's configuration.
Note that the \t{-spec} syntax can be used to remove a mask in a parent profile, but not
necessarily a global mask (from \t{profiles/package.mask}, section~\ref{profiles-package.mask}).
-\note Portage currently treats \t{profiles/package.mask} as being on the leftmost branch of the
- inherit tree when it comes to \t{-lines}. This behaviour may not be relied upon.
+\note{Portage currently treats \t{profiles/package.mask} as being on the leftmost branch of the
+inherit tree when it comes to \t{-lines}. This behaviour may not be relied upon.}
\subsection{package.provided}
\t{package.provided} is used to tell the package manager that a certain package version should be