Comentarios en .gitignore?

564

¿Puedes escribir comentarios en un .gitignorearchivo?

Si es así, ¿debería la línea ir precedida de un #indicador u otro?

git comments gitignore

— James Raitsev
fuente

Si utiliza un editor que conoce estas cosas (por ejemplo, Vim), las líneas comentadas #se formatearán de manera adecuada, ¡fácil de descubrir de esa manera!

— Cascabel

Entonces, ¿estás buscando un .gitignoreignore?

— daviewales

Respuestas:

700

Sí, puedes poner comentarios allí. Sin embargo, deben comenzar al principio de una línea.

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

Las reglas para los patrones que puede colocar en el archivo .gitignore son las siguientes:
- Se ignoran las líneas en blanco o las líneas que comienzan con #.
[...]

El carácter del comentario es #, por ejemplo:

# no .a files
*.a

— TimWolla
fuente

No sé si fue cierto cuando se respondió esto, pero la sección del libro vinculado indica que, además de comenzar una línea, los comentarios también se pueden agregar a una línea en el archivo .gitignore.

— Stuart R. Jefferys

@ StuartR.Jefferys Estoy en git 1.7.4.1 y encuentro que una línea con un comentario al final no funciona: src/main/log/ # Doesn't work. git status still shows this directory src/main/log/funciona bien. El estado de git no muestra el directorio. De hecho, parece que cualquier espacio en blanco al final de la línea se considera parte del patrón de ignorar.

— Johann

@Johann ¡Tienes razón! El espacio en blanco al final es significativo, incluso con directorios (que terminan en /). Si un archivo tiene un espacio final, la .gitignoreentrada debe coincidir; 0 o 2 espacios y falla. Lo considero un error. Estoy usando git versión 1.7.5.4. Se podría ser intencional, aunque probablemente no debería . Pero puedes usar[ ] como un especificador de caracteres de espacio. Eso es mucho mejor que permitir espacios en blanco al final; permite el espacio final intencional raro, al tiempo que hace que el caso de error más común (y difícil de ver) sea detectable.

— Stuart R. Jefferys

Gracias por esto; Estaba teniendo más dificultades para entender por qué gitignoraba mi .gitignore. Fue porque puse comentarios de fin de línea después de algunas entradas. El color predeterminado de la sintaxis de VIM para los configtipos de archivo me engañó.

— Luke Davis

209

Hacer git help gitignore

Obtendrá la página de ayuda con la siguiente línea:

A line starting with # serves as a comment.

— manojlds
fuente

+1 para señalar cómo encontrar información, no solo dar información.

— Иван Бишевац

@cregox - Also, I like using computers without command lines- git es un lugar incorrecto para ti, lo siento.

— manojlds

@manojlds gites el lugar adecuado para todos, al igual que rsync. solo necesitan una buena gui, como dropbox. demasiado triste que todavía nos falta uno para git ...

— cregox

Prefiero CLI pero algunos compañeros de trabajo usan gitbox con mayor o menor éxito. También hay Git Tree, creo, ¿verdad? @cregox

— Stephen Tetreault

También podría hacerlo git help ignore(que es compatible con git bash-complete)

— user202729