From: Junio C Hamano Date: Mon, 12 Jan 2015 19:38:54 +0000 (-0800) Subject: Merge branch 'sb/doc-submitting-patches-keep-notes' X-Git-Tag: v2.3.0-rc0~3 X-Git-Url: https://git.lorimer.id.au/gitweb.git/diff_plain/e20d5a2c4433daf09797d9e4e9f6c4eaedec86dd?ds=inline;hp=-c Merge branch 'sb/doc-submitting-patches-keep-notes' * sb/doc-submitting-patches-keep-notes: SubmittingPatches: explain rationale for using --notes with format-patch --- e20d5a2c4433daf09797d9e4e9f6c4eaedec86dd diff --combined Documentation/SubmittingPatches index 16d5d2be08,85bc071ae7..ef0eeb40cd --- a/Documentation/SubmittingPatches +++ b/Documentation/SubmittingPatches @@@ -57,8 -57,7 +57,8 @@@ change, the approach taken by the chang differs substantially from the prior version, are all good things to have. -Make sure that you have tests for the bug you are fixing. +Make sure that you have tests for the bug you are fixing. See +t/README for guidance. When adding a new feature, make sure that you have new tests to show the feature triggers the new behaviour when it should, and to show the @@@ -176,8 -175,11 +176,11 @@@ message starts, you can put a "From: " You often want to add additional explanation about the patch, other than the commit message itself. Place such "cover letter" - material between the three dash lines and the diffstat. Git-notes - can also be inserted using the `--notes` option. + material between the three-dash line and the diffstat. For + patches requiring multiple iterations of review and discussion, + an explanation of changes between each iteration can be kept in + Git-notes and inserted automatically following the three-dash + line via `git format-patch --notes`. Do not attach the patch as a MIME attachment, compressed or not. Do not let your e-mail client send quoted-printable. Do not let @@@ -255,15 -257,15 +258,15 @@@ pretty simple: if you can certify the b person who certified (a), (b) or (c) and I have not modified it. - (d) I understand and agree that this project and the contribution - are public and that a record of the contribution (including all - personal information I submit with it, including my sign-off) is - maintained indefinitely and may be redistributed consistent with - this project or the open source license(s) involved. + (d) I understand and agree that this project and the contribution + are public and that a record of the contribution (including all + personal information I submit with it, including my sign-off) is + maintained indefinitely and may be redistributed consistent with + this project or the open source license(s) involved. then you just add a line saying - Signed-off-by: Random J Developer + Signed-off-by: Random J Developer This line can be automatically added by Git if you run the git-commit command with the -s option.