From: "Zenaan Harkness" <z...@freedbms.net>
On Sat, Aug 20, 2016 at 08:14:25PM +0100, Philip Oakley wrote:
From: "Zenaan Harkness" <z...@freedbms.net>
>
> Please CC me :)


>  or perhaps something like:
>  "does not unstage a file, it actually stages the removal of the
>  file(s) from the repo (assuming it was already committed before) but
>  leaves the file in your working tree (leaving you with an untracked
>  file)"
>

The easiest way is to simply swap around the two sentences so that the
positive action is listed first - this better matches people's typical
cognition. Human Error (by Reason)[1] tells us to Never state warnings and
caveats after the instruction, and preferably be positive.

"--cached:
Working tree files, whether modified or not, will be retained unchanged.
The option will remove paths from the index (only) to unstage them from
future commits."

That's much better. +1. Thanks.


One better maybe to add (at the end): "The paths become untracked."

That way we hit all the key codewords that the user may recognise, or need to see, to understand.

Submittimg a patch is faily easy, especially if you have git send-email set up. "patches to git@vger.kernel.org (read Documentation/SubmittingPatches for instructions on patch submission)." (from the README.md)

https://github.com/git/git/blob/master/Documentation/SubmittingPatches



>
>The git "stage" is a primary concept, and a primary noun (one reason
>many of us have come to appreciate git), and git's cmd line options and
>help docs ought reflect this.
>
>Thanks,
>Zenaan
>--

Philip
[1] https://www.amazon.com/Human-Error-James-Reason/dp/0521314194
--
To unsubscribe from this list: send the line "unsubscribe git" in
the body of a message to majord...@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html


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

Reply via email to