Re: [PATCH 1/5] stash doc: add a warning about using create

From: Phil Hord <phil.hord@gmail.com>
Date: Jun 14, 2013, 12:27 UTC
Message-ID: <CABURp0rF2ESFmvf=UQcbKr6ybc0wmGY-_=Nc3yMQJ2jhZGUQJQ@mail.gmail.com>
In-Reply-To: <1371205924-8982-2-git-send-email-artagnon@gmail.com>

On Fri, Jun 14, 2013 at 6:32 AM, Ramkumar Ramachandra <artagnon@gmail.com> wrote:

Show 27 quoted lines

> 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.

Thanks, this is helpful.

Maybe you can also hint why this command exists.

  +       This is intended to be useful for scripts.  It is probably not the
  +       command you want to use; see "save" above.

Show 10 quoted lines

>
>
>  DISCUSSION
> --
> 1.8.3.1.383.g0d5ad6b
>
> --
> To unsubscribe from this list: send the line "unsubscribe git" in
> the body of a message to majordomo@vger.kernel.org
> More majordomo info at  http://vger.kernel.org/majordomo-info.html