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

From: Junio C Hamano <gitster@pobox.com>
Date: Oct 21, 2012, 20:15 UTC
Message-ID: <7vbofvfup7.fsf@alter.siamese.dyndns.org>
In-Reply-To: <20121021195455.43D8F7D4C@ralph.oxix.org>

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.