Merge branch 'maint-1.5.1' into maint

[git.git] / Documentation / SubmittingPatches

diff --git a/Documentation/SubmittingPatches b/Documentation/SubmittingPatches
index 131bcff9b2367d63d7c8960487893bfcbfcfaa40..b94d9a816664333e0b1767c22d1639b8839cee24 100644 (file)
--- a/Documentation/SubmittingPatches
+++ b/Documentation/SubmittingPatches
@@ -1,5 +1,7 @@
 Checklist (and a short version for the impatient):
 
 Checklist (and a short version for the impatient):
 

+       Commits:
+

        - make commits of logical units
        - check for unnecessary whitespace with "git diff --check"
          before committing
        - make commits of logical units
        - check for unnecessary whitespace with "git diff --check"
          before committing


@@ -12,8 +14,14 @@ Checklist (and a short version for the impatient):
          commit message (or just use the option "-s" when
          committing) to confirm that you agree to the Developer's
          Certificate of Origin
          commit message (or just use the option "-s" when
          committing) to confirm that you agree to the Developer's
          Certificate of Origin

-       - do not PGP sign your patch
+
+       Patch:
+

        - use "git format-patch -M" to create the patch
        - use "git format-patch -M" to create the patch

+       - send your patch to <git@vger.kernel.org>. If you use
+         git-send-email(1), please test it first by sending
+         email to yourself.
+       - do not PGP sign your patch

        - do not attach your patch, but read in the mail
          body, unless you cannot teach your mailer to
          leave the formatting of the patch alone.
        - do not attach your patch, but read in the mail
          body, unless you cannot teach your mailer to
          leave the formatting of the patch alone.


@@ -22,6 +30,9 @@ Checklist (and a short version for the impatient):
        - provide additional information (which is unsuitable for
          the commit message) between the "---" and the diffstat
        - send the patch to the list _and_ the maintainer
        - provide additional information (which is unsuitable for
          the commit message) between the "---" and the diffstat
        - send the patch to the list _and_ the maintainer

+       - if you change, add, or remove a command line option or
+         make some other user interface change, the associated
+         documentation should be updated as well.

 
 Long version:
 
 
 Long version:
 


@@ -54,6 +65,19 @@ in templates/hooks--pre-commit.  To help ensure this does not happen,
 run git diff --check on your changes before you commit.
 
 
 run git diff --check on your changes before you commit.
 
 

+(1a) Try to be nice to older C compilers
+
+We try to support 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 (git, Cogito, and StGIT included) generate
 (2) Generate your patch using git tools out of your commits.
 
 git based diff tools (git, Cogito, and StGIT included) generate