Skip to content

Commit df45cb3

Browse files
bradkinggitster
authored andcommitted
commit-tree: document -S option consistently
Commit ba3c69a (commit: teach --gpg-sign option, 2011-10-05) added the -S option but documented it in the command usage without indicating that the value is optional and forgot to mention it in the manpage. Later commit 098bbdc (Add -S, --gpg-sign option to manpage of "git commit", 2012-10-21) documented the option in the porcelain manpage. Use wording from the porcelain manpage to document the option in the plumbing manpage. Also update the commit-tree usage summary to indicate that the -S value is optional to be consistent with the manpage and with the implementation. Signed-off-by: Brad King <[email protected]> Signed-off-by: Junio C Hamano <[email protected]>
1 parent 7b592fa commit df45cb3

File tree

2 files changed

+7
-2
lines changed

2 files changed

+7
-2
lines changed

Documentation/git-commit-tree.txt

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,9 @@ SYNOPSIS
1010
--------
1111
[verse]
1212
'git commit-tree' <tree> [(-p <parent>)...] < changelog
13-
'git commit-tree' [(-p <parent>)...] [(-m <message>)...] [(-F <file>)...] <tree>
13+
'git commit-tree' [(-p <parent>)...] [-S[<keyid>]] [(-m <message>)...]
14+
[(-F <file>)...] <tree>
15+
1416

1517
DESCRIPTION
1618
-----------
@@ -52,6 +54,9 @@ OPTIONS
5254
Read the commit log message from the given file. Use `-` to read
5355
from the standard input.
5456

57+
-S[<keyid>]::
58+
GPG-sign commit.
59+
5560

5661
Commit Information
5762
------------------

builtin/commit-tree.c

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
#include "utf8.h"
1111
#include "gpg-interface.h"
1212

13-
static const char commit_tree_usage[] = "git commit-tree [(-p <sha1>)...] [-S<signer>] [-m <message>] [-F <file>] <sha1> <changelog";
13+
static const char commit_tree_usage[] = "git commit-tree [(-p <sha1>)...] [-S[<keyid>]] [-m <message>] [-F <file>] <sha1> <changelog";
1414

1515
static void new_parent(struct commit *parent, struct commit_list **parents_p)
1616
{

0 commit comments

Comments
 (0)