From: Junio C Hamano Date: Thu, 4 May 2017 07:26:46 +0000 (+0900) Subject: Merge branch 'rg/doc-submittingpatches-wordfix' X-Git-Tag: v2.13.0-rc2~3 X-Git-Url: https://git.lorimer.id.au/gitweb.git/diff_plain/9f3e2fe9f4176b5f0eb14e26b34d21f4dffcebd2?ds=inline;hp=-c Merge branch 'rg/doc-submittingpatches-wordfix' * rg/doc-submittingpatches-wordfix: doc: update SubmittingPatches --- 9f3e2fe9f4176b5f0eb14e26b34d21f4dffcebd2 diff --combined Documentation/SubmittingPatches index bc8ad00473,75c886aa10..558d465b65 --- a/Documentation/SubmittingPatches +++ b/Documentation/SubmittingPatches @@@ -51,7 -51,7 +51,7 @@@ If your description starts to get too l probably need to split up your commit to finer grained pieces. That being said, patches which plainly describe the things that help reviewers check the patch, and future maintainers understand - the code, are the most beautiful patches. Descriptions that summarise + the code, are the most beautiful patches. Descriptions that summarize the point in the subject well, and describe the motivation for the change, the approach taken by the change, and if relevant how this differs substantially from the prior version, are all good things @@@ -87,7 -87,7 +87,7 @@@ patches separate from other documentati Oh, another thing. We are picky about whitespaces. Make sure your changes do not trigger errors with the sample pre-commit hook shipped 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. (2) Describe your changes well. @@@ -98,23 -98,18 +98,23 @@@ should skip the full stop. It is also prefix the first line with "area: " where the area is a filename or identifier for the general area of the code being modified, e.g. - . archive: ustar header checksum is computed unsigned - . git-cherry-pick.txt: clarify the use of revision range notation + . doc: clarify distinction between sign-off and pgp-signing + . githooks.txt: improve the intro section If in doubt which identifier to use, run "git log --no-merges" on the files you are modifying to see the current conventions. +It's customary to start the remainder of the first line after "area: " +with a lower-case letter. E.g. "doc: clarify...", not "doc: +Clarify...", or "githooks.txt: improve...", not "githooks.txt: +Improve...". + The body should provide a meaningful commit message, which: - . explains the problem the change tries to solve, iow, what is wrong + . explains the problem the change tries to solve, i.e. what is wrong with the current code without the change. - . justifies the way the change solves the problem, iow, why the + . justifies the way the change solves the problem, i.e. why the result with the change is better. . alternate solutions considered but discarded, if any. @@@ -122,7 -117,7 +122,7 @@@ Describe your changes in imperative mood, e.g. "make xyzzy do frotz" instead of "[This patch] makes xyzzy do frotz" or "[I] changed xyzzy to do frotz", as if you are giving orders to the codebase to change - its behaviour. Try to make sure your explanation can be understood + its behavior. Try to make sure your explanation can be understood without external resources. Instead of giving a URL to a mailing list archive, summarize the relevant points of the discussion. @@@ -134,9 -129,8 +134,9 @@@ with the subject enclosed in a pair of noticed that ... The "Copy commit summary" command of gitk can be used to obtain this -format. +format, or this invocation of "git show": + git show -s --date=short --pretty='format:%h ("%s", %ad)' (3) Generate your patch using Git tools out of your commits. @@@ -261,7 -255,7 +261,7 @@@ smaller project it is a good disciplin The sign-off is a simple line at the end of the explanation for the patch, which certifies that you wrote it or otherwise have the right to pass it on as a open-source patch. The rules are - pretty simple: if you can certify the below: + pretty simple: if you can certify the below D-C-O: Developer's Certificate of Origin 1.1