git-stash.txt: be explicit about subcommand options
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> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Denton Liu committed
Feb 8, 2021 at 23:28 UTC
d6ab8b192907f72c415ad6aaa416f7b3b994c703
1 file changed
+4
-4
Documentation/git-stash.txt
+4
-4
@@ -8,8 +8,8 @@ git-stash - Stash the changes in a dirty working directory away
8
SYNOPSIS
9
--------
10
[verse]
11
-'git stash' list [<options>]
12
-'git stash' show [<options>] [<stash>]
11
+'git stash' list [<log-options>]
12
+'git stash' show [<diff-options>] [<stash>]
13
'git stash' drop [-q|--quiet] [<stash>]
14
'git stash' ( pop | apply ) [--index] [-q|--quiet] [<stash>]
15
'git stash' branch <branchname> [<stash>]
@@ -67,7 +67,7 @@ save [-p|--patch] [-k|--[no-]keep-index] [-u|--include-untracked] [-a|--all] [-q
67
Instead, all non-option arguments are concatenated to form the stash
68
message.
69
70
-list [<options>]::
70
+list [<log-options>]::
71
72
List the stash entries that you currently have. Each 'stash entry' is
73
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
83
The command takes options applicable to the 'git log'
84
command to control what is shown and how. See linkgit:git-log[1].
85
86
-show [<options>] [<stash>]::
86
+show [<diff-options>] [<stash>]::
87
88
Show the changes recorded in the stash entry as a diff between the
89
stashed contents and the commit back when the stash entry was first