From: Jan Kratochvil <jan.kratochvil@redhat.com>
To: Doug Evans <dje@google.com>
Cc: gdb-patches@sourceware.org,
Joel Brobecker <brobecker@adacore.com>,
Ken Werner <ken@linux.vnet.ibm.com>,
Tom Tromey <tromey@redhat.com>,
Pedro Alves <pedro@codesourcery.com>
Subject: Re: [doc RFA] Switch to GCC coding style [Re: [patch] initial OpenCL C language support]
Date: Tue, 02 Nov 2010 17:23:00 -0000 [thread overview]
Message-ID: <20101102172246.GA22137@host0.dyn.jankratochvil.net> (raw)
In-Reply-To: <AANLkTimWg8HcVGa756vxHr=azHZTxU7KwrH+m_E+XBrV@mail.gmail.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
next prev parent reply other threads:[~2010-11-02 17:23 UTC|newest]
Thread overview: 36+ messages / expand[flat|nested] mbox.gz Atom feed top
2010-10-22 17:21 [patch] initial OpenCL C language support Ken Werner
2010-10-25 22:41 ` Tom Tromey
2010-10-26 13:05 ` Ken Werner
2010-10-26 13:44 ` Tom Tromey
2010-10-26 16:02 ` Ken Werner
2010-10-26 17:49 ` Eli Zaretskii
2010-10-26 19:58 ` Joel Brobecker
2010-10-26 20:03 ` Joel Brobecker
2010-10-27 13:36 ` Ken Werner
2010-11-02 19:23 ` Joel Brobecker
2010-11-03 13:03 ` Ken Werner
2010-11-03 15:27 ` Joel Brobecker
2010-11-04 15:39 ` Ken Werner
2010-11-04 17:48 ` Eli Zaretskii
2010-11-05 14:21 ` Ken Werner
2010-11-05 14:39 ` Ken Werner
2010-10-27 19:04 ` Jan Kratochvil
2010-10-27 19:21 ` Pedro Alves
2010-10-27 21:01 ` Ken Werner
2010-11-02 16:52 ` [doc RFA] Switch to GCC coding style [Re: [patch] initial OpenCL C language support] Jan Kratochvil
2010-11-02 17:04 ` Doug Evans
2010-11-02 17:23 ` Jan Kratochvil [this message]
2010-11-02 17:29 ` Doug Evans
2010-11-02 19:21 ` Eli Zaretskii
2010-11-02 19:29 ` Joel Brobecker
2010-11-08 12:50 ` Jan Kratochvil
2010-11-08 16:11 ` Joel Brobecker
2010-11-08 16:38 ` Mark Kettenis
2010-11-08 16:43 ` Joel Brobecker
2010-11-08 16:54 ` Pedro Alves
2010-11-08 18:36 ` Joel Brobecker
2010-11-02 18:01 ` Joel Brobecker
2010-11-02 18:10 ` [doc RFA] Switch to GCC coding style Jan Kratochvil
2010-11-02 18:20 ` Doug Evans
2010-11-02 18:58 ` Joel Brobecker
2010-11-02 19:19 ` Doug Evans
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20101102172246.GA22137@host0.dyn.jankratochvil.net \
--to=jan.kratochvil@redhat.com \
--cc=brobecker@adacore.com \
--cc=dje@google.com \
--cc=gdb-patches@sourceware.org \
--cc=ken@linux.vnet.ibm.com \
--cc=pedro@codesourcery.com \
--cc=tromey@redhat.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).