Skip to contentSkip to conversation

CONTRIBUTING.d/: Clarify how to send patches with git-send-email(1)

PATCH New Alejandro Colomar 1 participant 1 message Apr 26, 2024 Man-pages: manual pages for Linux -- Sections 2, 3, 4, 5, and 7

lore
Share & tools
lore

Alejandro Colomar

author maintainer
#0 lore raw

PATCH 1/1 CONTRIBUTING.d/: Clarify how to send patches with git-send-email(1)

Cc Simon Barth <[email protected]>
Signed-off-by Alejandro Colomar <[email protected]>
---
 CONTRIBUTING.d/mail    |  8 --------
 CONTRIBUTING.d/patches | 27 ++++++++++++++++++++++++++-
 2 files changed, 26 insertions(+), 9 deletions(-)
CONTRIBUTING.d/mail +0 -8
index 48e5b9a93..fc75b9eee 100644
@@ -51,14 +51,6 @@ Description
         using a PGP key.  See also:
         <https://www.gnupg.org/faq/gnupg-faq.html#use_pgpmime>
 
-        There are many ways you can sign your patches, and it depends on
-        your preferred tools.  You can use neomutt(1) (>= 20240201) as a
-        driver for git-send-email(1).  In <~/.gitconfig>, add the
-        following section:
-
-            [sendemail]
-                sendmailcmd = neomutt -C -H - && true
-
 See also
        CONTRIBUTING
        CONTRIBUTING.d/*
CONTRIBUTING.d/patches +26 -1
index 96550ce0e..b4de1cf9f 100644
@@ -6,7 +6,8 @@ Description
        <CONTRIBUTING.d/bugs>), then send a patch in an email.
 
        -  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 +88,32 @@ Description
        -  Make patches against the latest version of the manual page.
           Use git(1) for getting the latest version.
 
+
+   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/>.  It can also be configured to
+       use mutt(1), which only requires the following section in
+       <~/.gitconfig> (assuming mutt(1) is already configured for
+       sending mail):
+
+           [sendemail]
+               sendmailcmd = mutt -H - && true
+
+   Sign the patches with PGP
+       See <CONTRIBUTING.d/mail> for more details on signing your mail
+       to the list.  git-send-email(1) can be configured to use a recent
+       version of neomutt(1) (>= 20240201) with the -C flag, to sign
+       patches with PGP (assuming neomutt(1) is already configured for
+       sending signed mail):
+
+           [sendemail]
+               sendmailcmd = neomutt -C -H - && true
+
 See also
        CONTRIBUTING
        CONTRIBUTING.d/*
 
        <https://www.kernel.org/doc/Documentation/process/submitting-patches.rst>
+       <https://git-send-email.io/>
+       <https://neomutt.org/feature/cli-crypto>
Signature · 1 line
2.43.0