Gentoo Archives: gentoo-pms

From: Ulrich Mueller <ulm@g.o>
To: gentoo-pms@l.g.o
Subject: [gentoo-pms] [PATCH] Distinguish between \e and \i.
Date: Fri, 28 Jan 2011 09:27:09
Message-Id: 19778.35806.305392.305552@a1i15.kph.uni-mainz.de
1 Please review. In the majority of cases, \e and \i were already used
2 as intended. This patch fixes the few deviating cases.
3
4 A more general question, should such patches that do not change the
5 meaning of the text be sent to this list for review?
6
7 Ulrich
8
9
10 From 7137cb32f3914e154d109ac9f4cdf70cb4e9e0a4 Mon Sep 17 00:00:00 2001
11 From: Ulrich Mueller <ulm@g.o>
12 Date: Fri, 28 Jan 2011 10:14:45 +0100
13 Subject: [PATCH] Distinguish between \e and \i.
14
15 Section "Conventions" says that \i should be used for technical terms.
16 ---
17 appendices.tex | 2 +-
18 ebuild-vars.tex | 2 +-
19 introduction.tex | 2 +-
20 merge.tex | 2 +-
21 names.tex | 2 +-
22 tree-layout.tex | 4 ++--
23 6 files changed, 7 insertions(+), 7 deletions(-)
24
25 diff --git a/appendices.tex b/appendices.tex
26 index 093a9bc..a604a3f 100644
27 --- a/appendices.tex
28 +++ b/appendices.tex
29 @@ -46,7 +46,7 @@ This feature was deprecated and removed from the tree long before the introducti
30 \section{cvs Versions}
31
32 Portage has very crude support for CVS packages. The package \t{foo} could contain a file named
33 -\t{foo-cvs.1.2.3.ebuild}. This version would order \i{higher} than any non-CVS version (including
34 +\t{foo-cvs.1.2.3.ebuild}. This version would order \e{higher} than any non-CVS version (including
35 \t{foo-2.ebuild}). This feature has not seen real world use and breaks versioned dependencies, so
36 it must not be used.
37
38 diff --git a/ebuild-vars.tex b/ebuild-vars.tex
39 index 133b8b5..00e7779 100644
40 --- a/ebuild-vars.tex
41 +++ b/ebuild-vars.tex
42 @@ -77,7 +77,7 @@ Ebuilds may define any of the following variables:
43 \item[DEPEND] See section~\ref{sec:dependencies}.
44 \item[EAPI] The EAPI. See below for defaults.
45 \item[PDEPEND] See section~\ref{sec:dependencies}.
46 -\item[PROVIDE] Zero or more qualified package names of any \e{old style}
47 +\item[PROVIDE] Zero or more qualified package names of any \i{old style}
48 virtuals provided by this package. See section~\ref{sec:dependencies} for full syntax.
49 \label{ebuild-var-provide}
50 \item[RDEPEND] See section~\ref{sec:dependencies}. For some EAPIs, \t{RDEPEND} has special behaviour
51 diff --git a/introduction.tex b/introduction.tex
52 index 3986f57..4c91004 100644
53 --- a/introduction.tex
54 +++ b/introduction.tex
55 @@ -5,7 +5,7 @@
56 This document aims to fully describe the format of an ebuild repository and the ebuilds therein, as
57 well as certain aspects of package manager behaviour required to support such a repository.
58
59 -This document is \i{not} designed to be an introduction to ebuild development. Prior knowledge of
60 +This document is \e{not} designed to be an introduction to ebuild development. Prior knowledge of
61 ebuild creation and an understanding of how the package management system works is assumed; certain
62 less familiar terms are explained in the Glossary in chapter~\ref{sec:glossary}.
63
64 diff --git a/merge.tex b/merge.tex
65 index e798f2d..8b2648d 100644
66 --- a/merge.tex
67 +++ b/merge.tex
68 @@ -1,6 +1,6 @@
69 \chapter{Merging and Unmerging}
70
71 -\note{In this chapter, \e{file} and \e{regular file} have their Unix meanings.}
72 +\note{In this chapter, \i{file} and \i{regular file} have their Unix meanings.}
73
74 \section{Overview}
75
76 diff --git a/names.tex b/names.tex
77 index 2ee5089..53fed20 100644
78 --- a/names.tex
79 +++ b/names.tex
80 @@ -9,7 +9,7 @@ name. A package manager should indicate or reject any name that is invalid accor
81 A category name may contain any of the characters [\t{A-Za-z0-9+\_.-}]. It must not begin with
82 a hyphen or a dot.
83
84 -\note A hyphen is \i{not} required because of the \t{virtual} category. Usually, however, category
85 +\note A hyphen is \e{not} required because of the \t{virtual} category. Usually, however, category
86 names will contain a hyphen.
87
88 \subsection{Package Names}
89 diff --git a/tree-layout.tex b/tree-layout.tex
90 index d548972..ed66918 100644
91 --- a/tree-layout.tex
92 +++ b/tree-layout.tex
93 @@ -36,7 +36,7 @@ category. Each category directory shall contain:
94 \end{compactitem}
95
96 Category directories may contain additional files, whose purpose is not covered by this
97 -specification. Additional directories that are not for a package may \i{not} be present, to avoid
98 +specification. Additional directories that are not for a package may \e{not} be present, to avoid
99 conflicts with package name directories; an exception is made for filesystem components whose name
100 starts with a dot, which the package manager must ignore, and for any directory named \t{CVS}.
101
102 @@ -123,7 +123,7 @@ manager must ignore any files in this directory that it does not recognise.
103 \item[desc/] This directory contains files analogous to \t{use.desc} for the various \t{USE\_EXPAND}
104 variables. Each file in it is named \t{<varname>.desc}, where \t{<varname>} is the variable
105 name, in lowercase, whose possible values the file describes. The format of each file is as for
106 - \t{use.desc}, described in section~\ref{sec:use.desc}. The \t{USE\_EXPAND} name is \i{not}
107 + \t{use.desc}, described in section~\ref{sec:use.desc}. The \t{USE\_EXPAND} name is \e{not}
108 included as a prefix here.
109 \item[updates/] This directory is described in section~\ref{sec:updates-dir}.
110 \end{description}
111 --
112 1.7.4.rc2

Replies

Subject Author
Re: [gentoo-pms] [PATCH] Distinguish between \e and \i. Ciaran McCreesh <ciaran.mccreesh@××××××××××.com>