Gentoo Archives: gentoo-pms

From: "Ulrich Müller" <ulm@g.o>
To: gentoo-pms@l.g.o
Subject: [gentoo-pms] [PATCH] Refer to chapters as chapters.
Date: Sat, 23 Mar 2019 21:34:40
Message-Id: w6ga7hlz34m.fsf@kph.uni-mainz.de
1 Signed-off-by: Ulrich Müller <ulm@g.o>
2 ---
3 ebuild-format.tex | 2 +-
4 ebuild-vars.tex | 8 ++++----
5 introduction.tex | 2 +-
6 tree-layout.tex | 14 ++++++--------
7 4 files changed, 12 insertions(+), 14 deletions(-)
8
9 diff --git a/ebuild-format.tex b/ebuild-format.tex
10 index e7b8133..b843b5a 100644
11 --- a/ebuild-format.tex
12 +++ b/ebuild-format.tex
13 @@ -12,7 +12,7 @@ option of bash is set in the global scope of ebuilds. If set, failed pattern mat
14 filename expansion result in an error when the ebuild is being sourced.
15
16 The file encoding must be UTF-8 with Unix-style newlines. When sourced, the ebuild must define
17 -certain variables and functions (see sections~\ref{sec:ebuild-vars} and~\ref{sec:ebuild-functions}
18 +certain variables and functions (see chapters~\ref{sec:ebuild-vars} and~\ref{sec:ebuild-functions}
19 for specific information), and must not call any external programs, write anything to standard
20 output or standard error, or modify the state of the system in any way.
21
22 diff --git a/ebuild-vars.tex b/ebuild-vars.tex
23 index 47720bb..763648d 100644
24 --- a/ebuild-vars.tex
25 +++ b/ebuild-vars.tex
26 @@ -79,12 +79,12 @@ Ebuilds may define any of the following variables:
27 any way.
28 \item[RESTRICT] Zero or more behaviour restrictions for this package. See section~\ref{sec:restrict}
29 for value meanings and section~\ref{sec:dependency-spec} for full syntax.
30 -\item[DEPEND] See section~\ref{sec:dependencies}.
31 -\item[RDEPEND] See section~\ref{sec:dependencies}. For some EAPIs, \t{RDEPEND} has special behaviour
32 +\item[DEPEND] See chapter~\ref{sec:dependencies}.
33 +\item[RDEPEND] See chapter~\ref{sec:dependencies}. For some EAPIs, \t{RDEPEND} has special behaviour
34 for its value if unset and when used with an eclass. See section~\ref{sec:rdepend-depend} for
35 details.
36 -\item[PDEPEND] See section~\ref{sec:dependencies}.
37 -\item[BDEPEND] See section~\ref{sec:dependencies}.
38 +\item[PDEPEND] See chapter~\ref{sec:dependencies}.
39 +\item[BDEPEND] See chapter~\ref{sec:dependencies}.
40 \end{description}
41
42 \ChangeWhenAddingAnEAPI{7}
43 diff --git a/introduction.tex b/introduction.tex
44 index b5b63c6..52d37d2 100644
45 --- a/introduction.tex
46 +++ b/introduction.tex
47 @@ -60,7 +60,7 @@ applicable to tools or other applications that interact with ebuilds or ebuild r
48 \section{Acknowledgements}
49
50 Thanks to Mike Kelly (package manager provided utilities, section~\ref{sec:pkg-mgr-commands}),
51 -Danny van Dyk (ebuild functions, section~\ref{sec:ebuild-functions}), David Leverton (various
52 +Danny van Dyk (ebuild functions, chapter~\ref{sec:ebuild-functions}), David Leverton (various
53 sections), Petteri Räty (environment state, section~\ref{sec:ebuild-env-state}), Michał Górny
54 (various sections), Andreas K. Hüttel (stable use masking, section~\ref{sec:use-masking}),
55 Zac Medico (sub-slots, section~\ref{sec:mandatory-vars}) and James Le Cuirot (build dependencies,
56 diff --git a/tree-layout.tex b/tree-layout.tex
57 index 9397e4b..d64c38f 100644
58 --- a/tree-layout.tex
59 +++ b/tree-layout.tex
60 @@ -49,7 +49,7 @@ a package manager may treat an empty category as a category that does not exist)
61
62 A package directory contains the following:
63 \begin{compactitem}
64 -\item Zero or more ebuilds. These are as described in section~\ref{sec:ebuild-format} and others.
65 +\item Zero or more ebuilds. These are as described in chapter~\ref{sec:ebuild-format} and others.
66 \item A \t{metadata.xml} file, as described in appendix~\ref{sec:metadata-xml}\@. Optional only for
67 legacy support.
68 \item A \t{ChangeLog}, in a format determined by the provider of the repository. Optional.
69 @@ -73,12 +73,10 @@ this specification.
70 \section{The Profiles Directory}
71 \label{sec:profiles-dir}
72
73 -The profiles directory shall contain zero or more profile directories
74 -as described in section~\ref{sec:profiles}, as well as the following files
75 -and directories. In any line-based file, lines beginning with a \#
76 -character are treated as comments, whilst blank lines are ignored. All
77 -contents of this directory, with the exception of \t{repo_name}, are
78 -optional.
79 +The profiles directory shall contain zero or more profile directories as described in
80 +chapter~\ref{sec:profiles}, as well as the following files and directories. In any line-based file,
81 +lines beginning with a \# character are treated as comments, whilst blank lines are ignored.
82 +All contents of this directory, with the exception of \t{repo_name}, are optional.
83
84 The profiles directory may contain an \t{eapi} file. This file, if it exists, must contain a single
85 line with the name of an EAPI\@. This specifies the EAPI to use when handling the profiles
86 @@ -241,7 +239,7 @@ human-readable form. Plain text format is strongly preferred but not required.
87 \label{sec:eclass-dir}
88
89 The \t{eclass} directory shall contain copies of the eclasses provided by this repository. The
90 -format of these files is described in section~\ref{sec:eclasses}. It may also contain, in their own
91 +format of these files is described in chapter~\ref{sec:eclasses}. It may also contain, in their own
92 directory, support files needed by these eclasses.
93
94 \section{The Metadata Directory}
95 --
96 2.21.0

Replies

Subject Author
Re: [gentoo-pms] [PATCH] Refer to chapters as chapters. Michael Orlitzky <mjo@g.o>