This is the mail archive of the
gcc-patches@gcc.gnu.org
mailing list for the GCC project.
Patch to use logical quoting in documentation
- From: "Joseph S. Myers" <jsm at polyomino dot org dot uk>
- To: gcc-patches at gcc dot gnu dot org
- Date: Thu, 28 Oct 2004 00:24:25 +0000 (UTC)
- Subject: Patch to use logical quoting in documentation
As discussed in connection with the printed manual production, the manual
should use logical quoting with punctuation only inside quotes if it is
part of the quoted material. This patch (parts from the printed manual)
fixes some quoting to be logical. It passes "make info" and "make dvi".
Applied to mainline.
--
Joseph S. Myers http://www.srcf.ucam.org/~jsm28/gcc/
jsm@polyomino.org.uk (personal mail)
joseph@codesourcery.com (CodeSourcery mail)
jsm28@gcc.gnu.org (Bugzilla assignments and CCs)
Index: ChangeLog
===================================================================
RCS file: /cvs/gcc/gcc/gcc/ChangeLog,v
retrieving revision 2.6060
diff -u -r2.6060 ChangeLog
--- ChangeLog 27 Oct 2004 23:02:07 -0000 2.6060
+++ ChangeLog 28 Oct 2004 00:17:59 -0000
@@ -1,3 +1,9 @@
+2004-10-28 Joseph S. Myers <jsm@polyomino.org.uk>
+
+ * doc/c-tree.texi, doc/cpp.texi, doc/implement-c.texi,
+ doc/invoke.texi, doc/md.texi, doc/passes.texi, doc/tm.texi: Put
+ punctuation outside quotes.
+
2004-10-27 David Mosberger <davidm@hpl.hp.com>
James E Wilson <wilson@specifixinc.com>
Index: doc/c-tree.texi
===================================================================
RCS file: /cvs/gcc/gcc/gcc/doc/c-tree.texi,v
retrieving revision 1.64
diff -u -r1.64 c-tree.texi
--- doc/c-tree.texi 22 Sep 2004 19:43:04 -0000 1.64
+++ doc/c-tree.texi 28 Oct 2004 00:18:00 -0000
@@ -145,7 +145,7 @@
Occasionally, a particular tree slot (like an operand to an expression,
or a particular field in a declaration) will be referred to as
-``reserved for the back end.'' These slots are used to store RTL when
+``reserved for the back end''. These slots are used to store RTL when
the tree is converted to RTL for use by the GCC back end. However, if
that process is not taking place (e.g., if the front end is being hooked
up to an intelligent editor), then those slots may be used by the
@@ -1551,7 +1551,7 @@
argument is the initializer for the object. The object is initialized
when the @code{RETURN_INIT} is encountered. The object referred to is
the actual object returned; this extension is a manual way of doing the
-``return-value optimization.'' Therefore, the object must actually be
+``return-value optimization''. Therefore, the object must actually be
constructed in the place where the object will be returned.
@item RETURN_STMT
Index: doc/cpp.texi
===================================================================
RCS file: /cvs/gcc/gcc/gcc/doc/cpp.texi,v
retrieving revision 1.72
diff -u -r1.72 cpp.texi
--- doc/cpp.texi 17 Sep 2004 08:22:36 -0000 1.72
+++ doc/cpp.texi 28 Oct 2004 00:18:02 -0000
@@ -510,7 +510,7 @@
preprocessor. @xref{C++ Named Operators}.
In the 1999 C standard, identifiers may contain letters which are not
-part of the ``basic source character set,'' at the implementation's
+part of the ``basic source character set'', at the implementation's
discretion (such as accented Latin letters, Greek letters, or Chinese
ideograms). This may be done with an extended character set, or the
@samp{\u} and @samp{\U} escape sequences. GCC does not presently
@@ -596,7 +596,7 @@
@end smallexample
@cindex other tokens
-Any other single character is considered ``other.'' It is passed on to
+Any other single character is considered ``other''. It is passed on to
the preprocessor's output unmolested. The C compiler will almost
certainly reject source code containing ``other'' tokens. In ASCII, the
only other characters are @samp{@@}, @samp{$}, @samp{`}, and control
@@ -1076,7 +1076,7 @@
There is no way to solve this problem within the C standard, but you can
use the GNU extension @samp{#include_next}. It means, ``Include the
-@emph{next} file with this name.'' This directive works like
+@emph{next} file with this name''. This directive works like
@samp{#include} except in searching for the specified file: it starts
searching the list of header file directories @emph{after} the directory
in which the current file was found.
@@ -4104,7 +4104,7 @@
@item @samp{#line} and @samp{#include}
The @samp{#line} directive used to change GCC's notion of the
-``directory containing the current file,'' used by @samp{#include} with
+``directory containing the current file'', used by @samp{#include} with
a double-quoted header file name. In 3.0 and later, it does not.
@xref{Line Control}, for further explanation.
Index: doc/implement-c.texi
===================================================================
RCS file: /cvs/gcc/gcc/gcc/doc/implement-c.texi,v
retrieving revision 1.2
diff -u -r1.2 implement-c.texi
--- doc/implement-c.texi 29 Jul 2004 17:11:25 -0000 1.2
+++ doc/implement-c.texi 28 Oct 2004 00:18:02 -0000
@@ -8,7 +8,7 @@
A conforming implementation of ISO C is required to document its
choice of behavior in each of the areas that are designated
-``implementation defined.'' The following lists all such areas,
+``implementation defined''. The following lists all such areas,
along with the section numbers from the ISO/IEC 9899:1990 and ISO/IEC
9899:1999 standards. Some areas are only implementation-defined in
one version of the standard.
Index: doc/invoke.texi
===================================================================
RCS file: /cvs/gcc/gcc/gcc/doc/invoke.texi,v
retrieving revision 1.549
diff -u -r1.549 invoke.texi
--- doc/invoke.texi 27 Oct 2004 21:02:08 -0000 1.549
+++ doc/invoke.texi 28 Oct 2004 00:18:07 -0000
@@ -3896,8 +3896,8 @@
# as 0.00 0.01
@end smallexample
-The first number on each line is the ``user time,'' that is time spent
-executing the program itself. The second number is ``system time,''
+The first number on each line is the ``user time'', that is time spent
+executing the program itself. The second number is ``system time'',
time spent executing operating system routines on behalf of the program.
Both numbers are in seconds.
@@ -10760,11 +10760,11 @@
On Darwin/PPC systems, @code{#pragma longcall} will generate ``jbsr
callee, L42'', plus a ``branch island'' (glue code). The two target
-addresses represent the callee and the ``branch island.'' The
+addresses represent the callee and the ``branch island''. The
Darwin/PPC linker will prefer the first address and generate a ``bl
callee'' if the PPC ``bl'' instruction will reach the callee directly;
otherwise, the linker will generate ``bl L42'' to call the ``branch
-island.'' The ``branch island'' is appended to the body of the
+island''. The ``branch island'' is appended to the body of the
calling function; it computes the full 32-bit address of the callee
and jumps to it.
Index: doc/md.texi
===================================================================
RCS file: /cvs/gcc/gcc/gcc/doc/md.texi,v
retrieving revision 1.112
diff -u -r1.112 md.texi
--- doc/md.texi 13 Oct 2004 20:53:43 -0000 1.112
+++ doc/md.texi 28 Oct 2004 00:18:09 -0000
@@ -1307,9 +1307,9 @@
@noindent
the first pattern would not apply at all, because this insn does not
contain two identical subexpressions in the right place. The pattern would
-say, ``That does not look like an add instruction; try other patterns.''
+say, ``That does not look like an add instruction; try other patterns''.
The second pattern would say, ``Yes, that's an add instruction, but there
-is something wrong with it.'' It would direct the reload pass of the
+is something wrong with it''. It would direct the reload pass of the
compiler to generate additional insns to make the constraint true. The
results might look like this:
Index: doc/passes.texi
===================================================================
RCS file: /cvs/gcc/gcc/gcc/doc/passes.texi,v
retrieving revision 1.43
diff -u -r1.43 passes.texi
--- doc/passes.texi 25 Sep 2004 14:04:07 -0000 1.43
+++ doc/passes.texi 28 Oct 2004 00:18:09 -0000
@@ -110,8 +110,8 @@
@cindex GIMPLE
@dfn{Gimplification} is a whimsical term for the process of converting
the intermediate representation of a function into the GIMPLE language
-(CROSSREF). The term stuck, and so words like ``gimplification,''
-``gimplify,'' ``gimplifier'' and the like are sprinkled throughout this
+(CROSSREF). The term stuck, and so words like ``gimplification'',
+``gimplify'', ``gimplifier'' and the like are sprinkled throughout this
section of code.
@cindex GENERIC
Index: doc/tm.texi
===================================================================
RCS file: /cvs/gcc/gcc/gcc/doc/tm.texi,v
retrieving revision 1.386
diff -u -r1.386 tm.texi
--- doc/tm.texi 27 Oct 2004 21:17:08 -0000 1.386
+++ doc/tm.texi 28 Oct 2004 00:18:13 -0000
@@ -2860,7 +2860,7 @@
Define this macro if pushing a word onto the stack moves the stack
pointer to a smaller address.
-When we say, ``define this macro if @dots{},'' it means that the
+When we say, ``define this macro if @dots{}'', it means that the
compiler checks this macro only with @code{#ifdef} so the precise
definition used does not matter.
@end defmac