Skip to content

Commit d6ab8b1

Browse files
Denton-Lgitster
authored andcommitted
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 <[email protected]> Signed-off-by: Junio C Hamano <[email protected]>
1 parent 1d4f231 commit d6ab8b1

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

Documentation/git-stash.txt

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,8 @@ git-stash - Stash the changes in a dirty working directory away
88
SYNOPSIS
99
--------
1010
[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>]
1313
'git stash' drop [-q|--quiet] [<stash>]
1414
'git stash' ( pop | apply ) [--index] [-q|--quiet] [<stash>]
1515
'git stash' branch <branchname> [<stash>]
@@ -67,7 +67,7 @@ save [-p|--patch] [-k|--[no-]keep-index] [-u|--include-untracked] [-a|--all] [-q
6767
Instead, all non-option arguments are concatenated to form the stash
6868
message.
6969

70-
list [<options>]::
70+
list [<log-options>]::
7171

7272
List the stash entries that you currently have. Each 'stash entry' is
7373
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
8383
The command takes options applicable to the 'git log'
8484
command to control what is shown and how. See linkgit:git-log[1].
8585

86-
show [<options>] [<stash>]::
86+
show [<diff-options>] [<stash>]::
8787

8888
Show the changes recorded in the stash entry as a diff between the
8989
stashed contents and the commit back when the stash entry was first

0 commit comments

Comments
 (0)