Skip to content

Commit 2be4351

Browse files
artagnongitster
authored andcommitted
stash doc: add a warning about using create
Add a note saying that the user probably wants "save" in the create description. While at it, document that it can optionally take a message in the synopsis. Signed-off-by: Ramkumar Ramachandra <[email protected]> Signed-off-by: Junio C Hamano <[email protected]>
1 parent 5879477 commit 2be4351

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

Documentation/git-stash.txt

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ SYNOPSIS
1616
'git stash' [save [--patch] [-k|--[no-]keep-index] [-q|--quiet]
1717
[-u|--include-untracked] [-a|--all] [<message>]]
1818
'git stash' clear
19-
'git stash' create
19+
'git stash' create [<message>]
2020

2121
DESCRIPTION
2222
-----------
@@ -151,6 +151,8 @@ create::
151151

152152
Create a stash (which is a regular commit object) and return its
153153
object name, without storing it anywhere in the ref namespace.
154+
This is intended to be useful for scripts. It is probably not
155+
the command you want to use; see "save" above.
154156

155157

156158
DISCUSSION

0 commit comments

Comments
 (0)