X-Git-Url: https://git.tokkee.org/?a=blobdiff_plain;f=Documentation%2FSubmittingPatches;h=b94d9a816664333e0b1767c22d1639b8839cee24;hb=99f171bb7ac5032dde256c02476240c0d019a5fe;hp=2386f496ee9c6151730e84385bf6b17a3eb42e10;hpb=e660e11b202f12d15cfe8089909a307b1900c03a;p=git.git diff --git a/Documentation/SubmittingPatches b/Documentation/SubmittingPatches index 2386f496e..b94d9a816 100644 --- a/Documentation/SubmittingPatches +++ b/Documentation/SubmittingPatches @@ -1,5 +1,7 @@ Checklist (and a short version for the impatient): + Commits: + - 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 - - do not PGP sign your patch + + Patch: + - use "git format-patch -M" to create the patch + - send your patch to . 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. @@ -57,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. +(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