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

stash doc: add a warning about using create

Browse Source 
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>
This commit is contained in:
Ramkumar Ramachandra 2013-06-15 18:43:22 +05:30 committed by Junio C Hamano
parent 587947750b
commit 2be43516dd
1 changed files with 3 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
Documentation/git-stash.txt
View File

@ -16,7 +16,7 @@ SYNOPSIS
'git stash' [save [--patch] [-k|--[no-]keep-index] [-q|--quiet] 'git stash' [save [--patch] [-k|--[no-]keep-index] [-q|--quiet]
[-u|--include-untracked] [-a|--all] [<message>]] [-u|--include-untracked] [-a|--all] [<message>]]
'git stash' clear 'git stash' clear
'git stash' create 'git stash' create [<message>]
DESCRIPTION DESCRIPTION
----------- -----------
@ -151,6 +151,8 @@ create::
Create a stash (which is a regular commit object) and return its Create a stash (which is a regular commit object) and return its
object name, without storing it anywhere in the ref namespace. 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 DISCUSSION