From df45cb3ea31eee8ad1c763d1b8a35da87366017f Mon Sep 17 00:00:00 2001 From: Brad King Date: Mon, 25 Mar 2013 17:00:07 -0400 Subject: [PATCH] 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 Signed-off-by: Junio C Hamano --- Documentation/git-commit-tree.txt | 7 ++++++- builtin/commit-tree.c | 2 +- 2 files changed, 7 insertions(+), 2 deletions(-) diff --git a/Documentation/git-commit-tree.txt b/Documentation/git-commit-tree.txt index 86ef56e7c8..cafdc9642d 100644 --- a/Documentation/git-commit-tree.txt +++ b/Documentation/git-commit-tree.txt @@ -10,7 +10,9 @@ SYNOPSIS -------- [verse] 'git commit-tree' [(-p )...] < changelog -'git commit-tree' [(-p )...] [(-m )...] [(-F )...] +'git commit-tree' [(-p )...] [-S[]] [(-m )...] + [(-F )...] + DESCRIPTION ----------- @@ -52,6 +54,9 @@ OPTIONS Read the commit log message from the given file. Use `-` to read from the standard input. +-S[]:: + GPG-sign commit. + Commit Information ------------------ diff --git a/builtin/commit-tree.c b/builtin/commit-tree.c index eac901a0ee..f641ff2a89 100644 --- a/builtin/commit-tree.c +++ b/builtin/commit-tree.c @@ -10,7 +10,7 @@ #include "utf8.h" #include "gpg-interface.h" -static const char commit_tree_usage[] = "git commit-tree [(-p )...] [-S] [-m ] [-F ]