Re: [PATCH 1/3] Documentation/stash: remove mention of git reset --hard

From: Jakub Narębski <jnareb@gmail.com>
Date: Jan 24, 2017, 19:51 UTC
Message-ID: <c5732a5b-b6a9-2980-3d99-179a93fe6418@gmail.com>
In-Reply-To: <20170121200804.19009-2-t.gummerer@gmail.com>

W dniu 21.01.2017 o 21:08, Thomas Gummerer pisze:

Show 21 quoted lines

> Don't mention git reset --hard in the documentation for git stash save.
> It's an implementation detail that doesn't matter to the end user and
> thus shouldn't be exposed to them.
> 
> Signed-off-by: Thomas Gummerer <t.gummerer@gmail.com>
> ---
>  Documentation/git-stash.txt | 5 +++--
>  1 file changed, 3 insertions(+), 2 deletions(-)
> 
> diff --git a/Documentation/git-stash.txt b/Documentation/git-stash.txt
> index 2e9cef06e6..0ad5335a3e 100644
> --- a/Documentation/git-stash.txt
> +++ b/Documentation/git-stash.txt
> @@ -47,8 +47,9 @@ OPTIONS
>  
>  save [-p|--patch] [-k|--[no-]keep-index] [-u|--include-untracked] [-a|--all] [-q|--quiet] [<message>]::
>  
> -	Save your local modifications to a new 'stash', and run `git reset
> -	--hard` to revert them.  The <message> part is optional and gives
> +	Save your local modifications to a new 'stash', and revert the
> +	the changes in the working tree to match the index.

I think the following might be better:

        ..., and set the working tree to match the index.

Or not, as it ignores problem of untracked files.

Anyway, removing internal implementation detail looks like a good idea. OTOH the reader should be familiar with what `git reset --hard` does, and if not, he knows where to find the information.

Show 5 quoted lines

> +	The <message> part is optional and gives
>  	the description along with the stashed state.  For quickly making
>  	a snapshot, you can omit _both_ "save" and <message>, but giving
>  	only <message> does not trigger this action to prevent a misspelled
>

-- 
Jakub Narębski