diff options
| author | Ramkumar Ramachandra <artagnon@gmail.com> | 2013-06-15 18:43:22 +0530 |
|---|---|---|
| committer | Junio C Hamano <gitster@pobox.com> | 2013-06-17 09:21:52 -0700 |
| commit | 2be43516dd23fde3c0096429b9711638a33581dc (patch) | |
| tree | 16cfe0c3f8f37015ceb28ddef1d6c637119d7e37 /Documentation/git-stash.txt | |
| parent | 587947750bd73544a6a99811f0ddfd64e1ff1445 (diff) | |
| download | git-2be43516dd23fde3c0096429b9711638a33581dc.tar.gz | |
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>
Diffstat (limited to 'Documentation/git-stash.txt')
| -rw-r--r-- | Documentation/git-stash.txt | 4 |
1 files changed, 3 insertions, 1 deletions
diff --git a/Documentation/git-stash.txt b/Documentation/git-stash.txt index 711ffe17a7..cb0c1a6194 100644 --- a/Documentation/git-stash.txt +++ b/Documentation/git-stash.txt @@ -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 ----------- @@ -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 |