[PATCH] Document conding style

Martin Koegler· Feb 27, 2008, 08:13 UTC · lore

Signed-off-by: Martin Koegler <mkoegler@auto.tuwien.ac.at>
---
Documentation/CodingGuidelines |   27 +++++++++++++++++++++++++++
 1 files changed, 27 insertions(+), 0 deletions(-)

Show changes to Documentation/CodingGuidelines +27 −0

diff --git a/Documentation/CodingGuidelines b/Documentation/CodingGuidelines
index 3b042db..e1b5d78 100644
--- a/Documentation/CodingGuidelines
+++ b/Documentation/CodingGuidelines
@@ -77,6 +77,30 @@ For C programs:
    of "else if" statements, it can make sense to add braces to
    single line blocks.
 
+ - Avoid trailing whitespaces
+
+ - Pointer to struct foo type is (struct foo *), not (struct foo*)
+
+ - One space each around comparison operator "=="
+
+ - One space around assignment operator "="
+
+ - One space after "if", "while", "switch" and friends before "("
+
+ - No space between function name and "("
+
+ - A function without parameter is "static void foo(void)", not
+   "static void foo()"
+
+ - Don't do any declaration after a statement.
+
+ - Multi-line comment is:
+
+        /*
+         * This is multi line comment
+         * and this is its second line.
+         */
+
  - Try to make your code understandable.  You may put comments
    in, but comments invariably tend to stale out when the code
    they were describing changes.  Often splitting a function
@@ -105,6 +129,9 @@ For C programs:
    changed and discussed.  Many git commands started out like
    that, and a few are still scripts.
 
+ - Consider checking your patches with checkpatch from the linux 
+   kernel. It helps you to spot trivial formating errors.
+
  - Avoid introducing a new dependency into git. This means you
    usually should stay away from scripting languages not already
    used in the git core command set (unless your command is clearly

-- 
1.5.4.3.ga3d8

David Symonds· Feb 27, 2008, 08:36 UTC · re: Martin Koegler · lore

Re: [PATCH] Document conding style

On Wed, Feb 27, 2008 at 7:13 PM, Martin Koegler <mkoegler@auto.tuwien.ac.at> wrote:

>  + - Consider checking your patches with checkpatch from the linux
>  +   kernel. It helps you to spot trivial formating errors.
>  +

Consider checking your spelling, too?  ;-)

Dave.

Johannes Schindelin· Feb 27, 2008, 09:43 UTC · re: Martin Koegler · lore

Re: [PATCH] Document conding style

Hi,

[it is "coding", not "conding", and technically, it is already documented]

Alternatively, we could repeat these lines from the existing CodingGuidelines 3 times:

> As for more concrete guidelines, just imitate the existing code
> (this is a good guideline, no matter which project you are
> contributing to).

And maybe hint at "git diff --check" _before_ committing?

Ciao, Dscho

Jean-Luc Herren· Feb 28, 2008, 13:07 UTC · re: Martin Koegler · lore

Re: [PATCH] Document conding style

Martin Koegler wrote:

> + - Avoid trailing whitespaces
> +

Maybe it's worth mentioning that the default pre-commit hook does that for you (among other things); you just need to enable it.

jlh

patchDocument conding style