X-Git-Url: https://git.tokkee.org/?a=blobdiff_plain;f=Documentation%2FSubmittingPatches;h=b94d9a816664333e0b1767c22d1639b8839cee24;hb=99f171bb7ac5032dde256c02476240c0d019a5fe;hp=8cf5093dd9b51881977437a327fe69cad12e7efd;hpb=bff898b894815ad291b35d213f1c022d1d16a9b9;p=git.git diff --git a/Documentation/SubmittingPatches b/Documentation/SubmittingPatches index 8cf5093dd..b94d9a816 100644 --- a/Documentation/SubmittingPatches +++ b/Documentation/SubmittingPatches @@ -30,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 + - 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: @@ -62,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