如何編寫gitignore文件

爲何要有.gitignore文件

項目中常常會生成一些Git系統不須要追蹤(track)的文件。典型的是在編譯生成過程當中 產生的文件或是編程器生成的臨時備份文件。固然，你不追蹤(track)這些文件，能夠 平時不用"git add"去把它們加到索引中。 可是這樣會很快變成一件煩人的事，你發現項目中處處有未追蹤(untracked)的文件; 這樣也使"git add ." 和"git commit -a" 變得實際上沒有用處，同時"git status"命令的輸出也會有它們。你能夠在你的頂層工做目錄中添加一個叫".gitignore"的文件，來告訴Git系統要忽略 掉哪些文件。

忽略文件原則

1. 忽略操做系統自動生成的文件，好比縮略圖等；
2. 忽略編譯生成的中間文件、可執行文件等，也就是若是一個文件是經過另外一個文件自動生成的，那自動生成的文件就不必放進版本庫，好比Java編譯產生的.class文件；
3. 忽略你本身的帶有敏感信息的配置文件，好比存放口令的配置文件。

語法規範（熟悉正則很容易理解）

• 空行或是以#開頭的行即註釋行將被忽略；
• 以斜槓 「/」 結尾表示目錄；
• 以星號 「*」 通配多個字符；
• 以問號 「?」 通配單個字符
• 以方括號 「[]」 包含單個字符的匹配列表；
• 以歎號 「!」 表示不忽略(跟蹤)匹配到的文件或目錄；
• 能夠在前面添加斜槓 「/」 來避免遞歸,下面的例子中能夠很明白的看出來與下一條的區別。

配置文件示例

# 忽略 .a 文件
*.a

# 但否認忽略 lib.a, 儘管已經在前面忽略了 .a 文件
!lib.a

# 僅在當前目錄下忽略 TODO 文件， 但不包括子目錄下的 subdir/TODO
/TODO

# 忽略 build/ 文件夾下的全部文件
build/

# 忽略 doc/notes.txt, 不包括 doc/server/arch.txt
doc/*.txt

# 忽略全部的 .pdf 文件 在 doc/ directory 下的
doc/**/*.pdf

配置文件模板

Github 上爲開發者提供了各類環境以及各類編程語言的 gitignore 文件配置模板：https://github.com/github/gitignore

本人使用的是python項目的gitgnore文件 url:https://github.com/github/gitignore/blob/master/Python.gitignore

.gitignore分爲全局配置和局部配置，這個很容易理解全局配置是指修改當前.gitignore文件本機的git中的所有項目都起做用，局部的配置是指每一個項目下的.gitignore文件只對向前所在的項目起做用。

局部的配置只須要在項目目錄中建立 .gitignore 文件便可。

全局的配置設置方法爲：

$git config –global core.excludesfile ~/.gitignore

這樣，修改  這個文件將做用於全部 git 項目，而且做用於項目實例中的全部被跟蹤的目錄。
# Windows: (使用windows用戶，過濾存放圖片文件夾下生成的縮略圖) Thumbs.db ehthumbs.db Desktop.ini # Python: *.py[cod] *.so *.egg *.egg-info dist build target .idea .classpath .project .settings *.iml .gitignore

~/.gitignore

總結

1. 忽略某些文件時，須要編寫.gitignore。
2. .gitignore文件自己要放到版本庫裏，而且能夠對.gitignore作版本管理！
3. 從版本庫中刪除

   $ git rm test.txt
   rm 'test.txt'
   $ git commit -m "remove test.txt"

參考連接：http://www.chengxusheji.com/archives/121.html

              http://kuanghy.github.io/2016/05/17/gitignore

              http://outofmemory.cn/code-snippet/37452/git-ignorefiles-example