undef/git-commit-vandalism
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

git-stash.txt: be explicit about subcommand options

Browse Source 
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>
This commit is contained in:
Denton Liu 2021-02-08 23:28:47 -08:00 committed by Junio C Hamano
parent 1d4f2316c5
commit d6ab8b1929
1 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
Documentation/git-stash.txt
View File

@ -8,8 +8,8 @@ git-stash - Stash the changes in a dirty working directory away
SYNOPSIS SYNOPSIS
-------- --------
[verse] [verse]
'git stash' list [<options>] 'git stash' list [<log-options>]
'git stash' show [<options>] [<stash>] 'git stash' show [<diff-options>] [<stash>]
'git stash' drop [-q|--quiet] [<stash>] 'git stash' drop [-q|--quiet] [<stash>]
'git stash' ( pop | apply ) [--index] [-q|--quiet] [<stash>] 'git stash' ( pop | apply ) [--index] [-q|--quiet] [<stash>]
'git stash' branch <branchname> [<stash>] 'git stash' branch <branchname> [<stash>]
@ -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 Instead, all non-option arguments are concatenated to form the stash
message. message.
list [<options>]:: list [<log-options>]::
List the stash entries that you currently have. Each 'stash entry' is 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 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' The command takes options applicable to the 'git log'
command to control what is shown and how. See linkgit:git-log[1]. 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 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 stashed contents and the commit back when the stash entry was first