Web lists-archives.com

Re: [PATCH] doc: emphasize stash "--keep-index" stashes staged content




"Robert P. J. Day" <rpjday@xxxxxxxxxxxxxx> writes:

> -If the `--keep-index` option is used, all changes already added to the
> -index are left intact.
> +If the `--keep-index` option is used, all changes already staged in the
> +index are left intact in the index, while still being added to the stash.

I do not think "left intact in the index" is an improvement.  The
primary reason why people use --keep-index is to get a working tree
that has _only_ the changes that are already added to the index and
nothing else, so that the state in the index can be built and/or
tested.  So if you want to add anything to that sentence, it should
stress the fact that changes are left intact "in the working tree".
Adding "in the index" without doing so makes the result even more
confusing, not less, by allowing a mis-read "left intact _only_ in
the index?  so the working tree files are reverted to the HEAD's
version?"

I am still undecided as to the value of saying ", while still being
added...".