Skip to content

Commit

Permalink
Documentation: move support for old compilers to CodingGuidelines
Browse files Browse the repository at this point in the history
The "Try to be nice to older C compilers" text is clearly a guideline
to be borne in mind whilst coding rather than when submitting patches.

Signed-off-by: Adam Spiers <git@adamspiers.org>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
  • Loading branch information
Adam Spiers authored and Junio C Hamano committed Dec 17, 2012
1 parent 6a5b649 commit a26fd03
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 13 deletions.
8 changes: 8 additions & 0 deletions Documentation/CodingGuidelines
Original file line number Diff line number Diff line change
Expand Up @@ -112,6 +112,14 @@ For C programs:

- We try to keep to at most 80 characters per line.

- We try to support a wide range of C compilers to compile git with,
including old ones. That means that you should not use C99
initializers, even if a lot of compilers grok it.

- Variables have to be declared at the beginning of the block.

- NULL pointers shall be written as NULL, not as 0.

- When declaring pointers, the star sides with the variable
name, i.e. "char *string", not "char* string" or
"char * string". This makes it easier to understand code
Expand Down
13 changes: 0 additions & 13 deletions Documentation/SubmittingPatches
Original file line number Diff line number Diff line change
Expand Up @@ -127,19 +127,6 @@ in templates/hooks--pre-commit. To help ensure this does not happen,
run git diff --check on your changes before you commit.


(1a) Try to be nice to older C compilers

We try to support a wide range of C compilers to compile
git with. That means that you should not use C99 initializers, even
if a lot of compilers grok it.

Also, variables have to be declared at the beginning of the block
(you can check this with gcc, using the -Wdeclaration-after-statement
option).

Another thing: NULL pointers shall be written as NULL, not as 0.


(2) Generate your patch using git tools out of your commits.

git based diff tools generate unidiff which is the preferred format.
Expand Down

0 comments on commit a26fd03

Please sign in to comment.