threads / discuss / 16987

unclear description of git-rm on kernel.org

Subject: unclear description of git-rm on kernel.org

## tl;dr

2 messages between Jan 4, 2009 and Jan 4, 2009.

replies: 1people: 2as markdown or json

alec resnick· Jan 4, 2009, 22:10 UTC · lore
Hi!

I was trying to remove a number of files from a git repo I had. I read http://kernel.org/pub/software/scm/git/docs/v1.4.4.4/git-rm.html which I interpreted to mean that git-rm removed only from the index, and not from the working tree. In retrospect, the short description is clear: "git-rm - Remove files from the working tree and from the index," but I was confused by the language: "<file>…

    Files to remove from the index and optionally, from the working
tree as well.
-f
    Remove files from the working tree as well as from the index."

Because of "optionally" and the very existence of the "-f" option suggests that you have to do something extra to ask git-rm to mess with the working tree.

The manpage is much clearer, and while I recovered the files I accidentally removed simply with git checkout, I suggest that the webpage be made a bit clearer. In particular, adding info about how to _only_ remove files from the index would be helpful.

I'd be happy to make the changes to the webpage; I don't know how to do that or if it's appropriate.

Thanks!
-a.
Miklos Vajna· Jan 4, 2009, 22:35 UTC · re: alec resnick · lore

Re: unclear description of git-rm on kernel.org

On Sun, Jan 04, 2009 at 05:10:11PM -0500, alec resnick <alec@sproutward.org> wrote:
> I was trying to remove a number of files from a git repo I had.  I
> read http://kernel.org/pub/software/scm/git/docs/v1.4.4.4/git-rm.html
Ugh, why are you reading that ancient version?
I would try:
http://www.kernel.org/pub/software/scm/git/docs/git-rm.html
> I'd be happy to make the changes to the webpage; I don't know how to
> do that or if it's appropriate.

They are generated from asciidoc files from the Documentation/ dir, but documentation fixes are welcome against 1.6.1.x or master only, I'm afraid.

← back to recent threads