# [PATCH] Add -S, --gpg-sign option to manpage of "git commit" 4 messages from 2012-10-21 to 2012-10-29. Participants: Tom Jones, Junio C Hamano, Jeff King. Thread: https://gitlist.dev/t/31886 ## Tom Jones, 2012-10-21 19:46 Subject: [PATCH] Add -S, --gpg-sign option to manpage of "git commit" Message-ID: <20121021195455.43D8F7D4C@ralph.oxix.org> URL: https://gitlist.dev/e/20121021195455.43D8F7D4C%40ralph.oxix.org ``` git commit -S, --gpg-sign was mentioned in the program's help message, but not in the manpage. This adds an equivalent entry for the option in the manpage. --- Documentation/git-commit.txt | 6 +++++- 1 files changed, 5 insertions(+), 1 deletions(-) diff --git a/Documentation/git-commit.txt b/Documentation/git-commit.txt index 9594ac8..0e0a22c 100644 --- a/Documentation/git-commit.txt +++ b/Documentation/git-commit.txt @@ -13,7 +13,7 @@ SYNOPSIS [-F | -m ] [--reset-author] [--allow-empty] [--allow-empty-message] [--no-verify] [-e] [--author=] [--date=] [--cleanup=] [--status | --no-status] - [-i | -o] [--] [...] + [-i | -o] [--] [-S[keyid]] [...] DESCRIPTION ----------- @@ -276,6 +276,10 @@ configuration variable documented in linkgit:git-config[1]. commit message template when using an editor to prepare the default commit message. +-S[]:: +--gpg-sign[=]:: + GPG-sign commit. + \--:: Do not interpret any more arguments as options. -- 1.7.2.5 ``` ## Tom Jones, 2012-10-21 19:46 Subject: [PATCH] Add -S, --gpg-sign option to manpage of "git commit" Message-ID: <20121023225101.189E57D4C@ralph.oxix.org> URL: https://gitlist.dev/e/20121023225101.189E57D4C%40ralph.oxix.org In-Reply-To: <7vbofvfup7.fsf@alter.siamese.dyndns.org> ``` git commit -S, --gpg-sign was mentioned in the program's help message, but not in the manpage. This adds an equivalent entry for the option in the manpage. Signed-off-by: Tom Jones --- On Sun, Oct 21, 2012 at 01:15:16PM -0700, Junio C Hamano wrote: > Are you sure about this? The order [...] Good point. Please find a revised patch, with the newly documented option before the optional double dashes, below. > Sign off? Now added, too. Documentation/git-commit.txt | 6 +++++- 1 files changed, 5 insertions(+), 1 deletions(-) diff --git a/Documentation/git-commit.txt b/Documentation/git-commit.txt index 9594ac8..4b78bd0 100644 --- a/Documentation/git-commit.txt +++ b/Documentation/git-commit.txt @@ -13,7 +13,7 @@ SYNOPSIS [-F | -m ] [--reset-author] [--allow-empty] [--allow-empty-message] [--no-verify] [-e] [--author=] [--date=] [--cleanup=] [--status | --no-status] - [-i | -o] [--] [...] + [-i | -o] [-S[keyid]] [--] [...] DESCRIPTION ----------- @@ -276,6 +276,10 @@ configuration variable documented in linkgit:git-config[1]. commit message template when using an editor to prepare the default commit message. +-S[]:: +--gpg-sign[=]:: + GPG-sign commit. + \--:: Do not interpret any more arguments as options. -- 1.7.2.5 ``` ## Junio C Hamano, 2012-10-21 20:15 Subject: Re: [PATCH] Add -S, --gpg-sign option to manpage of "git commit" Message-ID: <7vbofvfup7.fsf@alter.siamese.dyndns.org> URL: https://gitlist.dev/e/7vbofvfup7.fsf%40alter.siamese.dyndns.org In-Reply-To: <20121021195455.43D8F7D4C@ralph.oxix.org> ``` Tom Jones writes: > git commit -S, --gpg-sign was mentioned in the program's help message, > but not in the manpage. > > This adds an equivalent entry for the option in the manpage. > --- Sign off? > Documentation/git-commit.txt | 6 +++++- > 1 files changed, 5 insertions(+), 1 deletions(-) > > diff --git a/Documentation/git-commit.txt b/Documentation/git-commit.txt > index 9594ac8..0e0a22c 100644 > --- a/Documentation/git-commit.txt > +++ b/Documentation/git-commit.txt > @@ -13,7 +13,7 @@ SYNOPSIS > [-F | -m ] [--reset-author] [--allow-empty] > [--allow-empty-message] [--no-verify] [-e] [--author=] > [--date=] [--cleanup=] [--status | --no-status] > - [-i | -o] [--] [...] > + [-i | -o] [--] [-S[keyid]] [...] Are you sure about this? The order, described in "git help cli", of the command line arguments is options (such as -F -S[]) first, then revs (irrelevant for "git commit" and lack of it in this manual is correct), and then paths. Optionally "--" can be used to mark the beginning of "paths" part (e.g. "git commit -- -S" or "git commit ./-S" is used when you want to commit a file whose name is "-S"). > DESCRIPTION > ----------- > @@ -276,6 +276,10 @@ configuration variable documented in linkgit:git-config[1]. > commit message template when using an editor to prepare the > default commit message. > > +-S[]:: > +--gpg-sign[=]:: > + GPG-sign commit. > + > \--:: > Do not interpret any more arguments as options. ``` ## Jeff King, 2012-10-29 07:49 Subject: Re: [PATCH] Add -S, --gpg-sign option to manpage of "git commit" Message-ID: <20121029074932.GG5102@sigill.intra.peff.net> URL: https://gitlist.dev/e/20121029074932.GG5102%40sigill.intra.peff.net In-Reply-To: <20121023225101.189E57D4C@ralph.oxix.org> ``` On Sun, Oct 21, 2012 at 08:46:37PM +0100, Tom Jones wrote: > git commit -S, --gpg-sign was mentioned in the program's help message, > but not in the manpage. > > This adds an equivalent entry for the option in the manpage. > > Signed-off-by: Tom Jones Thanks. This slipped through the cracks last week, but I've picked it up now. > DESCRIPTION > ----------- > @@ -276,6 +276,10 @@ configuration variable documented in linkgit:git-config[1]. > commit message template when using an editor to prepare the > default commit message. > > +-S[]:: > +--gpg-sign[=]:: > + GPG-sign commit. > + Potentially we could say more (like how to verify), but I will leave that for somebody to build on top if they want. -Peff ```