Re: [GSoC][PATCH v7 11/26] stash: change `git stash show` usage text and documentation
From: Thomas Gummerer <hidden>
Date: 2018-08-15 20:27:00
Subject: stash: change `git stash show` usage text and documentation
Another nitpick about commit messages. "change ... usage text and documentation" doesn't say much about what the actual change is. How about something like "stash: mention options in "show" synopsis" instead? The change itself looks good to me, thanks! On 08/08, Paul-Sebastian Ungureanu wrote:
quoted hunk ↗ jump to hunk
It is already stated in documentation that it will accept any option known to `git diff`, but not in the usage text and some parts of the documentation. Signed-off-by: Paul-Sebastian Ungureanu <redacted> --- Documentation/git-stash.txt | 4 ++-- builtin/stash--helper.c | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-)diff --git a/Documentation/git-stash.txt b/Documentation/git-stash.txt index 7ef8c4791..e31ea7d30 100644 --- a/Documentation/git-stash.txt +++ b/Documentation/git-stash.txt@@ -9,7 +9,7 @@ SYNOPSIS -------- [verse] 'git stash' list [<options>] -'git stash' show [<stash>] +'git stash' show [<options>] [<stash>] 'git stash' drop [-q|--quiet] [<stash>] 'git stash' ( pop | apply ) [--index] [-q|--quiet] [<stash>] 'git stash' branch <branchname> [<stash>]@@ -106,7 +106,7 @@ stash@{1}: On master: 9cc0589... Add git-stash The command takes options applicable to the 'git log' command to control what is shown and how. See linkgit:git-log[1]. -show [<stash>]:: +show [<options>] [<stash>]:: Show the changes recorded in the stash entry as a diff between the stashed contents and the commit back when the stash entry was firstdiff --git a/builtin/stash--helper.c b/builtin/stash--helper.c index e764cd33e..0c1efca6b 100644 --- a/builtin/stash--helper.c +++ b/builtin/stash--helper.c@@ -13,7 +13,7 @@ static const char * const git_stash_helper_usage[] = { N_("git stash--helper list [<options>]"), - N_("git stash--helper show [<stash>]"), + N_("git stash--helper show [<options>] [<stash>]"), N_("git stash--helper drop [-q|--quiet] [<stash>]"), N_("git stash--helper ( pop | apply ) [--index] [-q|--quiet] [<stash>]"), N_("git stash--helper branch <branchname> [<stash>]"),@@ -27,7 +27,7 @@ static const char * const git_stash_helper_list_usage[] = { }; static const char * const git_stash_helper_show_usage[] = { - N_("git stash--helper show [<stash>]"), + N_("git stash--helper show [<options>] [<stash>]"), NULL };-- 2.18.0.573.g56500d98f