diff mbox

[DOC] CP_TYPE_QUALS -> cp_type_quals

Message ID alpine.DEB.2.02.1108081453170.3776@stedding.saclay.inria.fr
State New
Headers show

Commit Message

Marc Glisse Aug. 8, 2011, 1:04 p.m. UTC 
Hello,

apparently the doc wasn't updated 10 years ago when the macro 
CP_TYPE_QUALS was replaced with the function cp_type_quals. I assume the 
behavior didn't change, so the documentation change should be minor. Or 
are functions documented differently?

2011-08-08  Marc Glisse  <marc.glisse@inria.fr>

 	* doc/generic.texi: CP_TYPE_QUALS -> cp_type_quals

Comments

Paolo Carlini Aug. 30, 2011, 9:16 p.m. UTC | #1 
Hi,
> apparently the doc wasn't updated 10 years ago when the macro 
> CP_TYPE_QUALS was replaced with the function cp_type_quals. I assume 
> the behavior didn't change, so the documentation change should be 
> minor. Or are functions documented differently?
>
> 2011-08-08  Marc Glisse <marc.glisse@inria.fr>
>
>     * doc/generic.texi: CP_TYPE_QUALS -> cp_type_quals
>
Jason, can you have a look to this doc patchlet? I can take care of 
committing it, in case.

Thanks,
Paolo.
Paolo Carlini Aug. 31, 2011, 9:27 a.m. UTC | #2 
.. I applied the patch after running make info and make dvi, seems 
obvious to me.

Thanks,
Paolo.
diff mbox

Patch

Index: doc/generic.texi
===================================================================
--- doc/generic.texi	(revision 177557)
+++ doc/generic.texi	(working copy)
@@ -2504,7 +2504,7 @@ 
 @tindex UNKNOWN_TYPE
 @tindex TYPENAME_TYPE
 @tindex TYPEOF_TYPE
-@findex CP_TYPE_QUALS
+@findex cp_type_quals
 @findex TYPE_UNQUALIFIED
 @findex TYPE_QUAL_CONST
 @findex TYPE_QUAL_VOLATILE
@@ -2536,8 +2536,8 @@ 
 
 The following functions and macros deal with cv-qualification of types:
 @ftable @code
-@item CP_TYPE_QUALS
-This macro returns the set of type qualifiers applied to this type.
+@item cp_type_quals
+This function returns the set of type qualifiers applied to this type.
 This value is @code{TYPE_UNQUALIFIED} if no qualifiers have been
 applied.  The @code{TYPE_QUAL_CONST} bit is set if the type is
 @code{const}-qualified.  The @code{TYPE_QUAL_VOLATILE} bit is set if the