From 525c0460eb2bc9cbe65755f5df4ab833b2107d65 Mon Sep 17 00:00:00 2001 From: Ulrich Müller Date: Sun, 12 Aug 2018 15:17:27 +0200 Subject: Fix whitespace in list items. --- dependencies.tex | 14 +++++++------- ebuild-vars.tex | 13 +++++++------ eclasses.tex | 2 +- introduction.tex | 2 +- merge.tex | 6 +++--- pkg-mgr-commands.tex | 36 +++++++++++++++++++----------------- profiles.tex | 11 ++++++----- tree-layout.tex | 6 +++--- 8 files changed, 47 insertions(+), 43 deletions(-) diff --git a/dependencies.tex b/dependencies.tex index 39b43f5..deb5d9c 100644 --- a/dependencies.tex +++ b/dependencies.tex @@ -60,7 +60,7 @@ as supporting \t{BDEPEND}, the build dependencies are split into two subclasses: \item \t{BDEPEND} build dependencies that are binary compatible with the native build system (\t{CBUILD}). The ebuild is allowed to call binary executables installed by this kind of dependency. - \item \t{DEPEND} build dependencies that are binary compatible with the system being built +\item \t{DEPEND} build dependencies that are binary compatible with the system being built (\t{CHOST}). The ebuild must not execute binary executables installed by this kind of dependency. \end{compactitem} @@ -335,14 +335,14 @@ the following operators: \begin{description} \item[*] Indicates that any slot value is acceptable. In addition, for runtime dependencies, -indicates that the package will not break if the matched package is uninstalled and replaced by -a different matching package in a different slot. + indicates that the package will not break if the matched package is uninstalled and replaced by + a different matching package in a different slot. \item[=] Indicates that any slot value is acceptable. In addition, for runtime dependencies, -indicates that the package will break unless a matching package with slot and sub-slot equal to the -slot and sub-slot of the best version installed as a build-time (\t{DEPEND}) dependency is -available. + indicates that the package will break unless a matching package with slot and sub-slot equal to + the slot and sub-slot of the best version installed as a build-time (\t{DEPEND}) dependency is + available. \item[slot=] Indicates that only a specific slot value is acceptable, and otherwise behaves -identically to the plain equals slot operator. + identically to the plain equals slot operator. \end{description} To implement the equals slot operator, the package manager will need to store the slot/sub-slot diff --git a/ebuild-vars.tex b/ebuild-vars.tex index faecf8f..497bd77 100644 --- a/ebuild-vars.tex +++ b/ebuild-vars.tex @@ -211,12 +211,13 @@ The following are special variables defined by the package manager for internal not be exported to the ebuild environment: \begin{description} -\item[DEFINED_PHASES] \featurelabel{defined-phases} A space separated arbitrarily ordered list of -phase names (e.\,g.\ \t{configure setup unpack}) whose phase functions are defined by the ebuild or -an eclass inherited by the ebuild. If no phase functions are defined, a single hyphen is used -instead of an empty string. For EAPIs listed in table~\ref{tab:defined-phases-table} as having -optional \t{DEFINED_PHASES} support, package managers may not rely upon the metadata cache having -this variable defined, and must treat an empty string as ``this information is not available''. +\item[DEFINED_PHASES] \featurelabel{defined-phases} A space separated arbitrarily ordered list + of phase names (e.\,g.\ \t{configure setup unpack}) whose phase functions are defined by the + ebuild or an eclass inherited by the ebuild. If no phase functions are defined, a single hyphen + is used instead of an empty string. For EAPIs listed in table~\ref{tab:defined-phases-table} + as having optional \t{DEFINED_PHASES} support, package managers may not rely upon the metadata + cache having 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 diff --git a/eclasses.tex b/eclasses.tex index 7a8bfbd..8305504 100644 --- a/eclasses.tex +++ b/eclasses.tex @@ -29,7 +29,7 @@ The \t{inherit} command must also ensure that: \begin{compactitem} \item The \t{ECLASS} variable is set to the name of the current eclass, when sourcing that eclass. \item Once all inheriting has been done, the \t{INHERITED} metadata variable contains the name of - every eclass used, separated by whitespace. + every eclass used, separated by whitespace. \end{compactitem} \section{Eclass-defined Metadata Keys} diff --git a/introduction.tex b/introduction.tex index afbe708..b5b63c6 100644 --- a/introduction.tex +++ b/introduction.tex @@ -38,7 +38,7 @@ Patches will be reviewed by the PMS team, who will do one of the following: \begin{compactitem} \item Accept and apply the patch. \item Explain why the patch cannot be applied as-is. The patch may then be updated and resubmitted -if appropriate. + if appropriate. \item Reject the patch outright. \item Take special action merited by the individual circumstances. \end{compactitem} diff --git a/merge.tex b/merge.tex index d23d5f0..6649d35 100644 --- a/merge.tex +++ b/merge.tex @@ -112,9 +112,9 @@ In order to ensure interoperability with configuration update tools, the followi used by all package managers when merging any regular file: \begin{compactenum} -\item If the directory containing the file to be merged is not listed in \t{CONFIG_PROTECT}, and - is not a subdirectory of any such directory, and if the file is not listed in \t{CONFIG_PROTECT}, - the file is merged normally. +\item If the directory containing the file to be merged is not listed in \t{CONFIG_PROTECT}, and is + not a subdirectory of any such directory, and if the file is not listed in \t{CONFIG_PROTECT}, + the file is merged normally. \item If the directory containing the file to be merged is listed in \t{CONFIG_PROTECT_MASK}, or is a subdirectory of such a directory, or if the file is listed in \t{CONFIG_PROTECT_MASK}, the file is merged normally. diff --git a/pkg-mgr-commands.tex b/pkg-mgr-commands.tex index 74c8983..1e414d4 100644 --- a/pkg-mgr-commands.tex +++ b/pkg-mgr-commands.tex @@ -443,12 +443,13 @@ the current phase function has returned. dependent as per section~\ref{sec:failure-behaviour}. \item[dodoc] \featurelabel{dodoc} Installs the given files into a subdirectory under - \t{/usr/share/doc/\$\{PF\}/} with file mode \t{0644}. The subdirectory is set by the most recent - call to \t{docinto}. If \t{docinto} has not yet been called, instead installs to the directory - \t{/usr/share/doc/\$\{PF\}/}. For EAPIs listed in table~\ref{tab:dodoc-table} as supporting \t{-r}, - if the first argument is \t{-r}, any subsequent arguments that are directories are installed - recursively to the appropriate location; in any other case, it is an error for a directory to be - specified. Failure behaviour is EAPI dependent as per section~\ref{sec:failure-behaviour}. + \t{/usr/share/doc/\$\{PF\}/} with file mode \t{0644}. The subdirectory is set by the most + recent call to \t{docinto}. If \t{docinto} has not yet been called, instead installs to the + directory \t{/usr/share/doc/\$\{PF\}/}. For EAPIs listed in table~\ref{tab:dodoc-table} + as supporting \t{-r}, if the first argument is \t{-r}, any subsequent arguments that are + directories are installed recursively to the appropriate location; in any other case, it is + an error for a directory to be specified. Failure behaviour is EAPI dependent as per + section~\ref{sec:failure-behaviour}. \item[doenvd] Installs the given environment files into \t{/etc/env.d/}, by default with file mode \t{0644}, or with the \t{install} options set by the most recent \t{insopts} call. @@ -1003,12 +1004,12 @@ has returned. \begin{description} \item[dosed] Takes any number of arguments, which can be files or \t{sed} expressions. For each - argument, if it names, relative to \t{ED} (offset-prefix aware EAPIs) or \t{D} (offset-prefix agnostic - EAPIs) a file which exists, then \t{sed} is run with the current expression on that file. Otherwise, - the current expression is set to the text of the argument. The initial value of the expression is - \t{s:\$\{ED\}::g} in offset-prefix aware EAPIs and \t{s:\$\{D\}::g} in offset-prefix agnostic - EAPIs. In EAPIs listed in table~\ref{tab:banned-commands-table}, this command is banned as per - section~\ref{sec:banned-commands}. + argument, if it names, relative to \t{ED} (offset-prefix aware EAPIs) or \t{D} (offset-prefix + agnostic EAPIs) a file which exists, then \t{sed} is run with the current expression on that + file. Otherwise, the current expression is set to the text of the argument. The initial value + of the expression is \t{s:\$\{ED\}::g} in offset-prefix aware EAPIs and \t{s:\$\{D\}::g} in + offset-prefix agnostic EAPIs. In EAPIs listed in table~\ref{tab:banned-commands-table}, this + command is banned as per section~\ref{sec:banned-commands}. \item[unpack] Unpacks one or more source archives, in order, into the current directory. For compressed files, creates the target file in the current directory, with the compression @@ -1036,19 +1037,20 @@ has returned. \item tar files (\t{*.tar}). Ebuilds must ensure that GNU tar is installed. \item gzip-compressed files (\t{*.gz, *.Z}). Ebuilds must ensure that GNU gzip is installed. \item gzip-compressed tar files (\t{*.tar.gz, *.tgz, *.tar.Z}). Ebuilds must ensure that - GNU gzip and GNU tar are installed. + GNU gzip and GNU tar are installed. \item bzip2-compressed files (\t{*.bz2, *.bz}). Ebuilds must ensure that bzip2 is installed. \item bzip2-compressed tar files (\t{*.tar.bz2, *.tbz2, *.tar.bz, *.tbz}). Ebuilds must ensure - that bzip2 and GNU tar are installed. + that bzip2 and GNU tar are installed. \item zip files (\t{*.zip, *.ZIP, *.jar}). Ebuilds must ensure that Info-ZIP Unzip is installed. \item 7zip files (\t{*.7z, *.7Z}). Ebuilds must ensure that P7ZIP is installed. \item rar files (\t{*.rar, *.RAR}). Ebuilds must ensure that RARLAB's unrar is installed. \item LHA archives (\t{*.LHA, *.LHa, *.lha, *.lzh}). Ebuilds must ensure that the lha program is - installed. + installed. \item ar archives (\t{*.a}). Ebuilds must ensure that GNU binutils is installed. \item deb packages (\t{*.deb}). Ebuilds must ensure that the deb2targz program is installed on - those platforms where the GNU binutils ar program is not available and the installed ar program is - incompatible with GNU archives. Otherwise, ebuilds must ensure that GNU binutils is installed. + those platforms where the GNU binutils ar program is not available and the installed ar + program is incompatible with GNU archives. Otherwise, ebuilds must ensure that GNU binutils + is installed. \item lzma-compressed files (\t{*.lzma}). Ebuilds must ensure that XZ Utils is installed. \item lzma-compressed tar files (\t{*.tar.lzma}). Ebuilds must ensure that XZ Utils and GNU tar are installed. diff --git a/profiles.tex b/profiles.tex index 58c6d3b..b423697 100644 --- a/profiles.tex +++ b/profiles.tex @@ -55,11 +55,12 @@ and may contain \t{a-zA-Z0-9_} only. Additional syntax, which is a small subset bash syntax, is allowed as follows: \begin{compactitem} -\item Variables to the right of the equals sign in the form \t{\$\{foo\}} or \t{\$foo} are recognised and - expanded from variables previously set in this or earlier \t{make.defaults} files. -\item One logical line may be continued over multiple physical lines by escaping the newline with a - backslash. A quoted string may be continued over multiple physical lines by either a simple - newline or a backslash-escaped newline. +\item Variables to the right of the equals sign in the form \t{\$\{foo\}} or \t{\$foo} are + recognised and expanded from variables previously set in this or earlier \t{make.defaults} + files. +\item One logical line may be continued over multiple physical lines by escaping the newline with + a backslash. A quoted string may be continued over multiple physical lines by either a simple + newline or a backslash-escaped newline. \item Backslashes, except for line continuations, are not allowed. \end{compactitem} diff --git a/tree-layout.tex b/tree-layout.tex index 9e60af4..9397e4b 100644 --- a/tree-layout.tex +++ b/tree-layout.tex @@ -30,9 +30,9 @@ be contained in one directory, whose name shall be that of the category. Each category directory shall contain: \begin{compactitem} \item A \t{metadata.xml} file, as described in appendix~\ref{sec:metadata-xml}\@. Optional. -\item Zero or more package directories, one for each package in the - category, as described in section~\ref{sec:package-dirs}. The name of - the package directory shall be the corresponding package name. +\item Zero or more package directories, one for each package in the category, as described in + section~\ref{sec:package-dirs}. The name of the package directory shall be the corresponding + package name. \end{compactitem} Category directories may contain additional files, whose purpose is not covered by this -- cgit v1.2.3-65-gdbad