[gentoo-pms] [PATCH] Distinguish between \e and \i.

[gentoo-pms] [PATCH] Distinguish between \e and \i.

[Ulrich Mueller]

Please review. In the majority of cases, \e and \i were already used
as intended. This patch fixes the few deviating cases.

A more general question, should such patches that do not change the
meaning of the text be sent to this list for review?

Ulrich


From 7137cb32f3914e154d109ac9f4cdf70cb4e9e0a4 Mon Sep 17 00:00:00 2001
From: Ulrich Mueller <ulm@gentoo.org>
Date: Fri, 28 Jan 2011 10:14:45 +0100
Subject: [PATCH] Distinguish between \e and \i.

Section "Conventions" says that \i should be used for technical terms.
---
 appendices.tex   |    2 +-
 ebuild-vars.tex  |    2 +-
 introduction.tex |    2 +-
 merge.tex        |    2 +-
 names.tex        |    2 +-
 tree-layout.tex  |    4 ++--
 6 files changed, 7 insertions(+), 7 deletions(-)

diff --git a/appendices.tex b/appendices.tex
index 093a9bc..a604a3f 100644
--- a/appendices.tex
+++ b/appendices.tex
@@ -46,7 +46,7 @@ This feature was deprecated and removed from the tree long before the introducti
 \section{cvs Versions}
 
 Portage has very crude support for CVS packages. The package \t{foo} could contain a file named
-\t{foo-cvs.1.2.3.ebuild}. This version would order \i{higher} than any non-CVS version (including
+\t{foo-cvs.1.2.3.ebuild}. This version would order \e{higher} than any non-CVS version (including
 \t{foo-2.ebuild}). This feature has not seen real world use and breaks versioned dependencies, so
 it must not be used.
 
diff --git a/ebuild-vars.tex b/ebuild-vars.tex
index 133b8b5..00e7779 100644
--- a/ebuild-vars.tex
+++ b/ebuild-vars.tex
@@ -77,7 +77,7 @@ Ebuilds may define any of the following variables:
 \item[DEPEND] See section~\ref{sec:dependencies}.
 \item[EAPI] The EAPI. See below for defaults.
 \item[PDEPEND] See section~\ref{sec:dependencies}.
-\item[PROVIDE] Zero or more qualified package names of any \e{old style}
+\item[PROVIDE] Zero or more qualified package names of any \i{old style}
     virtuals provided by this package. See section~\ref{sec:dependencies} for full syntax.
     \label{ebuild-var-provide}
 \item[RDEPEND] See section~\ref{sec:dependencies}. For some EAPIs, \t{RDEPEND} has special behaviour
diff --git a/introduction.tex b/introduction.tex
index 3986f57..4c91004 100644
--- a/introduction.tex
+++ b/introduction.tex
@@ -5,7 +5,7 @@
 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.
 
-This document is \i{not} designed to be an introduction to ebuild development. Prior knowledge of
+This document is \e{not} designed to be an introduction to ebuild development. Prior knowledge of
 ebuild creation and an understanding of how the package management system works is assumed; certain
 less familiar terms are explained in the Glossary in chapter~\ref{sec:glossary}.
 
diff --git a/merge.tex b/merge.tex
index e798f2d..8b2648d 100644
--- a/merge.tex
+++ b/merge.tex
@@ -1,6 +1,6 @@
 \chapter{Merging and Unmerging}
 
-\note{In this chapter, \e{file} and \e{regular file} have their Unix meanings.}
+\note{In this chapter, \i{file} and \i{regular file} have their Unix meanings.}
 
 \section{Overview}
 
diff --git a/names.tex b/names.tex
index 2ee5089..53fed20 100644
--- a/names.tex
+++ b/names.tex
@@ -9,7 +9,7 @@ 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 or a dot.
 
-\note A hyphen is \i{not} required because of the \t{virtual} category. Usually, however, category
+\note A hyphen is \e{not} required because of the \t{virtual} category. Usually, however, category
 names will contain a hyphen.
 
 \subsection{Package Names}
diff --git a/tree-layout.tex b/tree-layout.tex
index d548972..ed66918 100644
--- a/tree-layout.tex
+++ b/tree-layout.tex
@@ -36,7 +36,7 @@ category. Each category directory shall contain:
 \end{compactitem}
 
 Category directories may contain additional files, whose purpose is not covered by this
-specification. Additional directories that are not for a package may \i{not} be present, to avoid
+specification. Additional directories that are not for a package may \e{not} be present, to avoid
 conflicts with package name directories; an exception is made for filesystem components whose name
 starts with a dot, which the package manager must ignore, and for any directory named \t{CVS}.
 
@@ -123,7 +123,7 @@ manager must ignore any files in this directory that it does not recognise.
 \item[desc/] This directory contains files analogous to \t{use.desc} for the various \t{USE\_EXPAND}
     variables. Each file in it is named \t{<varname>.desc}, where \t{<varname>} is the variable
     name, in lowercase, whose possible values the file describes. The format of each file is as for
-    \t{use.desc}, described in section~\ref{sec:use.desc}. The \t{USE\_EXPAND} name is \i{not}
+    \t{use.desc}, described in section~\ref{sec:use.desc}. The \t{USE\_EXPAND} name is \e{not}
     included as a prefix here.
 \item[updates/] This directory is described in section~\ref{sec:updates-dir}.
 \end{description}
-- 
1.7.4.rc2

Re: [gentoo-pms] [PATCH] Distinguish between \e and \i.

[Ciaran McCreesh]

[-- Attachment #1: Type: text/plain, Size: 571 bytes --]

On Fri, 28 Jan 2011 10:26:54 +0100
Ulrich Mueller <ulm@gentoo.org> wrote:
> A more general question, should such patches that do not change the
> meaning of the text be sent to this list for review?

I'd be inclined to say yes, unless it's something that's so amazingly
obvious that it couldn't possibly be wrong.

A lack of responses to trivial patch emails doesn't mean they're being
ignored. It just means no-one's got anything to say about them, but
doesn't think the patch is controversial enough to warrant a "looks
good to me".

-- 
Ciaran McCreesh

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 198 bytes --]