mirrors/git
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

SubmittingPatches: note on whitespaces

Browse Source 
Signed-off-by: Junio C Hamano <junkio@cox.net>
This commit is contained in:
Junio C Hamano
2006-02-17 16:15:26 -08:00
parent 020e3c1ee6
commit 45d2b286ac
1 changed files with 19 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

30
Documentation/SubmittingPatches
View File

@ -4,8 +4,8 @@ it for the core GIT to make sure people understand what they are
doing when they write "Signed-off-by" line. doing when they write "Signed-off-by" line.
But the patch submission requirements are a lot more relaxed But the patch submission requirements are a lot more relaxed
here, because the core GIT is thousand times smaller ;-). So here on the technical/contents front, because the core GIT is
here is only the relevant bits. thousand times smaller ;-). So here is only the relevant bits.
(1) Make separate commits for logically separate changes. (1) Make separate commits for logically separate changes.
@ -18,13 +18,19 @@ repository. It is a good discipline.
Describe the technical detail of the change(s). Describe the technical detail of the change(s).
If your description starts to get long, that's a sign that you If your description starts to get too long, that's a sign that you
probably need to split up your commit to finer grained pieces. probably need to split up your commit to finer grained pieces.
Oh, another thing. I am picky about whitespaces. Make sure your
changes do not trigger errors with the sample pre-commit hook shipped
in templates/hooks--pre-commit.
(2) Generate your patch using git/cogito out of your commits.
git diff tools generate unidiff which is the preferred format. (2) Generate your patch using git tools out of your commits.
git based diff tools (git, Cogito, and StGIT included) generate
unidiff which is the preferred format.
You do not have to be afraid to use -M option to "git diff" or You do not have to be afraid to use -M option to "git diff" or
"git format-patch", if your patch involves file renames. The "git format-patch", if your patch involves file renames. The
receiving end can handle them just fine. receiving end can handle them just fine.
@ -33,20 +39,22 @@ Please make sure your patch does not include any extra files
which do not belong in a patch submission. Make sure to review which do not belong in a patch submission. Make sure to review
your patch after generating it, to ensure accuracy. Before your patch after generating it, to ensure accuracy. Before
sending out, please make sure it cleanly applies to the "master" sending out, please make sure it cleanly applies to the "master"
branch head. branch head. If you are preparing a work based on "next" branch,
that is fine, but please mark it as such.
(3) Sending your patches. (3) Sending your patches.
People on the git mailing list needs to be able to read and People on the git mailing list need to be able to read and
comment on the changes you are submitting. It is important for comment on the changes you are submitting. It is important for
a developer to be able to "quote" your changes, using standard a developer to be able to "quote" your changes, using standard
e-mail tools, so that they may comment on specific portions of e-mail tools, so that they may comment on specific portions of
your code. For this reason, all patches should be submitting your code. For this reason, all patches should be submited
e-mail "inline". WARNING: Be wary of your MUAs word-wrap "inline". WARNING: Be wary of your MUAs word-wrap
corrupting your patch. Do not cut-n-paste your patch. corrupting your patch. Do not cut-n-paste your patch; you can
lose tabs that way if you are not careful.
It is common convention to prefix your subject line with It is a common convention to prefix your subject line with
[PATCH]. This lets people easily distinguish patches from other [PATCH]. This lets people easily distinguish patches from other
e-mail discussions. e-mail discussions.