This is the mail archive of the gcc-patches@gcc.gnu.org mailing list for the GCC project.


Index Nav: [Date Index] [Subject Index] [Author Index] [Thread Index]
Message Nav: [Date Prev] [Date Next] [Thread Prev] [Thread Next]
Other format: [Raw text]

Minor Doc Edits


Following are proposed changes to several gcc/doc/*.texi files for
"GCC Compiler Collection Internals":

The changes include such things as "it's" (plural) to "its"
(possessive), "language specific" to "language-specifc", etc.  I also
started changing some CVS references to Subversion (SVN) but some are
associated with old CVS-repository-specific references which need
decoding and those I'll try to fix later.

There are some other problems with line spacing I've noticed (such as
in Section 9.6.2.1) but don't know how to fix yet.

Later I would like to offer some sample code in the tree section if
that is acceptable (and I know what I'm doing).

changelog
=========
2008-01-30 Tom Browder <tom.browder@gmail.com>
	* gcc/doc/configterms.texi: minor edits
	* gcc/doc/cpp.texi: minor edits
	* gcc/doc/c-tree.texi: minor edits
	* gcc/doc/install.texi: minor edits
	* gcc/doc/makefile.texi: minor edits
	* gcc/doc/passes.texi: minor edits
	* gcc/doc/sourcebuild.texi: minor edits

patch file
=======
Index: sourcebuild.texi
===================================================================
--- sourcebuild.texi	(revision 131959)
+++ sourcebuild.texi	(working copy)
@@ -368,7 +368,7 @@ directory or in @file{doc/include}.  HTM
 @samp{makeinfo --html}, PostScript manuals by @command{texi2dvi}
 and @command{dvips}, and PDF manuals by @command{texi2pdf}.
 All Texinfo files that are parts of manuals must
-be checked into CVS, even if they are generated files, for the
+be checked into SVN, even if they are generated files, for the
 generation of online manuals to work.

 The installation manual, @file{doc/install.texi}, is also provided on
@@ -502,7 +502,7 @@ Details of the directories of any runtim
 @file{gcc/doc/sourcebuild.texi}.
 @end itemize

-If the front end is added to the official GCC CVS repository, the
+If the front end is added to the official GCC SVN repository, the
 following are also necessary:

 @itemize @bullet
@@ -540,8 +540,6 @@ to list the tarballs and diffs for this
 If this front end includes its own version files that include the
 current date, @file{maintainer-scripts/update_version} should be
 updated accordingly.
-@item
-@file{CVSROOT/modules} in the GCC CVS repository should be updated.
 @end itemize

 @menu
@@ -782,7 +780,7 @@ manual needs to be installed as info for
 chapter of this manual.
 @end itemize

-If the back end is added to the official GCC CVS repository, the
+If the back end is added to the official GCC Subversion (SVN) repository, the
 following are also necessary:

 @itemize @bullet
Index: cpp.texi
===================================================================
--- cpp.texi	(revision 131959)
+++ cpp.texi	(working copy)
@@ -1996,7 +1996,7 @@ on the command line of the preprocessor
 This macro expands to a decimal integer constant that represents the
 depth of nesting in include files.  The value of this macro is
 incremented on every @samp{#include} directive and decremented at the
-end of every included file.  It starts out at 0, it's value within the
+end of every included file.  It starts out at 0, its value within the
 base file specified on the command line.

 @item __ELF__
Index: passes.texi
===================================================================
--- passes.texi	(revision 131959)
+++ passes.texi	(working copy)
@@ -32,7 +32,7 @@ The language front end is invoked only o
 @code{lang_hooks.parse_file}, to parse the entire input.  The language
 front end may use any intermediate language representation deemed
 appropriate.  The C front end uses GENERIC trees (CROSSREF), plus
-a double handful of language specific tree codes defined in
+a double handful of language-specific tree codes defined in
 @file{c-common.def}.  The Fortran front end uses a completely different
 private representation.

@@ -132,7 +132,7 @@ passes through here at least once, and i
 invoke the @code{lang_hooks.gimplify_expr} callback.

 The callback should examine the expression in question and return
-@code{GS_UNHANDLED} if the expression is not a language specific
+@code{GS_UNHANDLED} if the expression is not a language-specific
 construct that requires attention.  Otherwise it should alter the
 expression in some way to such that forward progress is made toward
 producing valid GIMPLE@.  If the callback is certain that the
@@ -366,7 +366,7 @@ This pass transforms tail recursion into

 @item Forward store motion

-This pass sinks stores and assignments down the flowgraph closer to it's
+This pass sinks stores and assignments down the flowgraph closer to their
 use point.  The pass is located in @file{tree-ssa-sink.c} and is
 described by @code{pass_sink_code}.

@@ -384,7 +384,7 @@ in @file{tree-ssa-math-opts.c} and is de

 @item Full redundancy elimination

-This is a simpler form of PRE that only eliminate redundancies that
+This is a simpler form of PRE that only eliminates redundancies that
 occur an all paths.  It is located in @file{tree-ssa-pre.c} and
 described by @code{pass_fre}.

@@ -444,9 +444,9 @@ into several threads.  The pass is imple
 @item Tree level if-conversion for vectorizer

 This pass applies if-conversion to simple loops to help vectorizer.
-We identify if convertible loops, if-convert statements and merge
+We identify if convertible loops, if-convert statements, and merge
 basic blocks in one big block.  The idea is to present loop in such
-form so that vectorizer can have one to one mapping between statements
+form so that vectorizer can have one-to-one mapping between statements
 and available vector operations.  This patch re-introduces COND_EXPR
 at GIMPLE level.  This pass is located in @file{tree-if-conv.c} and is
 described by @code{pass_if_conversion}.
Index: makefile.texi
===================================================================
--- makefile.texi	(revision 131959)
+++ makefile.texi	(working copy)
@@ -100,7 +100,7 @@ rebuilt, and copied to its subdirectory.
 example, continue a bootstrap after fixing a bug which causes the
 stage2 build to crash.  It does not provide as good coverage of the
 compiler as bootstrapping from scratch, but it ensures that the new
-code is syntactically correct (e.g. that you did not use GCC extensions
+code is syntactically correct (e.g., that you did not use GCC extensions
 by mistake), and avoids spurious bootstrap comparison
 failures@footnote{Except if the compiler was buggy and miscompiled
   some of the files that were not modified.  In this case, it's best
Index: c-tree.texi
===================================================================
--- c-tree.texi	(revision 131959)
+++ c-tree.texi	(working copy)
@@ -312,7 +312,7 @@ The elements are indexed from zero.

 All types have corresponding tree nodes.  However, you should not assume
 that there is exactly one tree node corresponding to each type.  There
-are often several nodes each of which correspond to the same type.
+are often multiple nodes corresponding to the same type.

 For the most part, different kinds of types have different tree codes.
 (For example, pointer types use a @code{POINTER_TYPE} code while arrays
@@ -327,11 +327,11 @@ elements is qualified.  This situation i
 representation.  The macros described here will always examine the
 qualification of the underlying element type when applied to an array
 type.  (If the element type is itself an array, then the recursion
-continues until a non-array type is found, and the qualification of this
-type is examined.)  So, for example, @code{CP_TYPE_CONST_P} will hold of
+continues until a non-array type is found and the qualification of its
+type is examined.)  So, for example, @code{CP_TYPE_CONST_P} will hold
 the type @code{const int ()[7]}, denoting an array of seven @code{int}s.

-The following functions and macros deal with cv-qualification of types:
+The following functions and macros deal with cp-qualification of types:
 @ftable @code
 @item CP_TYPE_QUALS
 This macro returns the set of type qualifiers applied to this type.
@@ -1149,7 +1149,7 @@ Adding a new @code{DECL} tree consists o
 @table @asis

 @item Add a new tree code for the @code{DECL} node
-For language specific @code{DECL} nodes, there is a @file{.def} file
+For language-specific @code{DECL} nodes, there is a @file{.def} file
 in each frontend directory where the tree code should be added.
 For @code{DECL} nodes that are part of the middle-end, the code should
 be added to @file{tree.def}.
@@ -1168,7 +1168,7 @@ struct tree_foo_decl
 Would create a structure name @code{tree_foo_decl} that inherits from
 @code{struct tree_decl_with_vis}.

-For language specific @code{DECL} nodes, this new structure type
+For language-specific @code{DECL} nodes, this new structure type
 should go in the appropriate @file{.h} file.
 For @code{DECL} nodes that are part of the middle-end, the structure
 type should go in @file{tree.h}.
@@ -1177,7 +1177,7 @@ type should go in @file{tree.h}.
 For garbage collection and dynamic checking purposes, each @code{DECL}
 node structure type is required to have a unique enumerator value
 specified with it.
-For language specific @code{DECL} nodes, this new enumerator value
+For language-specific @code{DECL} nodes, this new enumerator value
 should go in the appropriate @file{.def} file.
 For @code{DECL} nodes that are part of the middle-end, the enumerator
 values are specified in @file{treestruct.def}.
@@ -1185,7 +1185,7 @@ values are specified in @file{treestruct
 @item Update @code{union tree_node}
 In order to make your new structure type usable, it must be added to
 @code{union tree_node}.
-For language specific @code{DECL} nodes, a new entry should be added
+For language-specific @code{DECL} nodes, a new entry should be added
 to the appropriate @file{.h} file of the form
 @smallexample
   struct tree_foo_decl GTY ((tag ("TS_VAR_DECL"))) foo_decl;
@@ -1202,7 +1202,7 @@ This lookup table needs to be kept up to
 hierarchy, or else checking and containment macros will fail
 inappropriately.

-For language specific @code{DECL} nodes, their is an @code{init_ts}
+For language-specific @code{DECL} nodes, there is an @code{init_ts}
 function in an appropriate @file{.c} file, which initializes the lookup
 table.
 Code setting up the table for new @code{DECL} nodes should be added
@@ -2017,7 +2017,7 @@ mind.  In particular, the expression ``t
 acyclic graph.  (For example there may be many references to the integer
 constant zero throughout the source program; many of these will be
 represented by the same expression node.)  You should not rely on
-certain kinds of node being shared, nor should rely on certain kinds of
+certain kinds of node being shared, nor should you rely on certain kinds of
 nodes being unshared.

 The following macros can be used with all expression nodes:
Index: configterms.texi
===================================================================
--- configterms.texi	(revision 131959)
+++ configterms.texi	(working copy)
@@ -39,7 +39,7 @@ There is a proposal to call this a @dfn{

 If build and host are the same, the GCC you are building will also be
 used to build the target libraries (like @code{libstdc++}).  If build and host
-are different, you must have already build and installed a cross
+are different, you must have already built and installed a cross
 compiler that will be used to build the target libraries (if you
 configured with @option{--target=foo-bar}, this compiler will be called
 @command{foo-bar-gcc}).
Index: md.texi
===================================================================
--- md.texi	(revision 131959)
+++ md.texi	(working copy)
@@ -2895,7 +2895,7 @@ Multiple letter constraint followed by 4
          value of the other parts (F---all bits set)
 @end table
 The constraint matches if the specified part of a constant
-has a value different from it's other parts.
+has a value different from its other parts.

 @item Q
 Memory reference without index register and with short displacement.
Index: install.texi
===================================================================
--- install.texi	(revision 131959)
+++ install.texi	(working copy)
@@ -483,12 +483,12 @@ Fortran, and Java.  In GCC 3.0 and later
 testsuites are also included in the full distribution.

 If you choose to download specific components, you must download the core
-GCC distribution plus any language specific distributions you wish to
+GCC distribution plus any language-specific distributions you wish to
 use.  The core distribution includes the C language front end as well as the
 shared components.  Each language has a tarball which includes the language
 front end as well as the language runtime (when appropriate).

-Unpack the core distribution as well as any language specific
+Unpack the core distribution as well as any language-specific
 distributions in the same directory.

 If you also intend to build binutils (either to upgrade an existing

-Tom
-- 
Tom Browder
Niceville, Florida
USA


Index Nav: [Date Index] [Subject Index] [Author Index] [Thread Index]
Message Nav: [Date Prev] [Date Next] [Thread Prev] [Thread Next]