This is the mail archive of the
gcc-patches@gcc.gnu.org
mailing list for the GCC project.
Re: c-tree.texi Doc Patch (Third Attempt)
- From: "Tom Browder" <tom dot browder at gmail dot com>
- To: "Joseph S. Myers" <joseph at codesourcery dot com>
- Cc: gcc-patches at gcc dot gnu dot org
- Date: Mon, 4 Feb 2008 18:37:29 -0600
- Subject: Re: c-tree.texi Doc Patch (Third Attempt)
On Mon, Feb 4, 2008 at 12:43 PM, Joseph S. Myers
<joseph@codesourcery.com> wrote:
> On Mon, 4 Feb 2008, Tom Browder wrote:
>
> > Defined term 'cv' in original compound word 'cv-qualification', and
> > changed 'cv-qualification' to its expanded form to help persons not
> > familiar with the concept.
>
> This is documentation of the internals of the C++ front end, and as such
> is intended for people familiar with the C++ standard. It is best to use
> the same terms as in the C++ standard when describing the C++ front-end
> internals, without trying to explain them locally.
All right, Joseph, you've made me look at the whole section a little
closer and with smarter eyes. How about these changes:
ChangeLog
=========
2008-02-04 Tom Browder <tom.browder@gmail.com>
* doc/c-tree.texi:
Miscellaneous edits to clarify use of type predicates.
Index: c-tree.texi
===================================================================
--- c-tree.texi (revision 132105)
+++ c-tree.texi (working copy)
@@ -327,9 +327,9 @@ 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
-the type @code{const int ()[7]}, denoting an array of seven @code{int}s.
+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
+for 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:
@ftable @code
@@ -939,0 +939,0 @@ an @code{int}.
@item DECL_ARTIFICIAL
This predicate holds if the declaration was implicitly generated by the
-compiler. For example, this predicate will hold of an implicitly
-declared member function, or of the @code{TYPE_DECL} implicitly
+compiler. For example, this predicate will hold for an implicitly
+declared member function, or for the @code{TYPE_DECL} implicitly
generated for a class type. Recall that in C++ code like:
@smallexample
struct S @{@};
@@ -1657,4 +1657,4 @@ embedded @code{NUL}-characters.
If the assembly statement is declared @code{volatile}, or if the
statement was not an extended assembly statement, and is therefore
implicitly volatile, then the predicate @code{ASM_VOLATILE_P} will hold
-of the @code{ASM_EXPR}.
+for the @code{ASM_EXPR}.
@item BREAK_STMT
@@ -1703,1 +1703,1 @@ fields.
@item CTOR_STMT
Used to mark the beginning (if @code{CTOR_BEGIN_P} holds) or end (if
-@code{CTOR_END_P} holds of the main body of a constructor. See also
+@code{CTOR_END_P} holds) for the main body of a constructor. See also
@code{SUBOBJECT} for more information on how to use these nodes.
@item DECL_STMT
@@ -1823,2 +1823,2 @@ handlers are obtained by following the @
handler to the next. The body of the handler is given by
@code{HANDLER_BODY}.
-If @code{CLEANUP_P} holds of the @code{TRY_BLOCK}, then the
+If @code{CLEANUP_P} holds for the @code{TRY_BLOCK}, then the
@code{TRY_HANDLERS} will not be a @code{HANDLER} node. Instead, it will
be an expression that should be executed if an exception is thrown in
the try block. It must rethrow the exception after executing that code.
@@ -2681,2 +2681,2 @@ a representation similar to that of @cod
the @code{AGGR_INIT_EXPR_FN} and @code{AGGR_INIT_EXPR_ARG} macros to access
the function to call and the arguments to pass.
-If @code{AGGR_INIT_VIA_CTOR_P} holds of the @code{AGGR_INIT_EXPR}, then
+If @code{AGGR_INIT_VIA_CTOR_P} holds for the @code{AGGR_INIT_EXPR}, then
the initialization is via a constructor call. The address of the
@code{AGGR_INIT_EXPR_SLOT} operand, which is always a @code{VAR_DECL},
is taken, and this value replaces the first argument in the argument