threads / patch / 31886

patchAdd -S, --gpg-sign option to manpage of "git commit"

Subject: [PATCH] Add -S, --gpg-sign option to manpage of "git commit"

## tl;dr

4 messages between Oct 21, 2012 and Oct 29, 2012. Diffs are folded; open one to read it.

replies: 3people: 3as markdown or json

Tom Jones· Oct 21, 2012, 19:46 UTC · lore

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(-)

Show changes to Documentation/git-commit.txt +5 −1

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 <file> | -m <msg>] [--reset-author] [--allow-empty]
 	   [--allow-empty-message] [--no-verify] [-e] [--author=<author>]
 	   [--date=<date>] [--cleanup=<mode>] [--status | --no-status]
-	   [-i | -o] [--] [<file>...]
+	   [-i | -o] [--] [-S[keyid]] [<file>...]
 
 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[<keyid>]::
+--gpg-sign[=<keyid>]::
+	GPG-sign commit.
+
 \--::
 	Do not interpret any more arguments as options.

-- 
1.7.2.5

Junio C Hamano· Oct 21, 2012, 20:15 UTC · re: Tom Jones · lore

Re: [PATCH] Add -S, --gpg-sign option to manpage of "git commit"

Tom Jones <tom@oxix.org> writes:

Show 5 quoted lines

> 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?

Show 13 quoted lines

>  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 <file> | -m <msg>] [--reset-author] [--allow-empty]
>  	   [--allow-empty-message] [--no-verify] [-e] [--author=<author>]
>  	   [--date=<date>] [--cleanup=<mode>] [--status | --no-status]
> -	   [-i | -o] [--] [<file>...]
> +	   [-i | -o] [--] [-S[keyid]] [<file>...]

Are you sure about this? The order, described in "git help cli", of the command line arguments is options (such as -F <file> -S[<keyid>]) 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").

Show 12 quoted lines

>  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[<keyid>]::
> +--gpg-sign[=<keyid>]::
> +	GPG-sign commit.
> +
>  \--::
>  	Do not interpret any more arguments as options.

Tom Jones· Oct 21, 2012, 19:46 UTC · re: Junio C Hamano · lore

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 <tom@oxix.org>
---
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(-)

Show changes to Documentation/git-commit.txt +5 −1

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 <file> | -m <msg>] [--reset-author] [--allow-empty]
 	   [--allow-empty-message] [--no-verify] [-e] [--author=<author>]
 	   [--date=<date>] [--cleanup=<mode>] [--status | --no-status]
-	   [-i | -o] [--] [<file>...]
+	   [-i | -o] [-S[keyid]] [--] [<file>...]
 
 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[<keyid>]::
+--gpg-sign[=<keyid>]::
+	GPG-sign commit.
+
 \--::
 	Do not interpret any more arguments as options.

-- 
1.7.2.5

Jeff King· Oct 29, 2012, 07:49 UTC · re: Tom Jones · lore

Re: [PATCH] Add -S, --gpg-sign option to manpage of "git commit"

On Sun, Oct 21, 2012 at 08:46:37PM +0100, Tom Jones wrote:

Show 6 quoted lines

> 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 <tom@oxix.org>

Thanks. This slipped through the cracks last week, but I've picked it up now.

Show 10 quoted lines

>  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[<keyid>]::
> +--gpg-sign[=<keyid>]::
> +	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