Commentaires en .gitignore?

564

Pouvez-vous écrire des commentaires dans un .gitignorefichier?

Dans l'affirmative, la ligne doit-elle être précédée d'un #ou d'un autre indicateur?

git comments gitignore

— James Raitsev
source

Si vous utilisez un éditeur qui connaît ces choses (par exemple Vim), les lignes commentées #seront formatées de manière appropriée - facile à découvrir de cette façon!

— Cascabel

Vous cherchez donc un .gitignoreignore?

— daviewales

Réponses:

700

Oui, vous pouvez y mettre des commentaires. Ils doivent cependant commencer au début d'une ligne.

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

Les règles pour les modèles que vous pouvez mettre dans le fichier .gitignore sont les suivantes:
- Les lignes vides ou commençant par # sont ignorées.
[…]

Le caractère de commentaire est #, par exemple:

# no .a files
*.a

— TimWolla
source

Je ne sais pas si c'était vrai quand cela a été répondu, mais la section du livre lié indique qu'en plus de commencer une ligne, des commentaires peuvent également être ajoutés à une ligne dans le fichier .gitignore.

— Stuart R. Jefferys

@ StuartR.Jefferys Je suis sur git 1.7.4.1 et je trouve qu'une ligne avec un commentaire à la fin ne fonctionne pas: src/main/log/ # Doesn't work. git status still shows this directory src/main/log/fonctionne très bien. git status n'affiche pas le répertoire. En fait, il semble que tout espace à la fin de la ligne soit considéré comme faisant partie du motif ignoré.

— Johann

@Johann Vous avez raison! La fin des espaces blancs est importante, même avec les répertoires (se terminant par /). Si un fichier a un espace de fin, l' .gitignoreentrée doit correspondre; 0 ou 2 espaces et il échoue. Je considère que c'est un bug. J'utilise la version 1.7.5.4 de git. Cela pourrait être intentionnel, même s'il ne devrait probablement pas l'être . Mais vous pouvez l'utiliser [ ]comme spécificateur de caractère d'espace. C'est bien mieux que de laisser un espace blanc à la fin; il tient compte de l'espace de fuite intentionnel rare, tout en rendant détectable le cas d'erreur le plus courant (et difficile à voir).

— Stuart R. Jefferys

Merci pour cela; J'avais le plus de mal à essayer de comprendre pourquoi gitignorait mon .gitignore. C'est parce que j'ai mis des commentaires de fin de ligne après quelques entrées. La coloration par défaut de la syntaxe VIM pour les configtypes de fichiers m'a induit en erreur.

— Luke Davis

209

Faire git help gitignore

Vous obtiendrez la page d'aide avec la ligne suivante:

A line starting with # serves as a comment.

— manojlds
source

+1 pour indiquer comment trouver des informations, pas seulement pour donner des informations.

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

@cregox - Also, I like using computers without command lines- git n'est pas le bon endroit pour vous alors, désolé.

— manojlds

@manojlds gitest le bon endroit pour tout le monde, tout comme rsync. ils ont juste besoin de bons gui, comme dropbox. trop triste nous en

— manquons

Je préfère CLI mais certains collègues utilisent gitbox avec un succès variable. Il y a aussi Git Tree, je pense, non? @cregox

— Stephen Tetreault

Vous pouvez également faire git help ignore(qui est pris en charge par git bash-complètement)

— user202729