| Message ID | 5697f14f1c67abbb529b450c8f2a02f2bc59963f.1612855690.git.liu.denton@gmail.com (mailing list archive) |
|---|---|
| State | Superseded |
| Headers | show |
| Series | stash show: learn --include-untracked and --only-untracked | expand |
Denton Liu <liu.denton@gmail.com> writes: > Currently, the options for the `list` and `show` subcommands are just > listed as `<options>`. This seems to imply, from a cursory glance at the > summary, that they take the stash options listed below. However, reading > more carefully, we see that they take log options and diff options > respectively. > > Make it more obvious that they take log and diff options by explicitly > stating this in the subcommand summary. Makes sense. > diff --git a/Documentation/git-stash.txt b/Documentation/git-stash.txt > index 31f1beb65b..04e55eb826 100644 > --- a/Documentation/git-stash.txt > +++ b/Documentation/git-stash.txt > @@ -67,7 +67,7 @@ save [-p|--patch] [-k|--[no-]keep-index] [-u|--include-untracked] [-a|--all] [-q > Instead, all non-option arguments are concatenated to form the stash > message. > > -list [<options>]:: > +list [<log-options>]:: > > List the stash entries that you currently have. Each 'stash entry' is > listed with its name (e.g. `stash@{0}` is the latest entry, `stash@{1}` is > @@ -83,7 +83,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 [<options>] [<stash>]:: > +show [<diff-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 first This makes me wonder if we should also update the SYNOPSIS that talks about the "list" and "show" operations taking a generic "<options>", though.
diff --git a/Documentation/git-stash.txt b/Documentation/git-stash.txt index 31f1beb65b..04e55eb826 100644 --- a/Documentation/git-stash.txt +++ b/Documentation/git-stash.txt @@ -67,7 +67,7 @@ save [-p|--patch] [-k|--[no-]keep-index] [-u|--include-untracked] [-a|--all] [-q Instead, all non-option arguments are concatenated to form the stash message. -list [<options>]:: +list [<log-options>]:: List the stash entries that you currently have. Each 'stash entry' is listed with its name (e.g. `stash@{0}` is the latest entry, `stash@{1}` is @@ -83,7 +83,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 [<options>] [<stash>]:: +show [<diff-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 first
Currently, the options for the `list` and `show` subcommands are just listed as `<options>`. This seems to imply, from a cursory glance at the summary, that they take the stash options listed below. However, reading more carefully, we see that they take log options and diff options respectively. Make it more obvious that they take log and diff options by explicitly stating this in the subcommand summary. Signed-off-by: Denton Liu <liu.denton@gmail.com> --- Documentation/git-stash.txt | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-)