Re: [PATCH] Documentation/commit-tree: mention -S option

From: Junio C Hamano <gitster@pobox.com>
Date: Mar 25, 2013, 20:39 UTC
Message-ID: <7vy5dbw6w2.fsf@alter.siamese.dyndns.org>
In-Reply-To: <14b024f9ee5c6319a0ff1f700f52d29b2464764f.1364240065.git.brad.king@kitware.com>

Brad King <brad.king@kitware.com> writes:

Show 6 quoted lines

> Commit ba3c69a9 (commit: teach --gpg-sign option, 2011-10-05) added the
> -S option and documented it in the command usage.  Then commit 098bbdc3
> (Add -S, --gpg-sign option to manpage of "git commit", 2012-10-21)
> documented it in the porcelain manpage.  Use wording from the porcelain
> to document the option in the plumbing manpage too.
> ---

This does not seem to use the same wording, though.

	git commit -S

will pick up the signing key by calling get_signing_key() the same way "git tag -s" would, iow, <keyid> part is optional.

Show 28 quoted lines

>  Documentation/git-commit-tree.txt |    7 ++++++-
>  1 file changed, 6 insertions(+), 1 deletion(-)
>
> diff --git a/Documentation/git-commit-tree.txt b/Documentation/git-commit-tree.txt
> index 86ef56e..62f7b53 100644
> --- a/Documentation/git-commit-tree.txt
> +++ b/Documentation/git-commit-tree.txt
> @@ -10,7 +10,9 @@ SYNOPSIS
>  --------
>  [verse]
>  'git commit-tree' <tree> [(-p <parent>)...] < changelog
> -'git commit-tree' [(-p <parent>)...] [(-m <message>)...] [(-F <file>)...] <tree>
> +'git commit-tree' [(-p <parent>)...] [-S<keyid>] [(-m <message>)...]
> +		  [(-F <file>)...] <tree>
> +
>  
>  DESCRIPTION
>  -----------
> @@ -52,6 +54,9 @@ OPTIONS
>  	Read the commit log message from the given file. Use `-` to read
>  	from the standard input.
>  
> +-S<keyid>::
> +	GPG-sign commit.
> +
>  
>  Commit Information
>  ------------------