Re: [PATCH] gitignore(5): explain how to stop tracking a file

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

 



On Thu, Nov 11, 2010 at 12:25 AM, Jonathan Nieder <jrnieder@xxxxxxxxx> wrote:
> Sitaram Chamarty wrote:
>
>> --- a/Documentation/gitignore.txt
>> +++ b/Documentation/gitignore.txt
>> @@ -18,7 +18,8 @@ Note that all the `gitignore` files really concern only files
>> Âthat are not already tracked by git;
>> Âin order to ignore uncommitted changes in already tracked files,
>> Âplease refer to the 'git update-index --assume-unchanged'
>> -documentation.
>> +documentation. ÂTo stop tracking a file that is currently tracked,
>> +use 'git rm --cached'.
>
> Ack. ÂBut I fear this makes the gitignore page feel even more top-heavy
> than it already is.

Oh... I hadn't thought of that.  I was looking at "what's the minimum
change needed to at least mention 'git rm --cached' somewhere".
You're right though, and I think your approach is good.

> The current structure is:

[snip]

> It's a wonder people can find anything there. :) ÂSo how about this?
>
> Patch 1 splits the description into three sections. ÂYes, having the
> PATTERN FORMAT section is not part of the conventional list in
> man-pages(7), but I think it's easier to find the interesting part
> this way.
>
> Patch 2 puts the comments about related commands in a separate NOTES
> section.
>
> This way, one could expand on the "stop tracking file" procedure
> without interrupting the flow of the basic description of what
> excludes files do, by adding to the NOTES or EXAMPLES section.

++ from me on this approach.

regards

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