git.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Ramkumar Ramachandra <artagnon@gmail.com>
To: Git List <git@vger.kernel.org>
Cc: Junio C Hamano <gitster@pobox.com>
Subject: [PATCH 1/5] stash doc: add a warning about using create
Date: Fri, 14 Jun 2013 16:02:00 +0530	[thread overview]
Message-ID: <1371205924-8982-2-git-send-email-artagnon@gmail.com> (raw)
In-Reply-To: <1371205924-8982-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 | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/Documentation/git-stash.txt b/Documentation/git-stash.txt
index 711ffe1..83bb3db 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,7 @@ 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 probably not what you want to use; see "save" above.
 
 
 DISCUSSION
-- 
1.8.3.1.383.g0d5ad6b

  reply	other threads:[~2013-06-14 10:30 UTC|newest]

Thread overview: 13+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2013-06-14 10:31 [PATCH v2 0/5] Write a good 'git stash store' for autostash Ramkumar Ramachandra
2013-06-14 10:32 ` Ramkumar Ramachandra [this message]
2013-06-14 12:27   ` [PATCH 1/5] stash doc: add a warning about using create Phil Hord
2013-06-14 15:11     ` Junio C Hamano
2013-06-14 10:32 ` [PATCH 2/5] stash doc: document short form -p in synopsis Ramkumar Ramachandra
2013-06-14 10:32 ` [PATCH 3/5] stash: simplify option parser for create Ramkumar Ramachandra
2013-06-14 10:32 ` [PATCH 4/5] stash: introduce 'git stash store' Ramkumar Ramachandra
2013-06-14 12:39   ` Phil Hord
2013-06-14 10:32 ` [PATCH 5/5] rebase: use 'git stash store' to simplify logic Ramkumar Ramachandra
2013-06-14 12:47   ` Phil Hord
2013-06-14 13:40     ` Ramkumar Ramachandra
2013-06-14 14:26 ` [PATCH v2 0/5] Write a good 'git stash store' for autostash Junio C Hamano
2013-06-14 15:16   ` Ramkumar Ramachandra

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=1371205924-8982-2-git-send-email-artagnon@gmail.com \
    --to=artagnon@gmail.com \
    --cc=git@vger.kernel.org \
    --cc=gitster@pobox.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body. 
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).