Git .gitignore 設定 與 注意事項 - 以 Zim 操作為範例

Git 設定 .gitignore, 設定完成就都直接生效, 在測試時都很正常, 但是實際使用 卻沒有生效, 有點軌異.

環境

• Git 所管理的專案名稱、位置: /home/user/doc

下述範例是以 Zim 為主, Zim 是一套桌面的 Wiki 編輯器, 裡面寫的內容都會存成 txt 檔, .zim 的目錄下會存 "*.cache" 和 "zim 本身自己的設定值".

Zim 在剛開始建立完成後, 就使用下述步驟:

1. cd /home/user/doc
2. git init
3. git commit -a
4. git push #一開始沒有設定 .gitignore, 所以會將 .zim/* 都 commit 進去

於每次開啟 Zim 後, 都會出現

modified:   .zim/history.cache
modified:   .zim/index.cache

造成 git commit -a 的麻煩 (因為多台電腦要同步時, index.cache / history.cache 都會出現需要 merge 的狀況), 所以想設定 .gitignore 來把它拿掉. (方便 git commit -a)

設定 .gitignore 位置、方法

設定 Git ignore 的方式都一樣, 有下面幾個地方可以設定, 依自己喜好 / 需求來設定即可.(設定位置)

• vim ~/.gitignore # 對所有 Git 的專案生效 (自己的 home 目錄下)
• vim doc/.gitignore # doc 是專案名稱, 用這個的好處是, 將 .gitignore commit 進去, 此 .gitignore 可以隨著專案到處走. (Git 管理的 Project 目錄下)
• vim doc/.git/info/exclude # 只有單獨於此處 .git 生效 (Project 的 .git/info/exclude 檔案)
• 這幾個地方都可以設定, 可以使用 * 等符號. 詳可見: gitignore(5) Manual Page

於 .zim 的狀況, 可以設定下述: (設定方法)

• 所有 . 開頭的目錄 / 檔案都不 commit
  

  .*

• .zim 目錄內 的 所有 *.cache 都不 commit
  

  .zim/*.cache

• 只有 .zim/history.cache, .zim/index.cache 不 commit
  

  .zim/history.cache
  .zim/index.cache

.gitignore 無法生效 的 問題修復

在測試狀況都是正常, 但是在 Zim 實際使用就有問題, 每次都出現 modified 的解法.

解法

1. 因為第一次 commit 已經將 .zim/*.cache commit 進去了, 所以每次它都會去檢查, 造成都出現 modified 的狀況.
2. git rm -f .zim/history.cache
3. git rm -f .zim/index.cache
4. git commit # 即可
5. 再將 .gitignore 設定好, 就可以避免掉這些狀況囉~ 🙂

範例 -我的 Zim 設定方式

1. cd /home/user/doc
2. vim .gitignore
   

   .zim/*.cache

3. git add .gitignore
4. git commit
5. git push