Comments in .gitignore?

613

Can you write comments in a .gitignore file?

If so, should the line be preceded with a # or some other indicator?

This question is tagged with git comments gitignore

~ Asked on 2012-01-14 22:25:04

The Best Answer is


761

Yes, you may put comments in there. They however must start at the beginning of a line.

cf. http://git-scm.com/book/en/Git-Basics-Recording-Changes-to-the-Repository#Ignoring-Files

The rules for the patterns you can put in the .gitignore file are as follows:
- Blank lines or lines starting with # are ignored.
[…]

The comment character is #, example:

# no .a files
*.a

~ Answered on 2012-01-14 22:26:55


228

Do git help gitignore

You will get the help page with following line:

A line starting with # serves as a comment.

~ Answered on 2012-01-14 22:32:16


Most Viewed Questions: