commit-tree: document -S option consistently
Commit ba3c69a9 (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 098bbdc3 (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 <brad.king@kitware.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Brad King committed
Mar 25, 2013 at 17:00 UTC
df45cb3ea31eee8ad1c763d1b8a35da87366017f
2 files changed
+7
-2
Documentation/git-commit-tree.txt
+6
-1
@@ -10,7 +10,9 @@ SYNOPSIS
10
--------
11
[verse]
12
'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
+
16
17
DESCRIPTION
18
-----------
@@ -52,6 +54,9 @@ OPTIONS
54
Read the commit log message from the given file. Use `-` to read
55
from the standard input.
56
57
+-S[<keyid>]::
58
+ GPG-sign commit.
59
+
60
61
Commit Information
62
------------------
builtin/commit-tree.c
+1
-1
@@ -10,7 +10,7 @@
10
#include "utf8.h"
11
#include "gpg-interface.h"
12
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";
14
15
static void new_parent(struct commit *parent, struct commit_list **parents_p)
16
{