[FFmpeg-cvslog] doc/git-howto.texi: Document commit signing
Michael Niedermayer
git at videolan.org
Fri Oct 28 22:17:18 EEST 2022
ffmpeg | branch: release/2.8 | Michael Niedermayer <michael at niedermayer.cc> | Tue Aug 9 21:49:04 2022 +0200| [afd3c64c0fbfa146c21c74eb7c9dd98f403db2c1] | committer: Michael Niedermayer
doc/git-howto.texi: Document commit signing
Signed-off-by: Michael Niedermayer <michael at niedermayer.cc>
(cherry picked from commit ced0dc807eb67516b341d68f04ce5a87b02820de)
Signed-off-by: Michael Niedermayer <michael at niedermayer.cc>
> http://git.videolan.org/gitweb.cgi/ffmpeg.git/?a=commit;h=afd3c64c0fbfa146c21c74eb7c9dd98f403db2c1
---
doc/git-howto.texi | 22 +++++++++++++++++++++-
1 file changed, 21 insertions(+), 1 deletion(-)
diff --git a/doc/git-howto.texi b/doc/git-howto.texi
index bf37bcced4..ebd57f3865 100644
--- a/doc/git-howto.texi
+++ b/doc/git-howto.texi
@@ -172,11 +172,18 @@ to make sure you don't have untracked files or deletions.
git add [-i|-p|-A] <filenames/dirnames>
@end example
-Make sure you have told Git your name and email address
+Make sure you have told Git your name, email address and GPG key
@example
git config --global user.name "My Name"
git config --global user.email my@@email.invalid
+git config --global user.signingkey ABCDEF0123245
+ at end example
+
+Enable signing all commits or use -S
+
+ at example
+git config --global commit.gpgsign true
@end example
Use @option{--global} to set the global configuration for all your Git checkouts.
@@ -378,6 +385,19 @@ git checkout -b svn_23456 $SHA1
where @var{$SHA1} is the commit hash from the @command{git log} output.
+ at chapter gpg key generation
+
+If you have no gpg key yet, we recommend that you create a ed25519 based key as it
+is small, fast and secure. Especially it results in small signatures in git.
+
+ at example
+gpg --default-new-key-algo "ed25519/cert,sign+cv25519/encr" --quick-generate-key "human@@server.com"
+ at end example
+
+When generating a key, make sure the email specified matches the email used in git as some sites like
+github consider mismatches a reason to declare such commits unverified. After generating a key you
+can add it to the MAINTAINER file and upload it to a keyserver.
+
@chapter Pre-push checklist
Once you have a set of commits that you feel are ready for pushing,
More information about the ffmpeg-cvslog
mailing list