Re: [PATCH] Document escaping of special characters in gitignore files

From: Bruce Korb <bruce.korb@gmail.com>
Date: Jan 5, 2011, 20:12 UTC
Message-ID: <4D24D0CB.3030004@gmail.com>
In-Reply-To: <201101052027.24640.jnareb@gmail.com>

On 01/05/11 11:27, Jakub Narebski wrote:

Show 14 quoted lines

>>> +++ b/templates/info--exclude
>>> @@ -4,3 +4,4 @@
>>>  # exclude patterns (uncomment them if you want to use them):
>>>  # *.[oa]
>>>  # *~
>>> +# \#*#
>>
>> Do we need this?  Without explanation it is somewhat hard to realize that
>> this last line is also an example of a pattern that excludes any filename
>> that begins and ends with a pound.
> 
> Well, perhaps not.  Note though that this exclude pattern is actually
> useful for me, as GNU Emacs uses this convention ("#<filename>#") for
> auto-save files.

As the source of this thread, I, too, use emacs and it is exactly the problem of trying to figure out how to get git to ignore these auto save files that got me down this path. It was too hard to figure out. So I suggested some doc changes and the addition of the "exclude emacs auto save files" pattern to the sample text. People who do not use emacs would not understand the \#*# line and folks who do would. They see files like that all the time. For the sake of vi users, you might want to explain them, but I don't think it is crucial. It *is* important to have an example of a needs-to-be-escaped file name.