diff options
author | Alejandro Colomar <alx@kernel.org> | 2024-05-03 18:11:45 +0200 |
---|---|---|
committer | Alejandro Colomar <alx@kernel.org> | 2024-05-04 01:23:56 +0200 |
commit | 0109de689446da17dc9c2e55af61f46179e3b764 (patch) | |
tree | 2a3bbe9db43e89363db42f5279508bba6b406b07 /CONTRIBUTING.d | |
parent | 55b0cc2dff842c20c41201dfe34968bd4ee6108d (diff) |
CONTRIBUTING.d/*: Add instructions for configuring git(1) for this project
Signed-off-by: Alejandro Colomar <alx@kernel.org>
Diffstat (limited to 'CONTRIBUTING.d')
-rw-r--r-- | CONTRIBUTING.d/git | 41 | ||||
-rw-r--r-- | CONTRIBUTING.d/patches | 26 |
2 files changed, 46 insertions, 21 deletions
diff --git a/CONTRIBUTING.d/git b/CONTRIBUTING.d/git new file mode 100644 index 000000000..4f1003a61 --- /dev/null +++ b/CONTRIBUTING.d/git @@ -0,0 +1,41 @@ +Name + Git - instructions for configuring git(1) + +Description + git-diff(1), gitattributes(5) + To produce useful hunk contexts in manual pages, we need to hack + git(1)'s idea of a function name, and also to tell git what is a + manual page. + + $ git config --global diff.man.xfuncname '^\.S[SHsh] .*$'; + $ echo '*.[0-9]* diff=man' >>~/.config/git/attributes; + + git-format-patch(1) + Send patches to the right addresses. + + $ git config --local format.to 'Alejandro Colomar <alx@kernel.org>'; + $ git config --local format.cc '<linux-man@vger.kernel.org>'; + + git-send-email(1) + If mutt(1) or neomutt(1) are configured in the system, + git-send-email(1) can be configured to use any of them as a + driver. Recent versions of neomutt(1) can enable crypto with -C. + + $ git config --global \ + sendemail.sendmailcmd 'neomutt -C -H - && true'; + or + $ git config --global sendemail.sendmailcmd 'mutt -H - && true'; + +See also + git-config(1) + git-diff(1) + git-format-patch(1) + git-send-email(1) + gitattributes(5) + mutt(1) + neomutt(1) + + CONTRIBUTING.d/* + + <https://git-send-email.io/> + <https://neomutt.org/feature/cli-crypto> diff --git a/CONTRIBUTING.d/patches b/CONTRIBUTING.d/patches index afd8c2e36..35f492341 100644 --- a/CONTRIBUTING.d/patches +++ b/CONTRIBUTING.d/patches @@ -5,6 +5,8 @@ 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>. See also "Send the patches" below. @@ -121,30 +123,12 @@ Description 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) as a driver, which only requires the following - section in <~/.gitconfig> (assuming mutt(1) is already configured - for sending mail): - - [sendemail] - sendmailcmd = mutt -H - && true - - In <man-pages/.git/config>, the following configuration will - simplify sending to the right addresses: - - [sendemail] - to = Alejandro Colomar <alx@kernel.org> - cc = linux-man@vger.kernel.org + 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. git-send-email(1) can be configured to use a recent - version of neomutt(1) (>= 20240201), to sign patches with PGP - (assuming neomutt(1) is already configured for sending signed - mail). neomutt(1)'s -C flag enables crypto: - - [sendemail] - sendmailcmd = neomutt -C -H - && true + 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 |