From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.2 (2018-09-13) on dcvr.yhbt.net X-Spam-Level: X-Spam-ASN: AS31976 209.132.180.0/23 X-Spam-Status: No, score=-3.4 required=3.0 tests=AWL,BAYES_00,DKIM_SIGNED, DKIM_VALID,DKIM_VALID_AU,HEADER_FROM_DIFFERENT_DOMAINS, MAILING_LIST_MULTI,NORMAL_HTTP_TO_IP,NUMERIC_HTTP_ADDR, RCVD_IN_DNSWL_HI,SPF_HELO_NONE,SPF_NONE shortcircuit=no autolearn=ham autolearn_force=no version=3.4.2 Received: from vger.kernel.org (vger.kernel.org [209.132.180.67]) by dcvr.yhbt.net (Postfix) with ESMTP id 933191F461 for ; Mon, 26 Aug 2019 19:58:20 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S2387775AbfHZT6T (ORCPT ); Mon, 26 Aug 2019 15:58:19 -0400 Received: from mail1.protonmail.ch ([185.70.40.18]:24526 "EHLO mail1.protonmail.ch" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1727504AbfHZT6R (ORCPT ); Mon, 26 Aug 2019 15:58:17 -0400 Date: Mon, 26 Aug 2019 19:57:53 +0000 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=pm.me; s=proton; t=1566849479; bh=uRC2poWfCfB1qPCfFr86PFmJBsPaEiQmZhOaSZ8/t/Q=; h=Date:To:From:Cc:Reply-To:Subject:Feedback-ID:From; b=Ie1bLVNtXyxrLwhvnjVWla4Qevdl9Orc/DkmM3PTuM2DstXH/9cFiCVuZRKo8p9fn MIy3kJW1qQRshL5XIBca+BHEhPJ26pFenrNoddu7NKreqiLwgtVpKTTJL6//EIXNir z2KVmYjGBAnSS2H9b+IS/VpyPKTzG8qDo1lJdj3LPArkOXOauGTU6qpyLluNeRJKsb qhsmC5qXII7SO7onzMlN+6Ei3dIXsLXCWCksBv/DElbaTbgaKwMYHANido061mgFjS Rkj0j7II9EDDZFIy8n3q7Kc9HDEoG0Wps251hk4Qgu2fk/WKGiFPq1ny9TqkftNcmG SDYwhZm2rzW3A== To: git@vger.kernel.org From: Ibrahim El Cc: Ibrahim El Rhezzali Reply-To: Ibrahim El Subject: [PATCH 1/5] Signing API: Added documentation for the new signing interface Message-ID: Feedback-ID: RXIF8gqyi_fC5k95OfXmu3uPk6ALUZ4LT1y2TXMvXkIlhKcvgGbg1qhMCvct9LiRFa1gVJ9p8_D_liW8QUFSlg==:Ext:ProtonMail MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: quoted-printable Sender: git-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: git@vger.kernel.org From: Ibrahim El Rhezzali 2f8f82549 Added documentation for the new signing interface This contains a model document and updated Documentation detailing new inte= rface 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:: =09template yourself, if you do this). =20 commit.gpgSign:: +=09Deprecated alias for 'commit.sign'. =20 -=09A boolean to specify whether all commits should be GPG signed. -=09Use of this option when doing operations such as rebase can -=09result in a large number of commits being signed. It may be -=09convenient to use an agent to avoid typing your GPG passphrase -=09several times. +commit.sign:: +=09A boolean to specify whether all commits should be cryptographically +=09signed. Use of this option when doing operations such as rebase can +=09result in a large number of commits being signed. It may be convenient +=09to use an agent to avoid typing your private key passphrase several +=09times. =20 commit.status:: =09A 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:: -=09Use this custom program instead of "`gpg`" found on `$PATH` when -=09making or verifying a PGP signature. The program must support the -=09same command-line interface as GPG, namely, to verify a detached -=09signature, "`gpg --verify $file - <$signature`" is run, and the -=09program is expected to signal a good signature by exiting with -=09code 0, and to generate an ASCII-armored detached signature, the -=09standard input of "`gpg -bsau $key`" is fed with the contents to be -=09signed, and the program is expected to send the result to its -=09standard output. +=09Deprecated alias for 'signing.openpgp.program'. =20 gpg.format:: -=09Specifies which key format to use when signing with `--gpg-sign`. -=09Default is "openpgp" and another possible value is "x509". +=09Deprecated alias for 'signing.default'. =20 gpg..program:: -=09Use this to customize the program used for the signing format you -=09chose. (see `gpg.program` and `gpg.format`) `gpg.program` can still -=09be used as a legacy synonym for `gpg.openpgp.program`. The default -=09value for `gpg.x509.program` is "gpgsm". +=09Deprecated 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:: =09`--no-follow-tags`. =20 push.gpgSign:: +=09Deprecated alias for 'push.sign'. + +push.sign =09May be set to a boolean value, or the string 'if-asked'. A true -=09value causes all pushes to be GPG signed, as if `--signed` is +=09value causes all pushes to be signed, as if `--signed` is =09passed to linkgit:git-push[1]. The string 'if-asked' causes =09pushes to be signed if the server supports it, as if =09`--signed=3Dif-asked` is passed to 'git push'. A false value may =09override a value from a lower-priority config file. An explicit -=09command-line flag always overrides this config option. +=09command-line flag always overrides this config option. The +=09signing format used is specified by 'signing.default' which +=09defaults to "openpgp" and uses "`gpg`" to create the signatures. =20 push.pushOption:: =09When no `--push-option=3D