Commit a5ab00c5 authored by Stephan Beyer's avatar Stephan Beyer Committed by Junio C Hamano

git-stash: improve synopsis in help and manual page

"git stash -h" showed some incomplete and ugly usage information.
For example, the useful "--keep-index" option for "save" or the "--index"
option for  "apply" were not shown. Also in the documentation synopsis they
were not shown, so that there is no incentive to scroll down and even see
that such options exist.

This patch improves the git-stash synopsis in the documentation by
mentioning that further options to the stash commands and then copies
this synopsis to the usage information string of git-stash.sh.

For the latter, the dashless git command string has to be inserted on the
second and the following usage lines. The code of this is taken from
git-sh-setup so that all lines will show the command string.

Note that the "create" command is not advertised at all now, because
it was not mentioned in git-stash.txt.
Signed-off-by: default avatarStephan Beyer <[email protected]>
Signed-off-by: default avatarJunio C Hamano <[email protected]>
parent 0d768f7c
......@@ -8,11 +8,13 @@ git-stash - Stash the changes in a dirty working directory away
SYNOPSIS
--------
[verse]
'git stash' list
'git stash' (show | apply | drop | pop ) [<stash>]
'git stash' list [<options>]
'git stash' (show | drop | pop ) [<stash>]
'git stash' apply [--index] [<stash>]
'git stash' branch <branchname> [<stash>]
'git stash' [save [<message>]]
'git stash' [save [--keep-index] [<message>]]
'git stash' clear
'git stash' create
DESCRIPTION
-----------
......@@ -116,6 +118,11 @@ pop [<stash>]::
of the current working tree state. When no `<stash>` is given,
`[email protected]\{0}` is assumed. See also `apply`.
create::
Create a stash (which is a regular commit object) and return its
object name, without storing it anywhere in the ref namespace.
DISCUSSION
----------
......
#!/bin/sh
# Copyright (c) 2007, Nanako Shiraishi
USAGE='[ | save | list | show | apply | clear | drop | pop | create | branch ]'
dashless=$(basename "$0" | sed -e 's/-/ /')
USAGE="list [<options>]
or: $dashless (show | drop | pop ) [<stash>]
or: $dashless apply [--index] [<stash>]
or: $dashless branch <branchname> [<stash>]
or: $dashless [save [--keep-index] [<message>]]
or: $dashless clear"
SUBDIRECTORY_OK=Yes
OPTIONS_SPEC=
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment