From: Ibrahim El Date: Mon, 26 Aug 2019 19:57:53 GMT Subject: [PATCH 1/5] Signing API: Added documentation for the new signing interface Message-ID: From: Ibrahim El Rhezzali 2f8f82549 Added documentation for the new signing interface This contains a model document and updated Documentation detailing new interface and config aliases and their description Signed-off-by: Ibrahim El --- Documentation/config/commit.txt | 12 +++-- Documentation/config/gpg.txt | 18 ++------ Documentation/config/push.txt | 9 +++- Documentation/config/signing.txt | 63 ++++++++++++++++++++++++++ Documentation/config/tag.txt | 4 +- Documentation/config/user.txt | 10 ++-- Documentation/git-am.txt | 9 ++-- Documentation/git-cherry-pick.txt | 9 ++-- Documentation/git-commit-tree.txt | 18 ++++---- Documentation/git-commit.txt | 19 ++++---- Documentation/git-rebase.txt | 9 ++-- Documentation/git-revert.txt | 9 ++-- Documentation/merge-options.txt | 5 +- Documentation/technical/signing-interface.png | Bin 0 -> 76116 bytes 14 files changed, 132 insertions(+), 62 deletions(-) create mode 100644 Documentation/config/signing.txt create mode 100644 Documentation/technical/signing-interface.png diff --git a/Documentation/config/commit.txt b/Documentation/config/commit.txt index 2c9557393..f01dc1248 100644 --- a/Documentation/config/commit.txt +++ b/Documentation/config/commit.txt @@ -8,12 +8,14 @@ commit.cleanup:: template yourself, if you do this). commit.gpgSign:: + Deprecated alias for 'commit.sign'. - A boolean to specify whether all commits should be GPG signed. - Use of this option when doing operations such as rebase can - result in a large number of commits being signed. It may be - convenient to use an agent to avoid typing your GPG passphrase - several times. +commit.sign:: + A boolean to specify whether all commits should be cryptographically + signed. Use of this option when doing operations such as rebase can + result in a large number of commits being signed. It may be convenient + to use an agent to avoid typing your private key passphrase several + times. commit.status:: A boolean to enable/disable inclusion of status information in the diff --git a/Documentation/config/gpg.txt b/Documentation/config/gpg.txt index f999f8ea4..3abbd36bf 100644 --- a/Documentation/config/gpg.txt +++ b/Documentation/config/gpg.txt @@ -1,20 +1,8 @@ gpg.program:: - Use this custom program instead of "`gpg`" found on `$PATH` when - making or verifying a PGP signature. The program must support the - same command-line interface as GPG, namely, to verify a detached - signature, "`gpg --verify $file - <$signature`" is run, and the - program is expected to signal a good signature by exiting with - code 0, and to generate an ASCII-armored detached signature, the - standard input of "`gpg -bsau $key`" is fed with the contents to be - signed, and the program is expected to send the result to its - standard output. + Deprecated alias for 'signing.openpgp.program'. gpg.format:: - Specifies which key format to use when signing with `--gpg-sign`. - Default is "openpgp" and another possible value is "x509". + Deprecated alias for 'signing.default'. gpg..program:: - Use this to customize the program used for the signing format you - chose. (see `gpg.program` and `gpg.format`) `gpg.program` can still - be used as a legacy synonym for `gpg.openpgp.program`. The default - value for `gpg.x509.program` is "gpgsm". + Deprecated alias for 'signing..program'. diff --git a/Documentation/config/push.txt b/Documentation/config/push.txt index 0a0e00056..1443b0d31 100644 --- a/Documentation/config/push.txt +++ b/Documentation/config/push.txt @@ -61,13 +61,18 @@ push.followTags:: `--no-follow-tags`. push.gpgSign:: + Deprecated alias for 'push.sign'. + +push.sign May be set to a boolean value, or the string 'if-asked'. A true - value causes all pushes to be GPG signed, as if `--signed` is + value causes all pushes to be signed, as if `--signed` is passed to linkgit:git-push[1]. The string 'if-asked' causes pushes to be signed if the server supports it, as if `--signed=if-asked` is passed to 'git push'. A false value may override a value from a lower-priority config file. An explicit - command-line flag always overrides this config option. + command-line flag always overrides this config option. The + signing format used is specified by 'signing.default' which + defaults to "openpgp" and uses "`gpg`" to create the signatures. push.pushOption:: When no `--push-option=