From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from lists.gentoo.org (pigeon.gentoo.org [208.92.234.80]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits)) (No client certificate requested) by finch.gentoo.org (Postfix) with ESMTPS id 3A197158064 for ; Mon, 13 May 2024 18:00:08 +0000 (UTC) Received: from pigeon.gentoo.org (localhost [127.0.0.1]) by pigeon.gentoo.org (Postfix) with SMTP id 7738A2BC015; Mon, 13 May 2024 18:00:07 +0000 (UTC) Received: from smtp.gentoo.org (woodpecker.gentoo.org [140.211.166.183]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (4096 bits) server-digest SHA256) (No client certificate requested) by pigeon.gentoo.org (Postfix) with ESMTPS id 436DA2BC015 for ; Mon, 13 May 2024 18:00:07 +0000 (UTC) Received: from oystercatcher.gentoo.org (oystercatcher.gentoo.org [148.251.78.52]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (4096 bits) server-digest SHA256) (No client certificate requested) by smtp.gentoo.org (Postfix) with ESMTPS id 16DFA335DC2 for ; Mon, 13 May 2024 18:00:06 +0000 (UTC) Received: from localhost.localdomain (localhost [IPv6:::1]) by oystercatcher.gentoo.org (Postfix) with ESMTP id 718FC1A28 for ; Mon, 13 May 2024 18:00:04 +0000 (UTC) From: "Ulrich Müller" To: gentoo-commits@lists.gentoo.org Content-Transfer-Encoding: 8bit Content-type: text/plain; charset=UTF-8 Reply-To: gentoo-dev@lists.gentoo.org, "Ulrich Müller" Message-ID: <1715191919.e1251fe69eac1e01c3915ae289b9ba73e8cc7413.ulm@gentoo> Subject: [gentoo-commits] proj/pms:master commit in: / X-VCS-Repository: proj/pms X-VCS-Files: appendices.tex commands.tex dependencies.tex desk-reference.tex eapi-cheatsheet.tex eapi-differences.tex ebuild-env-vars.tex ebuild-environment.tex ebuild-format.tex ebuild-functions.tex ebuild-vars.tex eclasses.tex introduction.tex merge.tex metadata-cache.tex names.tex pkg-mgr-commands.tex pms.tex profile-variables.tex profiles.tex tree-layout.tex X-VCS-Directories: / X-VCS-Committer: ulm X-VCS-Committer-Name: Ulrich Müller X-VCS-Revision: e1251fe69eac1e01c3915ae289b9ba73e8cc7413 X-VCS-Branch: master Date: Mon, 13 May 2024 18:00:04 +0000 (UTC) Precedence: bulk List-Post: List-Help: List-Unsubscribe: List-Subscribe: List-Id: Gentoo Linux mail X-BeenThere: gentoo-commits@lists.gentoo.org X-Auto-Response-Suppress: DR, RN, NRN, OOF, AutoReply X-Archives-Salt: a7d5d65e-5da4-4259-9965-9dbe76c855dd X-Archives-Hash: 12cf04e62887bda6adde03a5294b3830 Message-ID: <20240513180004.S2uUqYv7-Jg_pE5yexDF_YovfdXX4-3qIY5R-NQAP08@z> commit: e1251fe69eac1e01c3915ae289b9ba73e8cc7413 Author: Ulrich Müller gentoo org> AuthorDate: Tue May 7 17:28:42 2024 +0000 Commit: Ulrich Müller gentoo org> CommitDate: Wed May 8 18:11:59 2024 +0000 URL: https://gitweb.gentoo.org/proj/pms.git/commit/?id=e1251fe6 Use sentence case throughout Subsection headings were already changed from title case to sentence case in commit ca463ce. This left chapter and section headings alone, which is inconsistent (although it is specified by some style guides like APA). This commit changes headings to sentence case throughout, following most other Gentoo documentation, e.g. wiki and devmanual. Signed-off-by: Ulrich Müller gentoo.org> appendices.tex | 8 ++++---- commands.tex | 6 +++--- dependencies.tex | 6 +++--- desk-reference.tex | 4 ++-- eapi-cheatsheet.tex | 26 +++++++++++++------------- eapi-differences.tex | 4 ++-- ebuild-env-vars.tex | 2 +- ebuild-environment.tex | 6 +++--- ebuild-format.tex | 2 +- ebuild-functions.tex | 6 +++--- ebuild-vars.tex | 10 +++++----- eclasses.tex | 4 ++-- introduction.tex | 4 ++-- merge.tex | 8 ++++---- metadata-cache.tex | 8 ++++---- names.tex | 10 +++++----- pkg-mgr-commands.tex | 2 +- pms.tex | 2 +- profile-variables.tex | 2 +- profiles.tex | 4 ++-- tree-layout.tex | 16 ++++++++-------- 21 files changed, 70 insertions(+), 70 deletions(-) diff --git a/appendices.tex b/appendices.tex index daf9b01..8249ab3 100644 --- a/appendices.tex +++ b/appendices.tex @@ -5,7 +5,7 @@ The \t{metadata.xml} file is used to contain extra package- or category-level in what is stored in ebuild metadata. Its exact format is strictly beyond the scope of this document, and is described in GLEP~68~\cite{glep68}. -\chapter{Unspecified Items} +\chapter{Unspecified items} The following items are not specified by this document, and must not be relied upon by ebuilds. This is, of course, an incomplete list---it covers only the things that the authors know have @@ -24,9 +24,9 @@ been abused in the past. \item The \t{PORTDIR_OVERLAY} variable, and overlay behaviour in general. \end{compactitem} -\chapter{Historical Curiosities} +\chapter{Historical curiosities} -\section{Long-obsolete Features} +\section{Long-obsolete features} The items described in this section are included for information only. Unless otherwise noted, they were deprecated or abandoned long before EAPI was introduced. Ebuilds must not use these features, @@ -61,7 +61,7 @@ The \t{use.defaults} file in the profile directory was used to implement `autous flags on or off depending upon which packages are installed. It was deprecated long ago and finally removed in 2009. -\section{Retroactive Changes} +\section{Retroactive changes} In some exceptional cases, changes to the specification have been approved by the Gentoo Council without introducing a new EAPI\@. This section lists such retroactive changes. diff --git a/commands.tex b/commands.tex index d0ad87d..2c9e594 100644 --- a/commands.tex +++ b/commands.tex @@ -1,4 +1,4 @@ -\chapter{Available Commands} +\chapter{Available commands} This chapter documents the commands available to an ebuild. Unless otherwise specified, they may be aliases, shell functions, or executables in the ebuild's \t{PATH}. @@ -7,7 +7,7 @@ When an ebuild is being sourced for metadata querying rather than for a build (t when none of the \t{src_} or \t{pkg_} functions are to be called), no external command may be executed. The package manager may take steps to enforce this. -\section{System Commands} +\section{System commands} Any ebuild not listed in the system set for the active profile(s) may assume the presence of every command that is always provided by the system set for that profile. However, it must target the @@ -49,7 +49,7 @@ The following commands must always be available in the ebuild environment: \end{tabular} \end{centertable} -\section{Commands Provided by Package Dependencies} +\section{Commands provided by package dependencies} In some cases a package's build process will require the availability of executables not provided by the core system, a common example being autotools. The availability of commands provided by the diff --git a/dependencies.tex b/dependencies.tex index 6c09714..47c96c3 100644 --- a/dependencies.tex +++ b/dependencies.tex @@ -1,7 +1,7 @@ \chapter{Dependencies} \label{ch:dependencies} -\section{Dependency Classes} +\section{Dependency classes} \label{sec:dependency-classes} \begin{centertable}{Dependency classes required to be satisfied for a particular phase function} @@ -111,7 +111,7 @@ interfaces related to the dependency classes. In addition, \t{HOMEPAGE}, \t{SRC_URI}, \t{LICENSE}, \t{REQUIRED_USE}, \t{PROPERTIES} and \t{RESTRICT} use dependency-style specifications to specify their values. -\section{Dependency Specification Format} +\section{Dependency specification format} \label{sec:dependency-spec} The following elements are recognised in at least one class of specification. All elements must @@ -227,7 +227,7 @@ at-most-one-of group for match purposes. In an at-most-one-of group, at most one immediate child element must be matched. -\section{Package Dependency Specifications} +\section{Package dependency specifications} A package dependency can be in one of the following base formats. A package manager must warn or error on non-compliant input. diff --git a/desk-reference.tex b/desk-reference.tex index 0bcda38..cc60784 100644 --- a/desk-reference.tex +++ b/desk-reference.tex @@ -1,12 +1,12 @@ \ifthenelse{\boolean{TEX4HT-HACKS}}{% - \chapter{Desk Reference} + \chapter{Desk reference} \label{app:cheatsheet} \href{eapi-cheatsheet.pdf}{EAPI Cheat Sheet} }{% % Make sure that the cheat sheet starts on an odd page \ifthenelse{\isodd{\thepage}}{}{\null\newpage}% \includepdf[pages=-,landscape,turn=false,lastpage=2,% - addtotoc={1,chapter,0,Desk Reference,app:cheatsheet}]{eapi-cheatsheet} + addtotoc={1,chapter,0,Desk reference,app:cheatsheet}]{eapi-cheatsheet} } % vim: set filetype=tex fileencoding=utf8 et tw=100 spell spelllang=en : diff --git a/eapi-cheatsheet.tex b/eapi-cheatsheet.tex index 8c379bc..fc75aec 100644 --- a/eapi-cheatsheet.tex +++ b/eapi-cheatsheet.tex @@ -77,7 +77,7 @@ % to the original author or the PMS team. This work is released under the Creative Commons - Attribution-ShareAlike 4.0 International Licence.% + Attribution-ShareAlike 4.0 International licence.% \footnote{\url{https://creativecommons.org/licenses/by-sa/4.0/}} \end{abstract} @@ -92,7 +92,7 @@ differences between these previous EAPIs. % \section{EAPI 1} % \label{sec:cs:eapi1} -% \subsection{Additions/Changes} +% \subsection{Additions/changes} % \label{sec:cs:eapi1-additions} % \begin{description} % \item[IUSE defaults] A USE flag can be marked as mandatory (if @@ -106,7 +106,7 @@ differences between these previous EAPIs. % \section{EAPI 2 (2008-09-25)} % \label{sec:cs:eapi2} -% \subsection{Additions/Changes} +% \subsection{Additions/changes} % \label{sec:cs:eapi2-additions} % \begin{description} % \item[\code{SRC_URI} arrows] Allows redirection of upstream file @@ -161,7 +161,7 @@ differences between these previous EAPIs. % \section{EAPI 3 (2010-01-18)} % \label{sec:cs:eapi3} -% \subsection{Additions/Changes} +% \subsection{Additions/changes} % \label{sec:cs:eapi3-additions} % \begin{description} % \item[Support for \code{.xz}] Unpack of \code{.xz} and @@ -173,7 +173,7 @@ differences between these previous EAPIs. % \section{EAPI 4 (2011-01-17)} % \label{sec:cs:eapi4} -% \subsection{Additions/Changes} +% \subsection{Additions/changes} % \label{sec:cs:eapi4-additions} % \begin{description} % \item[\code{pkg_pretend}] Some useful checks (kernel options for @@ -245,7 +245,7 @@ differences between these previous EAPIs. % the version that is replacing the current one, respectively. % See \featureref{replace-version-vars}. % \end{description} -% \subsection{Removals/Bans} +% \subsection{Removals/bans} % \label{sec:cs:eapi4-removalsbans} % \begin{description} % \item[\code{dohard}, \code{dosed}] Both functions are not allowed @@ -263,7 +263,7 @@ differences between these previous EAPIs. % \section{EAPI 5 (2012-09-20)} % \label{sec:cs:eapi5} -% \subsection{Additions/Changes} +% \subsection{Additions/changes} % \label{sec:cs:eapi5-additions} % \begin{description} % \item[Sub-slots] The \code{SLOT} variable and slot dependencies @@ -333,7 +333,7 @@ differences between these previous EAPIs. \section{EAPI 6 (2015-11-13)} \label{sec:cs:eapi6} -\subsection{Additions/Changes} +\subsection{Additions/changes} \label{sec:cs:eapi6-additions} \begin{description} \item[Bash version] Ebuilds can use features of Bash version 4.2 @@ -399,7 +399,7 @@ differences between these previous EAPIs. the \code{lib*} directory basename suitable for the current ABI\@. See \featureref{get-libdir}. \end{description} -\subsection{Removals/Bans} +\subsection{Removals/bans} \label{sec:cs:eapi6-removalsbans} \begin{description} \item[\code{einstall}] No longer allowed. Use \code{emake install} @@ -409,7 +409,7 @@ differences between these previous EAPIs. \section{EAPI 7 (2018-04-30)} \label{sec:cs:eapi7} -\subsection{Additions/Changes} +\subsection{Additions/changes} \label{sec:cs:eapi7-additions} \begin{description} \item[\code{package.*} and \code{use.*}] These profile files can @@ -501,7 +501,7 @@ differences between these previous EAPIs. \end{description} See \featureref{ver-commands}. \end{description} -\subsection{Removals/Bans} +\subsection{Removals/bans} \label{sec:cs:eapi7-removalsbans} \begin{description} \item[\code{package.provided}] Deprecated since a long time and @@ -524,7 +524,7 @@ differences between these previous EAPIs. \section{EAPI 8 (2021-06-13)} \label{sec:cs:eapi8} -\subsection{Additions/Changes} +\subsection{Additions/changes} \label{sec:cs:eapi8-additions} \begin{description} \item[\code{profiles/updates} directory] Arbitrary filenames @@ -569,7 +569,7 @@ differences between these previous EAPIs. outputs \emph{[true]}, or the flag's name if called with only one argument. Otherwise outputs nothing. See \featureref{usev}. \end{description} -\subsection{Removals/Bans} +\subsection{Removals/bans} \label{sec:cs:eapi8-removalsbans} \begin{description} \item[\code{useq}] No longer allowed. Use regular \code{use} as diff --git a/eapi-differences.tex b/eapi-differences.tex index 31d5537..7fdc0d4 100644 --- a/eapi-differences.tex +++ b/eapi-differences.tex @@ -1,4 +1,4 @@ -\chapter{Feature Availability by EAPI} +\chapter{Feature availability by EAPI} \note{This chapter is informative and for convenience only. Refer to the main text for specifics. For lack of space, EAPIs 0 to~4 have been omitted from the table below, as well as items that would @@ -215,7 +215,7 @@ Controllable stripping & \compactfeatureref{dostrip} & \end{longtable} -\chapter{Differences Between EAPIs} +\chapter{Differences between EAPIs} \note{This chapter is informative and for convenience only. Refer to the main text for specifics.} diff --git a/ebuild-env-vars.tex b/ebuild-env-vars.tex index 06d37d9..268cb3f 100644 --- a/ebuild-env-vars.tex +++ b/ebuild-env-vars.tex @@ -1,4 +1,4 @@ -\section{Defined Variables} +\section{Defined variables} \label{sec:ebuild-env-vars} The package manager must define the following environment variables. Not all variables are diff --git a/ebuild-environment.tex b/ebuild-environment.tex index 8093f1e..06e197d 100644 --- a/ebuild-environment.tex +++ b/ebuild-environment.tex @@ -1,8 +1,8 @@ -\chapter{The Ebuild Environment} +\chapter{The ebuild environment} \input{ebuild-env-vars.tex} -\section{The State of Variables Between Functions} +\section{The state of variables between functions} \label{sec:ebuild-env-state} Exported and default scope variables are saved between functions. A non-local variable set in a @@ -55,7 +55,7 @@ src_install(){ \end{verbatim} \end{listing} -\section{The State of the System Between Functions} +\section{The state of the system between functions} For the sake of this section: \nobreakpar diff --git a/ebuild-format.tex b/ebuild-format.tex index cf06668..d1fbdfe 100644 --- a/ebuild-format.tex +++ b/ebuild-format.tex @@ -1,4 +1,4 @@ -\chapter{Ebuild File Format} +\chapter{Ebuild file format} \label{ch:ebuild-format} \featurelabel{bash-version} The ebuild file format is in its basic form a subset of the format of diff --git a/ebuild-functions.tex b/ebuild-functions.tex index 25164d4..84270fa 100644 --- a/ebuild-functions.tex +++ b/ebuild-functions.tex @@ -1,7 +1,7 @@ -\chapter{Ebuild-defined Functions} +\chapter{Ebuild-defined functions} \label{ch:ebuild-functions} -\section{List of Functions} +\section{List of functions} The following is a list of functions that an ebuild, or eclass, may define, and which will be called by the package manager as part of the build and/or install process. In all cases the package manager @@ -498,7 +498,7 @@ these functions except when in the phase in question. \end{tabular} \end{centertable} -\section{Call Order} +\section{Call order} The call order for installing a package is: \nobreakpar diff --git a/ebuild-vars.tex b/ebuild-vars.tex index 79fa96f..7dd008c 100644 --- a/ebuild-vars.tex +++ b/ebuild-vars.tex @@ -1,4 +1,4 @@ -\chapter{Ebuild-defined Variables} +\chapter{Ebuild-defined variables} \label{ch:ebuild-vars} \note{This chapter describes variables that may or must be defined by ebuilds. For variables that @@ -8,7 +8,7 @@ If any of these variables are set to invalid values, or if any of the mandatory undefined, the package manager's behaviour is undefined; ideally, an error in one ebuild should not prevent operations upon other ebuilds or packages. -\section{Metadata Invariance} +\section{Metadata invariance} \label{sec:metadata-invariance} All ebuild-defined variables discussed in this chapter must be defined independently of @@ -20,7 +20,7 @@ is used. Globally defined ebuild variables without a special meaning must similarly not rely upon variable data. -\section{Mandatory Ebuild-defined Variables} +\section{Mandatory ebuild-defined variables} \label{sec:mandatory-vars} All ebuilds must define at least the following variables: @@ -40,7 +40,7 @@ All ebuilds must define at least the following variables: which is equal to the regular slot. \end{description} -\section{Optional Ebuild-defined Variables} +\section{Optional ebuild-defined variables} \label{sec:optional-vars} Ebuilds may define any of the following variables. Unless otherwise stated, any of them may be @@ -291,7 +291,7 @@ the ebuild portion, and any \t{DEPEND} value set in an eclass does not get treat \end{tabular} \end{centertable} -\section{Magic Ebuild-defined Variables} +\section{Magic ebuild-defined variables} 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: diff --git a/eclasses.tex b/eclasses.tex index a4400e1..cfd5cae 100644 --- a/eclasses.tex +++ b/eclasses.tex @@ -12,7 +12,7 @@ section~\ref{sec:eclass-dir}. Each eclass is a single file named \t{.eclas is the name of this eclass, used by \t{inherit} and \t{EXPORT_FUNCTIONS} among other places. \t{} must be a valid eclass name, as per section~\ref{sec:eclass-names}. -\section{The inherit Command} +\section{The inherit command} \label{sec:inherit} An ebuild wishing to make use of an eclass does so by using the \t{inherit} command in global scope. @@ -33,7 +33,7 @@ The \t{inherit} command must also ensure that: every eclass used, separated by whitespace. \end{compactitem} -\section{Eclass-defined Metadata Keys} +\section{Eclass-defined metadata keys} \featurelabel{accumulate-vars} The \t{IUSE}, \t{REQUIRED_USE}, \t{DEPEND}, \t{BDEPEND}, \t{RDEPEND}, \t{PDEPEND} and \t{IDEPEND} variables are handled specially when set by an eclass. They must be diff --git a/introduction.tex b/introduction.tex index 86149b2..6bb84cd 100644 --- a/introduction.tex +++ b/introduction.tex @@ -1,6 +1,6 @@ \chapter{Introduction} -\section{Aims and Motivation} +\section{Aims and motivation} This document aims to fully describe the format of an ebuild repository and the ebuilds therein, as well as certain aspects of package manager behaviour required to support such a repository. @@ -25,7 +25,7 @@ ebuild repository looks like, and how an ebuild is allowed to behave. Thus, both package managers can change aspects of their behaviour not defined here without worry of incompatibilities with any particular repository. -\section{Reporting Issues} +\section{Reporting issues} Issues (inaccuracies, wording problems, omissions etc.)\ in this document should be reported via Gentoo Bugzilla using product \i{Gentoo Hosted Projects}, component \i{PMS/EAPI} and the default diff --git a/merge.tex b/merge.tex index ca1036d..83eab01 100644 --- a/merge.tex +++ b/merge.tex @@ -1,4 +1,4 @@ -\chapter{Merging and Unmerging} +\chapter{Merging and unmerging} \note{In this chapter, \i{file} and \i{regular file} have their Unix meanings.} @@ -38,7 +38,7 @@ including modification time, may be discarded. Behaviour upon encountering an empty directory is undefined. Ebuilds must not attempt to install an empty directory. -\section{Regular Files} +\section{Regular files} Regular files are merged onto the filesystem (but see the notes on configuration file protection, below). The method used to perform the merge is not specified, so long as the end result is correct. @@ -141,11 +141,11 @@ Ebuilds must not attempt to merge a symlink on top of a directory. Any absolute symlink whose link starts with \t{D} must be rewritten with the leading \t{D} removed. The package manager should issue a notice when doing this. -\section{Hard Links} +\section{Hard links} A hard link may be merged either as a single file with links or as multiple independent files. -\section{Other Files} +\section{Other files} Ebuilds must not attempt to install any other type of file (FIFOs, device nodes etc). diff --git a/metadata-cache.tex b/metadata-cache.tex index 9ff7086..552566c 100644 --- a/metadata-cache.tex +++ b/metadata-cache.tex @@ -1,7 +1,7 @@ -\chapter{Metadata Cache} +\chapter{Metadata cache} \label{ch:metadata-cache} -\section{Directory Contents} +\section{Directory contents} The \t{metadata/cache} or \t{metadata/md5-cache} directories, if either of them exists, contain directories whose names are the same as categories in the repository. Each subdirectory may @@ -10,7 +10,7 @@ in one of the formats described below. The metadata cache may be incomplete or non-existent, and may contain additional bogus entries. -\section{Legacy Cache File Format} +\section{Legacy cache file format} \label{sec:legacy-cache} The legacy cache file format is used in the \t{metadata/cache} directory. Each cache file contains @@ -50,7 +50,7 @@ Any future EAPI that uses this cache format will continue to place the EAPI valu such a concept makes sense for that EAPI, and will place a value that is clearly not a supported EAPI on line~15 if it does~not. -\section{md5-dict Cache File Format} +\section{md5-dict cache file format} The ``md5-dict'' cache file format is used in the \t{metadata/md5-cache} directory. Each cache file contains \t{=} pairs, one per line, in arbitrary order. The keys are the same as those diff --git a/names.tex b/names.tex index ed6d623..45289f7 100644 --- a/names.tex +++ b/names.tex @@ -1,6 +1,6 @@ -\chapter{Names and Versions} +\chapter{Names and versions} -\section{Restrictions upon Names} +\section{Restrictions upon names} No name may be empty. Package managers must not impose fixed upper boundaries upon the length of any name. A package manager should indicate or reject any name that is invalid according to these rules. @@ -56,7 +56,7 @@ a tilde or a hyphen. In \t{KEYWORDS}, \t{-*} is also acceptable as a keyword. An EAPI 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. -\section{Version Specifications} +\section{Version specifications} \label{sec:version-spec} The package manager must neither impose fixed limits upon the number of version components, nor upon the length of any component. Package managers should indicate or reject any version that is @@ -74,7 +74,7 @@ count as separate version components. This may optionally be followed by the suffix \t{-r} followed immediately by an unsigned integer (the ``revision number''). If this suffix is not present, it is assumed to be \t{-r0}. -\section{Version Comparison} +\section{Version comparison} Version specifications are compared component by component, moving from left to right, as detailed in algorithm~\ref{alg:version-comparison} and sub-algorithms. @@ -211,7 +211,7 @@ from which it was invoked. \end{algorithmic} \end{algorithm} -\section{Uniqueness of Versions} +\section{Uniqueness of versions} No two packages in a given repository may have the same qualified package name and equal versions. For example, a repository may not contain more than one of \t{foo-bar/baz-1.0.2}, diff --git a/pkg-mgr-commands.tex b/pkg-mgr-commands.tex index 2202b64..4c84b68 100644 --- a/pkg-mgr-commands.tex +++ b/pkg-mgr-commands.tex @@ -1,4 +1,4 @@ -\section{Ebuild-specific Commands} +\section{Ebuild-specific commands} \label{sec:pkg-mgr-commands} The following commands will always be available in the ebuild environment, provided by the package diff --git a/pms.tex b/pms.tex index bd8c9d5..24f07fe 100644 --- a/pms.tex +++ b/pms.tex @@ -35,7 +35,7 @@ by their respective authors, and may have been changed substantially before inclusion. This work is released under the Creative Commons Attribution-ShareAlike 4.0 International - Licence. To~view a copy of this licence, visit + licence. To~view a copy of this licence, visit \url{https://creativecommons.org/licenses/by-sa/4.0/}. \commitinfo diff --git a/profile-variables.tex b/profile-variables.tex index ba40bf4..9f86e80 100644 --- a/profile-variables.tex +++ b/profile-variables.tex @@ -1,4 +1,4 @@ -\section{Profile Variables} +\section{Profile variables} \label{sec:profile-variables} This section documents variables that have special meaning, or special behaviour, when defined in a diff --git a/profiles.tex b/profiles.tex index 856643b..af88568 100644 --- a/profiles.tex +++ b/profiles.tex @@ -1,7 +1,7 @@ \chapter{Profiles} \label{ch:profiles} -\section{General Principles} +\section{General principles} Generally, a profile defines information specific to a certain `type' of system---it lies somewhere between repository-level defaults and user configuration in that the information it contains is not necessarily applicable to all machines, but is sufficiently general that it should not be left to @@ -13,7 +13,7 @@ the files described in this chapter, and possibly inheriting another profile. Th follow a few basic conventions as regards inheritance and format; these are described in the next section. It may also contain any number of subdirectories containing other profiles. -\section{Files That Make up a Profile} +\section{Files that make up a profile} \subsection{The parent file} A profile may contain a \t{parent} file. Each line must contain a relative path to another profile diff --git a/tree-layout.tex b/tree-layout.tex index d286307..19aed03 100644 --- a/tree-layout.tex +++ b/tree-layout.tex @@ -1,11 +1,11 @@ -\chapter{Tree Layout} +\chapter{Tree layout} This chapter defines the layout on-disk of an ebuild repository. In all cases below where a file or directory is specified, a symlink to a file or directory is also valid. In this case, the package manager must follow the operating system's semantics for symbolic links and must not behave differently from normal. -\section{Top Level} +\section{Top level} An ebuild repository shall occupy one directory on disk, with the following subdirectories: \nobreakpar @@ -22,7 +22,7 @@ An ebuild repository shall occupy one directory on disk, with the following subd \end{compactitem} -\section{Category Directories} +\section{Category directories} \label{sec:category-dirs} Each category provided by the repository (see also: the \t{profiles/categories} file, @@ -44,7 +44,7 @@ It is not required that a directory exists for each category provided by the rep directory that does not exist shall be considered equivalent to an empty category (and by extension, a package manager may treat an empty category as a category that does not exist). -\section{Package Directories} +\section{Package directories} \label{sec:package-dirs} A package directory contains the following: @@ -71,7 +71,7 @@ with no versions). A package directory may contain other files or directories, whose purpose is not covered by this specification. -\section{The Profiles Directory} +\section{The profiles directory} \label{sec:profiles-dir} The profiles directory shall contain zero or more profile directories as described in @@ -247,7 +247,7 @@ by packages matching the spec of that slot move. \end{tabular} \end{centertable} -\section{The Licenses Directory} +\section{The licenses directory} \label{sec:licenses-dir} The \t{licenses} directory shall contain copies of the licenses used by packages in the @@ -255,14 +255,14 @@ repository. Each file will be named according to the name used in the \t{LICENSE described in section~\ref{sec:optional-vars}, and will contain the complete text of the license in human-readable form. Plain text format is strongly preferred but not required. -\section{The Eclass Directory} +\section{The eclass directory} \label{sec:eclass-dir} The \t{eclass} directory shall contain copies of the eclasses provided by this repository. The format of these files is described in chapter~\ref{ch:eclasses}. It may also contain, in their own directory, support files needed by these eclasses. -\section{The Metadata Directory} +\section{The metadata directory} \label{sec:metadata-dir} The \t{metadata} directory contains various repository-level metadata that are not contained in