diff options
Diffstat (limited to '')
| -rw-r--r-- | CONTRIBUTING.d/patches | 48 |
1 files changed, 47 insertions, 1 deletions
diff --git a/CONTRIBUTING.d/patches b/CONTRIBUTING.d/patches index 96550ce..35f4923 100644 --- a/CONTRIBUTING.d/patches +++ b/CONTRIBUTING.d/patches @@ -5,8 +5,11 @@ Description If you know how to fix a problem in a manual page (if not, see <CONTRIBUTING.d/bugs>), then send a patch in an email. + - Configure git(1) for this project. See <CONTRIBUTING.d/git>. + - Follow the instructions for sending mail to the mailing list - from <CONTRIBUTING.d/mail>. + from <CONTRIBUTING.d/mail>. See also "Send the patches" + below. - The subject of the email should contain "[patch]" in the subject line. @@ -87,8 +90,51 @@ Description - Make patches against the latest version of the manual page. Use git(1) for getting the latest version. + Prepare the patches for email submission + We recommend using git-format-patch(1) to prepare the patches. + Please use --range-diff to document the differences between + revisions of the patch set, even in the first revision. + + To prepare a branch to be sent as a patch set (v1): + + $ git format-patch -o ./patches master..HEAD \ + --range-diff=master -v1 --cover-letter; + + The range diff will be included in the cover letter (or in a + single patch, if there is only one): + + $ tail -n7 ./patches/v1-0000-cover-letter.patch; + Range-diff against v0: + -: --------- > 1: 7ec952012 foo.3: tfix + -: --------- > 2: d80376b08 bar.3: ffix + -: --------- > 3: 892a12470 foo.3: wfix + -- + 2.43.0 + + To send a v2 after some feedback: + + $ git format-patch -o ./patches master..HEAD \ + --range-diff=old_master..old_HEAD -v2 --cover-letter; + + The values for 'old_master' and 'old_HEAD' can be consulted in + the previous cover letter. In this example, it would be + '--range-diff=7ec952012^..892a12470'. + + Send the patches + We recommend using git-send-email(1) to send the patches to the + mailing list. For instructions on how to configure and use it, + see <https://git-send-email.io/>. See also <CONTRIBUTING.d/git>. + + Sign the patches with PGP + See <CONTRIBUTING.d/mail> for more details on signing your mail + to the list. See also <CONTRIBUTING.d/git> for instructions for + configuring git-send-email(1) to use neomutt(1) as a driver. + See also CONTRIBUTING CONTRIBUTING.d/* <https://www.kernel.org/doc/Documentation/process/submitting-patches.rst> + <https://inbox.sourceware.org/gcc/ZiV5unTogyI7rPJA@debian/> + <https://git-send-email.io/> + <https://neomutt.org/feature/cli-crypto> |