[PATCH v3 1/5] stash doc: add a warning about using create
- From
Ramkumar Ramachandra <artagnon@gmail.com>
- Date
- Jun 15, 2013, 13:13 UTC
- Message-ID
- <1371302006-29775-2-git-send-email-artagnon@gmail.com>
- In-Reply-To
- <1371302006-29775-1-git-send-email-artagnon@gmail.com>
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> --- Documentation/git-stash.txt | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-)
diff --git a/Documentation/git-stash.txt b/Documentation/git-stash.txt index 711ffe1..cb0c1a6 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
-- 1.8.3.1.441.gd7d6b72.dirty