FYI: My Coding Style cheat-sheet on the Wiki

FYI: My Coding Style cheat-sheet on the Wiki

[Joel Brobecker]

This is something I started writing down in a text file, and thought
I'd share. This is unofficial, and incomplete, and there is a big
disclaimer about it.

The intention for this document is to be a cheat-sheet in the situations
where you know there is a rule about something, but can't remember what
exactly it says. Instead of having to grep 2 documents (the GCS, and
our GDB Internal's manual), the cheat-sheet is meant to be a possible
help.

I hope that it helps others.  Everyone should feel free to update
and enhance this document, if they find it useful.  I hope that
the cheap-to-update simplicity of the Wiki will encourage anyone
to do so.

http://sourceware.org/gdb/wiki/JoelsCodingStyleCheatSheet

This page is also accessible from the HomePage.

-- 
Joel

Re: FYI: My Coding Style cheat-sheet on the Wiki

[Hui Zhu]

I suggest we make a script that can check the format of the patch and
tell which line's format is not right.  Like in Linux kernel
scripts/checkpatch.pl

Thanks,
Hui

On Thu, Jan 6, 2011 at 16:32, Joel Brobecker <brobecker@adacore.com> wrote:
> This is something I started writing down in a text file, and thought
> I'd share. This is unofficial, and incomplete, and there is a big
> disclaimer about it.
>
> The intention for this document is to be a cheat-sheet in the situations
> where you know there is a rule about something, but can't remember what
> exactly it says. Instead of having to grep 2 documents (the GCS, and
> our GDB Internal's manual), the cheat-sheet is meant to be a possible
> help.
>
> I hope that it helps others.  Everyone should feel free to update
> and enhance this document, if they find it useful.  I hope that
> the cheap-to-update simplicity of the Wiki will encourage anyone
> to do so.
>
> http://sourceware.org/gdb/wiki/JoelsCodingStyleCheatSheet
>
> This page is also accessible from the HomePage.
>
> --
> Joel
>

Re: FYI: My Coding Style cheat-sheet on the Wiki

[Yao Qi]

On 01/06/2011 04:32 PM, Joel Brobecker wrote:
> I hope that it helps others.  Everyone should feel free to update
> and enhance this document, if they find it useful.  I hope that
> the cheap-to-update simplicity of the Wiki will encourage anyone
> to do so.
> 
> http://sourceware.org/gdb/wiki/JoelsCodingStyleCheatSheet

> /* The maximum number of tasks known to the Ada runtime */
> static const int MAX_NUMBER_OF_KNOWN_TASKS = 1000;

What is the expected/correct format of comment here?  Isn't ended with
period and two spaces?  If we still follow the "period and two spaces"
schema here,  I'll update this wikipage and source code to reflect this.

-- 
Yao (齐尧)

Re: FYI: My Coding Style cheat-sheet on the Wiki

[Joel Brobecker]

> > /* The maximum number of tasks known to the Ada runtime */
> > static const int MAX_NUMBER_OF_KNOWN_TASKS = 1000;
> 
> What is the expected/correct format of comment here?  Isn't ended with
> period and two spaces?  If we still follow the "period and two spaces"
> schema here,  I'll update this wikipage and source code to reflect this.

(blush) Worst example I could have chosen... This is bad.
Yes, you are correct, a period and 2 spaces would be required.
It's not entirely obvious, since you can argue that the comment
is not a sentence.  However, for something that long, either we
make it a real sentence, or we think of it as a sentence.  Only
in the case of very short comment can we get away with no period
at the end of comment...

Thanks for catching this.  I will fix the code...

-- 
Joel