Komentarze w .gitignore?

564

Czy umiesz pisać komentarze w .gitignorepliku?

Jeśli tak, to czy wiersz powinien być poprzedzony #jakimś innym wskaźnikiem?

James Raitsev
źródło
4
Jeśli korzystasz z edytora, który wie o tych rzeczach (np. Vim), wiersze z komentarzem #zostaną odpowiednio sformatowane - łatwo to odkryć!
Cascabel
11
Więc szukasz .gitignoreignore?
daviewales

Odpowiedzi:

699

Tak, możesz tam dodawać komentarze. Muszą jednak zaczynać na początku linii.

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

Reguły wzorców, które można umieścić w pliku .gitignore, są następujące:
- Puste linie lub linie zaczynające się od # są ignorowane.
[…]

Znak komentarza to #przykład:

# no .a files
*.a
TimWolla
źródło
1
Nie wiem, czy to prawda, kiedy udzielono odpowiedzi, ale połączona sekcja książki wskazuje, że oprócz uruchomienia linii komentarze można również dołączyć do linii w pliku .gitignore.
Stuart R. Jefferys
7
@ StuartR.Jefferys Jestem na git 1.7.4.1 i stwierdzam, że linia z komentarzem na końcu nie działa: src/main/log/ # Doesn't work. git status still shows this directory src/main/log/działa dobrze. Status git nie pokazuje katalogu. W rzeczywistości wydaje się, że każda biała spacja na końcu linii jest uważana za część wzorca ignorowania.
Johann
8
@Johann Masz rację! Końcowe białe znaki znaczące, nawet w przypadku katalogów (kończących się na /). Jeśli plik ma końcowe miejsce, .gitignorewpis musi być zgodny; 0 lub 2 spacje i nie działa. Uważam to za błąd. Używam gita w wersji 1.7.5.4. To może być celowe, nawet jeśli prawdopodobnie nie powinno . Możesz jednak użyć [ ]jako specyfikatora znaku spacji. Jest to o wiele lepsze niż pozwalanie na końcowe białe znaki; pozwala na rzadkie celowe końcowe miejsce, jednocześnie umożliwiając wykrycie bardziej powszechnego (i trudnego do zauważenia) przypadku błędu.
Stuart R. Jefferys,
Dzięki za to; Najtrudniej gitbyło mi zrozumieć, dlaczego ignorowałem moje .gitignore. Stało się tak, ponieważ po niektórych wpisach umieściłem komentarze na końcu wiersza . Wprowadziło configmnie w błąd domyślne kolorowanie składni VIM dla typów plików.
Luke Davis,
208

Zrobić git help gitignore

Otrzymasz stronę pomocy z następującym wierszem:

A line starting with # serves as a comment.
manojlds
źródło
53
+1 za wskazanie, jak znaleźć informacje, a nie tylko podanie informacji.
Иван Бишевац
10
@ cregox - Also, I like using computers without command lines- git jest dla ciebie niewłaściwym miejscem, przepraszam.
manojlds
2
@manojlds gitjest właściwym miejscem dla wszystkich, podobnie jak rsync. potrzebują tylko dobrych gui, takich jak dropbox. szkoda, że ​​wciąż brakuje nam jednego do git ...
cregox
Wolę CLI, ale niektórzy współpracownicy używają gitboxa z różnym powodzeniem. Sądzę, że jest też Git Tree, prawda? @cregox
Stephen Tetreault
1
Możesz także zrobić git help ignore(co jest obsługiwane przez git bash-
complete