Merge branch 'jc/partial-remove'

[git.git] / Documentation / SubmittingPatches

diff --git a/Documentation/SubmittingPatches b/Documentation/SubmittingPatches
index 6a4da2ddd94093aaa03656303c40a5b20bae2fef..61635bf04dc8aac5ec491f16c9c9b796457679c0 100644 (file)
--- a/Documentation/SubmittingPatches
+++ b/Documentation/SubmittingPatches
@@ -14,6 +14,8 @@ 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

+       - make sure that you have tests for the bug you are fixing
+       - make sure that the test suite passes after your commit

 
        Patch:
 
 
        Patch:
 


@@ -29,10 +31,13 @@ Checklist (and a short version for the impatient):
          corrupt whitespaces.
        - provide additional information (which is unsuitable for
          the commit message) between the "---" and the diffstat
          corrupt whitespaces.
        - provide additional information (which is unsuitable for
          the commit message) between the "---" and the diffstat

-       - send the patch to the list _and_ the maintainer
+       - send the patch to the list (git@vger.kernel.org) and the
+         maintainer (gitster@pobox.com).

        - 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.
        - 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.

+       - if your name is not writable in ASCII, make sure that
+         you send off a message in the correct encoding.

 
 Long version:
 
 
 Long version:
 


@@ -65,6 +70,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


@@ -226,7 +244,7 @@ One test you could do yourself if your MUA is set up correctly is:
     $ git fetch http://kernel.org/pub/scm/git/git.git master:test-apply
     $ git checkout test-apply
     $ git reset --hard
     $ git fetch http://kernel.org/pub/scm/git/git.git master:test-apply
     $ git checkout test-apply
     $ git reset --hard

-    $ git applymbox a.patch
+    $ git am a.patch

 
 If it does not apply correctly, there can be various reasons.
 
 
 If it does not apply correctly, there can be various reasons.
 


@@ -234,7 +252,7 @@ If it does not apply correctly, there can be various reasons.
   does not have much to do with your MUA.  Please rebase the
   patch appropriately.
 
   does not have much to do with your MUA.  Please rebase the
   patch appropriately.
 

-* Your MUA corrupted your patch; applymbox would complain that
+* Your MUA corrupted your patch; "am" would complain that

   the patch does not apply.  Look at .dotest/ subdirectory and
   see what 'patch' file contains and check for the common
   corruption patterns mentioned above.
   the patch does not apply.  Look at .dotest/ subdirectory and
   see what 'patch' file contains and check for the common
   corruption patterns mentioned above.


@@ -279,15 +297,15 @@ diff --git a/pico/pico.c b/pico/pico.c
 --- a/pico/pico.c
 +++ b/pico/pico.c
 @@ -219,7 +219,9 @@ PICO *pm;
 --- a/pico/pico.c
 +++ b/pico/pico.c
 @@ -219,7 +219,9 @@ PICO *pm;

-           switch(pico_all_done){      /* prepare for/handle final events */
-             case COMP_EXIT :          /* already confirmed */
-               packheader();
+           switch(pico_all_done){      /* prepare for/handle final events */
+             case COMP_EXIT :          /* already confirmed */
+               packheader();

 +#if 0
 +#if 0

-               stripwhitespace();
+               stripwhitespace();

 +#endif
 +#endif

-               c |= COMP_EXIT;
-               break;
- 
+               c |= COMP_EXIT;
+               break;
+

 
 (Daniel Barkalow)
 
 
 (Daniel Barkalow)