Pro Git 7.1 Git 配置

出自DILA Wiki

如第一章所言,用 git config 配置 Git,要做的第一件事就是設置名字和郵箱地址:

$ git config --global user.name "John Doe"
$ git config --global user.email johndoe@example.com

從現在開始,你會瞭解到一些類似以上但更為有趣的設置選項來自訂 Git。

先過一遍第一章中提到的 Git 配置細節。Git 使用一系列的設定檔來儲存你定義的偏好,它首先會查找 /etc/gitconfig 檔,該檔含有:對系統上所有使用者以及他們所擁有的倉庫都生效的配置值(譯注:gitconfig 是全域設定檔), 如果傳遞 --system 選項給 git config 命令, Git 會讀寫這個檔。

接下來 Git 會查找每個用戶的 ~/.gitconfig 檔,你能傳遞 --global 選項讓 Git 讀寫該檔。

最後 Git 會查找由用戶定義的各個庫中 Git 目錄下的設定檔(.git/config),該文件中的值只對該庫有效。以上闡述的三層配置從一般到特殊層層推進,如果定義的值有衝突,以後面層中定義的為准,例如:在 .git/config 和 /etc/gitconfig 的較量中, .git/config 取得了勝利。雖然你也可以直接手動編輯這些設定檔,但是執行 git config 命令將會來得簡單些。

用戶端基本配置

Git 能夠識別的配置項被分為了兩大類:用戶端和伺服器端,其中大部分基於你個人工作偏好,屬於用戶端配置。儘管有數不盡的選項,但我只闡述其中經常使用、或者會對你的工作流產生巨大影響的選項,如果你想觀察你當前的 Git 能識別的選項清單,請執行

$ git config --help

git config 的手冊頁(譯注:以 man 命令的顯示方式)非常細緻地羅列了所有可用的配置項。

core.editor

Git 預設會調用你的環境變數 editor 定義的值作為文字編輯器,如果沒有定義的話,會調用 Vi 來創建和編輯提交以及標籤資訊,你可以使用core.editor 改變預設編輯器:

$ git config --global core.editor emacs

現在無論你的環境變數 editor 被定義成什麼,Git 都會調用 Emacs 編輯資訊。

commit.template

如果把此項指定為你系統上的一個檔,當你提交的時候,Git 會預設使用該檔定義的內容。例如:你創建了一個範本檔 $HOME/.gitmessage.txt,它看起來像這樣:

subject line

what happened

[ticket: X]

設置 commit.template,當執行 git commit 時,Git 會在你的編輯器中顯示以上的內容,設置 commit.template 如下:

$ git config --global commit.template $HOME/.gitmessage.txt
$ git commit

然後當你提交時,在編輯器中顯示的提交資訊如下:

subject line

what happened

[ticket: X]
# Please enter the commit message for your changes. Lines starting
# with '#' will be ignored, and an empty message aborts the commit.
# On branch master
# Changes to be committed:
#   (use "git reset HEAD <file>..." to unstage)
#
# modified:   lib/test.rb
#
~
~
".git/COMMIT_EDITMSG" 14L, 297C

如果你有特定的策略要運用在提交資訊上,在系統上創建一個範本檔,設置 Git 預設使用它,這樣當提交時,你的策略每次都會被運用。

core.pager

core.pager 指定 Git 執行諸如 log、diff 等所使用的分頁器,你能設置成用 more 或者任何你喜歡的分頁器(預設用的是 less), 當然你也可以什麼都不用,設置空字串:

$ git config --global core.pager ''

這樣不管命令的輸出量多少,都會在一頁顯示所有內容。

user.signingkey

如果你要創建經簽署的含附注的標籤(正如第二章所述),那麼把你的 GPG 簽署金鑰設置為配置項會更好,設置金鑰 ID 如下:

$ git config --global user.signingkey <gpg-key-id>

現在你能夠簽署標籤,從而不必每次執行 git tag 命令時定義金鑰:

$ git tag -s <tag-name>

core.excludesfile

正如第二章所述,你能在專案庫的 .gitignore 檔裡頭用模式來定義那些無需納入 Git 管理的檔,這樣它們不會出現在未跟蹤列表,也不會在你執行 git add 後被暫存。然而,如果你想用專案庫之外的檔來定義那些需被忽略的檔的話,用 core.excludesfile 通知 Git 該檔所處的位置,檔內容和 .gitignore 類似。

help.autocorrect

該配置項只在 Git 1.6.1 及以上版本有效,假如你在 Git 1.6 中錯打了一條命令,會顯示:

$ git com
git: 'com' is not a git-command. See 'git --help'.

Did you mean this?
     commit

如果你把 help.autocorrect 設置成1(譯注:啟動自動修正),那麼在只有一個命令被模糊匹配到的情況下,Git 會自動運行該命令。

Git 中的著色

Git 能夠為輸出到你終端的內容著色,以便你可以憑直觀進行快速、簡單地分析,有許多選項能供你使用以符合你的偏好。

color.ui

Git 會按照你的需要,自動為大部分的輸出加上顏色,你能明確地規定哪些需要著色、以及怎樣著色,設置 color.ui 為 true 來打開所有的預設終端著色。

$ git config --global color.ui true

設置好以後,當輸出到終端時,Git 會為之加上顏色。其他的參數還有 false 和 always,false 意味著不為輸出著色,而 always 則表明在任何情況下都要著色,即使 Git 命令被重定向到文件或管道。Git 1.5.5 版本引進了此項配置,如果你擁有的版本更老,你必須對顏色有關選項各自進行詳細地設置。

你會很少用到 color.ui = always,在大多數情況下,如果你想在被重定向的輸出中插入顏色碼,你能傳遞 --color 標誌給 Git 命令來迫使它這麼做,color.ui = true 應該是你的首選。

color.*

想要具體指定哪些命令輸出需要被著色,以及怎樣著色,或者 Git 的版本很老,你就要用到和具體命令有關的顏色配置選項,它們都能被設為 true、false 或 always:

color.branch
color.diff
color.interactive
color.status

除此之外,以上每個選項都有子選項,可以被用來覆蓋其父設置,以達到為輸出的各個部分著色的目的。例如,讓 diff 輸出的改變資訊以粗體、藍色前景和黑色背景的形式顯示:

$ git config --global color.diff.meta “blue black bold”

你能設置的顏色值如:normal、black、red、green、yellow、blue、magenta、cyan、white,正如以上例子設置的粗體屬性,想要設置字體屬性的話,可以選擇如:bold、dim、ul、blink、reverse。

如果你想配置子選項的話,可以參考 git config 幫助頁。

外部的合併與比較工具

雖然 Git 自己實做了 diff,而且到目前為止你一直在使用它,但你能夠用一個外部的工具替代它,除此以外,你還能用一個圖形化的工具來合併和解決衝突從而不必自己手動解決。有一個不錯且免費的工具可以被用來做比較和合併工作,它就是 P4Merge(譯注:Perforce 圖形化合並工具),我會展示它的安裝過程。

P4Merge 可以在所有主流平臺上運行,現在開始大膽嘗試吧。對於向你展示的例子,在 Mac 和 Linux 系統上,我會使用路徑名;在 Windows 上,/usr/local/bin 應該被改為你環境中的可執行路徑。

下載P4Merge:

http://www.perforce.com/perforce/downloads/component.html

首先把你要設定一個外部包裝腳本(external wrapper scripts)來執行你要的命令,我會使用 Mac 系統上的路徑來指定該腳本的位置,在其他系統上,它應該被放置在二進位檔案 p4merge 所在的目錄中。創建一個 merge 包裝腳本,名字叫作 extMerge,讓它帶參數呼叫 p4merge 二進位檔案:

$ cat /usr/local/bin/extMerge
#!/bin/sh
/Applications/p4merge.app/Contents/MacOS/p4merge $*

diff 包裝腳本首先確定傳遞過來7個參數,隨後把其中2個傳遞給 merge 包裝腳本,預設情況下,Git 傳遞以下參數給 diff:

path old-file old-hex old-mode new-file new-hex new-mode

由於你僅僅需要 old-file 和 new-file 參數,用 diff 包裝腳本來傳遞它們吧。

$ cat /usr/local/bin/extDiff 
#!/bin/sh
[ $# -eq 7 ] && /usr/local/bin/extMerge "$2" "$5"

確認這兩個腳本是可執行的:

$ sudo chmod +x /usr/local/bin/extMerge 
$ sudo chmod +x /usr/local/bin/extDiff

現在來配置使用你自訂的比較和合併工具吧。這需要許多自訂設置:merge.tool 通知 Git 使用哪個合併工具;mergetool.*.cmd 規定命令運行的方式;mergetool.trustExitCode 會通知 Git 程式的退出是否指示合併操作成功;diff.external 通知 Git 用什麼命令做比較。因此,你能執行以下4條配置命令:

$ git config --global merge.tool extMerge
$ git config --global mergetool.extMerge.cmd \
    'extMerge "$BASE" "$LOCAL" "$REMOTE" "$MERGED"'
$ git config --global mergetool.trustExitCode false
$ git config --global diff.external extDiff

或者直接編輯 ~/.gitconfig文件如下:

[merge]
  tool = extMerge
[mergetool "extMerge"]
  cmd = extMerge "$BASE" "$LOCAL" "$REMOTE" "$MERGED"
  trustExitCode = false
[diff]
  external = extDiff

設置完畢後,運行 diff 命令:

$ git diff 32d1776b1^ 32d1776b1

不同於在命令列得到 diff 命令的輸出,Git 觸發了剛剛設置的 P4Merge,它看起來像圖7-1這樣:

Pro-git-7-1.png Figure 7-1. P4Merge.

當你設法合併兩個分支,結果卻有衝突時,執行 git mergetool,Git 會啟用 P4Merge 讓你通過圖形介面來解決衝突。

設置包裝腳本的好處是你能簡單地改變 diff 和 merge 工具,例如把 extDiff 和 extMerge 改成 KDiff3,要做的僅僅是編輯 extMerge 指令檔:

$ cat /usr/local/bin/extMerge
#!/bin/sh	
/Applications/kdiff3.app/Contents/MacOS/kdiff3 $*

現在 Git 會使用 KDiff3 來做比較、合併和解決衝突。

Git 預先設置了許多其他的合併和解決衝突的工具,而你不必設置 cmd。可以把合併工具設置為:kdiff3、opendiff、tkdiff、meld、xxdiff、emerge、vimdiff、gvimdiff。如果你不想用到 KDiff3 的所有功能,只是想用它來合併,那麼 kdiff3 正符合你的要求,執行:

$ git config --global merge.tool kdiff3

如果執行了以上命令,沒有設置 extMerge 和 extDiff 檔,Git 會用 KDiff3 做合併,讓平常內建的比較工具來做比較。

格式化與空白

格式化與空白是許多開發人員在協作時,特別是在跨平臺情況下,遇到的令人頭疼的細小問題。由於編輯器的不同,或者 Windows 程式師在跨平臺專案中的檔案行尾加入了回車分行符號(carriage return),一些細微的空格變化會不經意地進入大家合作的工作或提交的補丁中。Git 的一些配置選項可以幫助解決這些問題。

core.autocrlf

假如你正在Windows上寫程式,又或者你正在和其他人合作,他們在 Windows 上程式設計,而你卻在其他系統上,在這些情況下,你可能會遇到行尾結束符問題。這是因為 Windows 使用回車和換行兩個字元來結束一行,而 Mac 和 Linux 只使用換行一個字元。雖然這是小問題,但它會極大地擾亂跨平臺協作。

Git 可以在你提交時自動地把行結束符 CRLF 轉換成 LF,而在簽出代碼時把 LF 轉換成 CRLF。用 core.autocrlf 來打開此項功能,如果是在Windows 系統上,把它設置成 true,這樣當簽出代碼時,LF 會被轉換成 CRLF:

$ git config --global core.autocrlf true

Linux 或 Mac 系統使用 LF 作為行結束符,因此你不想 Git 在簽出檔時進行自動的轉換;當一個以 CRLF 為行結束符的檔不小心被引入時你肯定想進行修正,把 core.autocrlf 設置成 input 來告訴 Git 在提交時把 CRLF 轉換成 LF,簽出時不轉換:

$ git config --global core.autocrlf input

這樣會在 Windows 系統上的簽出檔中保留 CRLF,會在 Mac 和 Linux 系統上,包括倉庫中保留 LF。

如果你是 Windows 程式師,且正在開發僅運行在 Windows 上的專案,可以設置 false 取消此功能,把回車符記錄在庫中:

$ git config --global core.autocrlf false

core.whitespace

Git 預先設置了一些選項來探測和修正空白問題,其4種主要選項中的2個預設被打開,另2個被關閉,你可以自由地打開或關閉它們。

預設被打開的2個選項是 trailing-space 和 space-before-tab,trailing-space 會查找每行結尾的空格,space-before-tab 會查找每行開頭的定位字元前的空格。

預設被關閉的2個選項是 indent-with-non-tab 和 cr-at-eol,indent-with-non-tab 會查找8個以上空格(非定位字元)開頭的行,cr-at-eol讓 Git 知道行尾回車符是合法的。

設置 core.whitespace,按照你的意圖來打開或關閉選項,選項以逗號分割。通過逗號分割的鏈中去掉選項或在選項前加-來關閉,例如,如果你想要打開除了 cr-at-eol 之外的所有選項:

$ git config --global core.whitespace \
    trailing-space,space-before-tab,indent-with-non-tab

當你執行 git diff 命令且為輸出著色時,Git 探測到這些問題,因此你也許在提交前能修復它們,當你用 git apply 打補丁時同樣也會從中受益。如果正準備運用的補丁有特別的空白問題,你可以讓 Git 發警告:

$ git apply --whitespace=warn <patch>

或者讓 Git 在打上補丁前自動修正此問題:

$ git apply --whitespace=fix <patch>

這些選項也能運用於衍合。如果提交了有空白問題的檔但還沒推送到上流,你可以運行帶有 --whitespace=fix 選項的 rebase 來讓 Git 在重寫補丁時自動修正它們。

伺服器端配置

Git 伺服器端的配置選項並不多,但仍有一些饒有生趣的選項值得你一看。

receive.fsckObjects

Git 預設情況下不會在推送期間檢查所有物件的一致性。雖然會確認每個物件的有效性以及是否仍然匹配 SHA-1核對總和,但 Git 不會在每次推送時都檢查一致性。對於 Git 來說,倉庫或推送的檔越大,這個操作代價就相對越高,每次推送會消耗更多時間,如果想在每次推送時 Git 都檢查一致性,設置 receive.fsckObjects 為 true 來強迫它這麼做:

$ git config --system receive.fsckObjects true

現在 Git 會在每次推送生效前檢查庫的完整性,確保有問題的用戶端沒有引入破壞性的資料。

receive.denyNonFastForwards

如果對已經被推送的提交歷史做衍合,繼而再推送,又或者以其它方式推送一個提交歷史至遠端分支,且該提交歷史沒在這個遠端分支中,這樣的推送會被拒絕。這通常是個很好的禁止策略,但有時你在做衍合併確定要更新遠端分支,可以在 push 命令後加 -f 標誌來強制更新。

要禁用這樣的強制更新功能,可以設置 receive.denyNonFastForwards:

$ git config --system receive.denyNonFastForwards true

稍後你會看到,用伺服器端的接收鉤子也能達到同樣的目的。這個方法可以做更細緻的控制,例如:禁用特定的用戶做強制更新。

receive.denyDeletes

規避 denyNonFastForwards 策略的方法之一就是使用者刪除分支,然後推回新的引用。在更新的 Git 版本中(從1.6.1版本開始),把receive.denyDeletes 設置為 true:

$ git config --system receive.denyDeletes true

這樣會在推送過程中阻止刪除分支和標籤 — 沒有使用者能夠這麼做。要刪除遠端分支,必須從伺服器手動刪除引用檔。通過用戶存取控制清單也能這麼做,在本章結尾將會介紹這些有趣的方式。