From: Zenaan Harkness <zen@freedbms.net>
To: git@vger.kernel.org
Subject: Re: git rm --cached should be git rm --cache or git rm --stage
Date: Sun, 21 Aug 2016 08:25:19 +1000 [thread overview]
Message-ID: <20160820222519.GC5044@x220-a02> (raw)
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
next prev parent reply other threads:[~2016-08-20 22:27 UTC|newest]
Thread overview: 6+ messages / expand[flat|nested] mbox.gz Atom feed top
2016-08-20 7:22 git rm --cached should be git rm --cache or git rm --stage Zenaan Harkness
2016-08-20 7:25 ` Zenaan Harkness
2016-08-20 17:48 ` Junio C Hamano
2016-08-20 19:14 ` Philip Oakley
2016-08-20 22:25 ` Zenaan Harkness [this message]
2016-08-20 23:06 ` Philip Oakley
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: http://vger.kernel.org/majordomo-info.html
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20160820222519.GC5044@x220-a02 \
--to=zen@freedbms.net \
--cc=git@vger.kernel.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public inbox
https://80x24.org/mirrors/git.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).