Komentar di .gitignore?

564

Bisakah Anda menulis komentar dalam .gitignorefile?

Jika demikian, haruskah garis didahului dengan #indikator atau lainnya?

James Raitsev
sumber
4
Jika Anda menggunakan editor yang tahu tentang hal-hal ini (misalnya Vim), kalimat yang dikomentari #akan diformat dengan tepat - mudah menemukan diri Anda seperti itu!
Cascabel
11
Jadi, Anda mencari .gitignoreignore?
daviewales

Jawaban:

700

Ya, Anda dapat memberikan komentar di sana. Namun mereka harus mulai dari awal baris.

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

Aturan untuk pola yang dapat Anda masukkan dalam file .gitignore adalah sebagai berikut:
- Baris kosong atau baris yang dimulai dengan # diabaikan.
[...]

Karakter komentar adalah #, contoh:

# no .a files
*.a
TimWolla
sumber
1
Tidak tahu apakah itu benar ketika ini dijawab, tetapi bagian buku yang ditautkan menunjukkan bahwa selain memulai baris, komentar juga dapat ditambahkan ke baris dalam file .gitignore.
Stuart R. Jefferys
7
@ StuartR.Jefferys Saya ada di git 1.7.4.1 dan saya menemukan bahwa sebuah baris dengan komentar di akhir tidak berfungsi: src/main/log/ # Doesn't work. git status still shows this directory src/main/log/Bekerja dengan baik. Status git tidak menampilkan direktori. Bahkan, tampak bahwa setiap spasi di akhir baris dianggap bagian dari pola abaikan.
Johann
8
@ Johann Kamu benar! Trailing spasi adalah signifikan, bahkan dengan direktori (berakhir di /). Jika file memiliki ruang tambahan, .gitignoreentri harus cocok; 0 atau 2 spasi dan gagal. Saya menganggapnya sebagai bug. Saya menggunakan git versi 1.7.5.4. Itu bisa disengaja, bahkan jika mungkin tidak . Tapi Anda bisa menggunakannya [ ]sebagai specifier karakter spasi. Itu jauh lebih baik daripada membiarkan ruang putih tertinggal; memungkinkan ruang trailing disengaja yang disengaja, sementara membuat kasus kesalahan yang lebih umum (dan sulit dilihat) terdeteksi.
Stuart R. Jefferys
Terima kasih untuk ini; Saya mengalami kesulitan untuk memahami mengapa gitsaya mengabaikannya .gitignore. Itu karena saya memberikan komentar end-of-line setelah beberapa entri. Pewarnaan sintaks VIM default untuk configtipe file menyesatkan saya.
Luke Davis
209

Melakukan git help gitignore

Anda akan mendapatkan halaman bantuan dengan baris berikut:

A line starting with # serves as a comment.
manojlds
sumber
53
+1 untuk menunjukkan cara menemukan informasi, bukan hanya memberikan informasi.
Иван Бишевац
10
@cregox - Also, I like using computers without command lines- git adalah tempat yang salah untukmu, maaf.
manojlds
2
@ manojlds gitadalah tempat yang tepat untuk semua orang, sama seperti rsync. mereka hanya butuh gui yang bagus, seperti dropbox. terlalu sedih kita masih kehilangan satu untuk git ...
cregox
Saya lebih suka CLI tetapi beberapa rekan kerja menggunakan gitbox dengan berbagai keberhasilan. Saya pikir juga ada Git Tree, kan? @cregox
Stephen Tetreault
1
Anda juga dapat melakukannya git help ignore(yang didukung oleh git-bash-completion)
user202729