Re: [doc RFA] Switch to GCC coding style [Re: [patch] initial OpenCL C language support]

[Jan Kratochvil <jan dot kratochvil at redhat dot com>]

On Tue, 02 Nov 2010 18:04:39 +0100, Doug Evans wrote:
> There are lots of things on the gcc codingconventions page that need
> to be converted (e.g., gcc_assert),

Done.

> or revised (e.g., prototypes for _initialize_foo fns can appear in .c files
> (and should *only* appear in .c files)).

I do not see a current GDB doc problem with this (+it may be offtopic for this
patch).


Thanks,
Jan


gdb/
2010-11-02  Jan Kratochvil  <jan.kratochvil@redhat.com>
	    Pedro Alves  <pedro@codesourcery.com>

	* CONTRIBUTE (Coding Standards): Change to GCC Coding Conventions,
	update URL.

gdb/doc/
2010-11-02  Jan Kratochvil  <jan.kratochvil@redhat.com>

	* gdbint.texinfo (Coding Standards): Change to GCC Coding
	Conventions, provide URL.  Change `standards' to `conventions'.
	(C Usage): New paragraph.
	(Testsuite): Change to GCC Coding Conventions.

--- a/gdb/CONTRIBUTE
+++ b/gdb/CONTRIBUTE
@@ -28,7 +28,7 @@ all contributors need to be aware of.
 
 o	Coding Standards
 
-	All contributions must conform to the GNU Coding Standard.
+	All contributions must conform to the GCC Coding Conventions.
 	Submissions which do not conform to the standards will be
 	returned with a request to reformat the changes.
 
@@ -36,7 +36,7 @@ o	Coding Standards
 	requirements are explained in the GDB internals documentation
 	in the gdb/doc directory.
 
-	Ref: http://www.gnu.org/prep/standards_toc.html
+	Ref: http://gcc.gnu.org/codingconventions.html
 
 
 o	Copyright Assignment
--- a/gdb/doc/gdbint.texinfo
+++ b/gdb/doc/gdbint.texinfo
@@ -5765,13 +5765,12 @@ Binary search the array.
 
 @section @value{GDBN} C Coding Standards
 
-@value{GDBN} follows the GNU coding standards, as described in
-@file{etc/standards.texi}.  This file is also available for anonymous
-FTP from GNU archive sites.  @value{GDBN} takes a strict interpretation
-of the standard; in general, when the GNU standard recommends a practice
-but does not require it, @value{GDBN} requires it.
+@value{GDBN} follows the GCC Coding Conventions, available from
+@url{http://gcc.gnu.org/codingconventions.html}.  @value{GDBN} takes a strict
+interpretation of the standard; in general, when the GCC conventions recommend
+a practice but do not require it, @value{GDBN} requires it.
 
-@value{GDBN} follows an additional set of coding standards specific to
+@value{GDBN} follows an additional set of coding conventions specific to
 @value{GDBN}, as described in the following sections.
 
 @subsection ISO C
@@ -5784,7 +5783,7 @@ compiler.
 @subsection Formatting
 
 @cindex source code formatting
-The standard GNU recommendations for formatting must be followed
+The standard GCC recommendations for formatting must be followed
 strictly.
 
 A function declaration should not have its name in column zero.  A
@@ -5831,7 +5830,7 @@ void* foo;
 @subsection Comments
 
 @cindex comment formatting
-The standard GNU requirements on comments must be followed strictly.
+The standard GCC requirements on comments must be followed strictly.
 
 Block comments must appear in the following form, with no @code{/*}- or
 @code{*/}-only lines, and no leading @code{*}:
@@ -5880,6 +5879,11 @@ protected with parentheses.)
 Declarations like @samp{struct foo *} should be used in preference to
 declarations like @samp{typedef struct foo @{ @dots{} @} *foo_ptr}.
 
+@code{gcc_assert} references in GCC Coding Conventions should be replaced by
+@code{gdb_assert}.  @code{gcc_unreachable} should be replaced by
+@code{gdb_assert_not_reached}.  Standard @code{<ctype.h>} header file and its
+functions can and should be used.
+
 @subsection Function Prototypes
 @cindex function prototypes
 
@@ -7821,7 +7825,7 @@ The source language programs do @emph{not} need to be in a consistent
 style.  Since @value{GDBN} is used to debug programs written in many different
 styles, it's worth having a mix of styles in the testsuite; for
 instance, some @value{GDBN} bugs involving the display of source lines would
-never manifest themselves if the programs used GNU coding style
+never manifest themselves if the programs used GCC Coding Conventions
 uniformly.
 
 @node Hints