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 <artagnon@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Ramkumar Ramachandra committed
Jun 15, 2013 at 18:43 UTC
2be43516dd23fde3c0096429b9711638a33581dc
1 file changed
+3
-1
Documentation/git-stash.txt
+3
-1
@@ -16,7 +16,7 @@ SYNOPSIS
16
'git stash' [save [--patch] [-k|--[no-]keep-index] [-q|--quiet]
17
[-u|--include-untracked] [-a|--all] [<message>]]
18
'git stash' clear
19
-'git stash' create
19
+'git stash' create [<message>]
20
21
DESCRIPTION
22
-----------
@@ -151,6 +151,8 @@ create::
151
152
Create a stash (which is a regular commit object) and return its
153
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.
156
157
158
DISCUSSION