Re: [PATCH 2/2] Documentation: point to related commands from gitignore

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

 



Jonathan Nieder <jrnieder@xxxxxxxxx> writes:

> While at it, move a reference to update-index --assume-unchanged from
> the DESCRIPTION to lower down on the page.  This way, the methodical
> reader can benefit from first learning what excludes files do, then
> how they relate to other git facilities.

Looks sensible.

> +To ignore uncommitted changes in a file that is already tracked,
> +use 'git update-index {litdd}assume-unchanged'.
> +
> +To stop tracking a file that is currently tracked, use
> +'git rm --cached'.

I am not very happy with the wording "to do X, use Y" above, though.  For
example, "rm --cached" is a good starting point, but that needs to be
followed by a commit some time in the future to take permanent effect.
The realization that "rm --cached" is a good starting point would come
only with an understanding of what "rm --cached" does (i.e. it removes the
path from the index, preparing for its removal from the future history).

"to do X, see Y" might be a good compromise, because what I am suggesting
by the above is that ideally to say "to do X means doing Z so using Y is a
good way to achieve it", but "... means doing Z" part is explained in the
manual page of Y.

In any case, will queue.  Thanks.
--
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]