Skip to content

Commit

Permalink
stash doc: add a warning about using create
Browse files Browse the repository at this point in the history
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>
  • Loading branch information
Ramkumar Ramachandra authored and Junio C Hamano committed Jun 17, 2013
1 parent 5879477 commit 2be4351
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion Documentation/git-stash.txt
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ SYNOPSIS
'git stash' [save [--patch] [-k|--[no-]keep-index] [-q|--quiet]
[-u|--include-untracked] [-a|--all] [<message>]]
'git stash' clear
'git stash' create
'git stash' create [<message>]

DESCRIPTION
-----------
Expand Down Expand Up @@ -151,6 +151,8 @@ create::

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


DISCUSSION
Expand Down

0 comments on commit 2be4351

Please sign in to comment.