This is the mail archive of the gdb-patches@sourceware.org mailing list for the GDB 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]

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


On Tue, Nov 2, 2010 at 9:51 AM, Jan Kratochvil
<jan.kratochvil@redhat.com> wrote:
> On Wed, 27 Oct 2010 21:20:50 +0200, Pedro Alves wrote:
>> GCC makes that rule explicit:
>>
>> http://gcc.gnu.org/codingconventions.html
> [...]
>> We tend to follow these already,
>
> In such case is this patch OK?
>
> Another question is bfd/, opcodes/ etc.
>
>
> 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'.
> ? ? ? ?(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{*}:
> @@ -7821,7 +7820,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
>

There are lots of things on the gcc codingconventions page that need
to be converted (e.g., gcc_assert), or revised (e.g., prototypes for
_initialize_foo fns can appear in .c files (and should *only* appear
in .c files)).

I'm not sure, but it might be simpler to just copy over the relevant bits.


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