From: Zenaan Harkness <zen@freedbms.net>
Date: Sat, 20 Aug 2016 22:25:19 GMT
Subject: Re: git rm --cached should be git rm --cache or git rm --stage
Message-ID: <20160820222519.GC5044@x220-a02>
In-Reply-To: <91F685E894D94BB89892C695B8C1796E@PhilipOakley>

On Sat, Aug 20, 2016 at 08:14:25PM +0100, Philip Oakley wrote:
> From: "Zenaan Harkness" <zen@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.


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