Re: [PATCH 1/5] Signing API: Added documentation for the new signing interface
- From
brian m. carlson <sandals@crustytoothpaste.net>
- Date
- Aug 26, 2019, 22:46 UTC
- Message-ID
- <20190826224646.GA11334@genre.crustytoothpaste.net>
- In-Reply-To
- <ypmMJFfJKsMOkTyunHZWwCKR1v7qaULVMMH7qlGMGN-l06V37iCnXvQLpzkr0N-1neSgCpZAtd1eKzbed2GAxvgMM15rOe-cGRsHzrglV8k=@pm.me>
On 2019-08-26 at 19:57:53, Ibrahim El wrote:
> From: Ibrahim El Rhezzali <ibrahim.el@pm.me> > > 2f8f82549 Added documentation for the new signing interface
This seems out of place. Also, your commit summary isn't in the imperative mood. See Documentation/SubmittingPatches for more details.
> This contains a model document and updated Documentation detailing new interface and config aliases and their description
You'll probably want to wrap your commit messages at 72 characters.
Show 16 quoted lines
> diff --git a/Documentation/config/signing.txt b/Documentation/config/signing.txt > new file mode 100644 > index 000000000..b6b8b8825 > --- /dev/null > +++ b/Documentation/config/signing.txt > @@ -0,0 +1,63 @@ > +signing.default:: > + The default signing format to use when signing commits and tags. > + The value must be one of: "openpgp", "x509", or "bettersign". > + The default value is "openpgp". > ++ > +The default executable to run for "openpgp" is "`gpg`", for "x509" is > +"`gpgsm`", and for "bettersign" is "`bs`". > ++ > +The "bettersign" tool can be found here: > +https://github.com/dhuseby/bs
I don't think we want to introduce the use of this tool. The repository contains three commits starting in May of this year. GnuPG's gpg and gpgsm tools have been around a long time and implement IETF-standardized protocols that are mature and have been well researched. This tool doesn't seem to meet that threshold.
It should be fine to set up the API such that one could use it if they wanted to with appropriate configuration, but I don't think we want to add support for it by default.
Show 5 quoted lines
> diff --git a/Documentation/technical/signing-interface.png b/Documentation/technical/signing-interface.png > new file mode 100644 > index 0000000000000000000000000000000000000000..1a44a7f665d4a546ac6f18fb10208547e6a5fced > GIT binary patch > literal 76116
This doesn't appear to be used in this patch, and the commit message doesn't explain why it's included. I haven't looked at it, but if it's a chart of some sort, we usually prefer ASCII art for that purpose.
-- brian m. carlson: Houston, Texas, US OpenPGP: https://keybase.io/bk2204