Re: [PATCH] Clarify and fix English in git-rm documentation.

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



> Jon Loeliger <jdl@xxxxxxx> writes:
> 
> > --- a/Documentation/git-rm.txt
> > +++ b/Documentation/git-rm.txt
> > @@ -11,28 +11,34 @@ SYNOPSIS
> >  
> >  DESCRIPTION
> >  -----------
> > +Remove files from the index, or from the working tree and the index.
> > +`git rm` will not remove a file from just your working directory.
> 
> The last sentence made me stop reading and read the paragraph twice and
> half.  Perhaps it would make it easier to read if we make it
> 
> 	(there is no option to remove a file only from work tree and keep
> 	it in the index; use regular "/bin/rm" if you want to do that).
> 
> a parenthesized note as the tail part of the previous sentence?

Yeah, I thought about adding that as well, so let's do it.

> > +The files being removed have to be identical to the tip of the branch,
> > +and no updates to their contents can be staged in the index.
> 
> Perhaps add "This can be overridden with the `-f` option" here?

Good idea.

I'll respin it this evening.

Thanks,
jdl

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

[Index of Archives]     [Linux Kernel Development]     [Gcc Help]     [IETF Annouce]     [DCCP]     [Netdev]     [Networking]     [Security]     [V4L]     [Bugtraq]     [Yosemite]     [MIPS Linux]     [ARM Linux]     [Linux Security]     [Linux RAID]     [Linux SCSI]     [Fedora Users]

  Powered by Linux