不同的操作系統(tǒng)有不同的換行符格式搏讶,跨平臺(tái)協(xié)作時(shí)需要考慮版本工具(git)對(duì)換行符的處理
回車和換行
回車(Carriage Return)和換行(Line Feed)概念:
- 回車CR:將光標(biāo)移動(dòng)到當(dāng)前行開頭;
- 換行LF:將光標(biāo)“垂直”移動(dòng)到下一行,并不改變光標(biāo)水平位置。
以上的概念只適用于打字機(jī),現(xiàn)代計(jì)算機(jī)沿用的時(shí)候主要使用的是回到行首
和換行+回到行首
的功能蛮寂。看下面的例子:
1易茬、在Windows下應(yīng)用程序輸出\n到文件酬蹋,會(huì)被自動(dòng)轉(zhuǎn)換成\r\n
// output:
// first line
// second line
printf("first line\nsecond line");
// test.txt output;
// first line\r\nsecond line
std::fstream fout("test.txt", std::ios::out);
if (fout.is_open())
{
fout.write("first line\nsecond line", sizeof("first line\nsecond line"));
fout.close();
}
2、在windows下應(yīng)用程序輸出\r到文件抽莱,不會(huì)被轉(zhuǎn)換范抓,并且并不會(huì)起到“將光標(biāo)移動(dòng)到當(dāng)前行開頭”的作用
// output:
// second line
printf("first line\rsecond line");
// test.txt output;
// first line\rsecond line
std::fstream fout("test.txt", std::ios::out);
if (fout.is_open())
{
fout.write("first line\rsecond line", sizeof("first line\rsecond line"));
fout.close();
}
3、在Windows下應(yīng)用程序輸出\r\n到文件食铐,\r\n會(huì)被自動(dòng)轉(zhuǎn)換成\r\r\n
// output:
// first line
// second line
printf("first line\r\nsecond line");
// test.txt output;
// first line\r\r\nsecond line
std::fstream fout("test.txt", std::ios::out);
if (fout.is_open())
{
fout.write("first line\r\nsecond line", sizeof("first line\r\nsecond line"));
fout.close();
}
不同系統(tǒng)下的換行符
CR匕垫、LF、CR/LF為不同操作系統(tǒng)上使用的換行符:
- Windows/DOS系統(tǒng):采用CR/LF表示下一行璃岳;
- Unix/Linux系統(tǒng):采用LF表示下一行年缎;
- Mac OS系統(tǒng):采用CR表示下一行悔捶;
- Mac OS X系統(tǒng):采用LF表示下一行(Mac OS X已經(jīng)改成和Unix/Linx一樣使用LF)。
CR使用符號(hào)'\r'单芜,十進(jìn)制ASCII代碼是13蜕该,十六進(jìn)制代碼為0x0D;LF使用'\n'符號(hào)表示洲鸠,ASCII代碼是10堂淡,十六制為0x0A。所以Windows平臺(tái)上換行在文本文件中是使用 0d 0a 兩個(gè)字節(jié)表示扒腕,而UNIX和蘋果平臺(tái)上換行則是使用 0a 或 0d 一個(gè)字節(jié)表示绢淀。
Unix/Linux/Mac系統(tǒng)下的文件在Windows里打開的話(使用Windows自帶記事本),會(huì)出現(xiàn)換行丟失瘾腰,所有文字會(huì)變成一行皆的,整個(gè)文本會(huì)亂成一團(tuán)。Windows系統(tǒng)下的文件在Unix/Linux/Mac里打開的話蹋盆,在每行的結(jié)尾可能會(huì)多出一個(gè)^M符號(hào)解阅。
目前大部分的編輯器和IDE都支持這幾種換行符(除了notepad)友扰,但是跨平臺(tái)協(xié)作項(xiàng)目源碼到底保存為哪種風(fēng)格的換行符呢却音?輸出的文本需要保存為哪種風(fēng)格的換行符呢瓢湃?Git提供了一個(gè)解決方案——在跨平臺(tái)協(xié)作場(chǎng)景時(shí),會(huì)提供一個(gè)“換行符自動(dòng)轉(zhuǎn)換”的功能析藕。
Git CRLF
Git默認(rèn)在提交時(shí)將Windows換行符(CRLF)轉(zhuǎn)換為L(zhǎng)F召廷,在拉取時(shí)將UNIX換行符(LF)替換成CRLF。我們可以通過(guò)設(shè)置autocrlf和safecrlf來(lái)設(shè)置具體的操作账胧。
autocrlf and saftcrlf
1竞慢、autocrlf
// 提交時(shí)轉(zhuǎn)換為L(zhǎng)F,檢出時(shí)轉(zhuǎn)換為CRLF
git config --global core.autocrlf true
// 提交時(shí)轉(zhuǎn)換為L(zhǎng)F找爱,檢出時(shí)不轉(zhuǎn)換
git config --global core.autocrlf input
// 提交檢出均不轉(zhuǎn)換
git config --global core.autocrlf false
2梗顺、safecrlf
// 拒絕提交包含混合換行符的文件
git config --global core.safecrlf true
// 允許提交包含混合換行符的文件
git config --global core.safecrlf false
// 提交包含混合換行符的文件時(shí)給出警告
git config --global core.safecrlf warn
.gitattributes
.gitattributes文件能夠設(shè)置每個(gè)倉(cāng)庫(kù)的換行符配置,摘取Link中的設(shè)置為例:
###############################################################################
# Set default behavior to automatically normalize line endings.
###############################################################################
* text=auto
###############################################################################
# Set the merge driver for project and solution files
#
# Merging from the command prompt will add diff markers to the files if there
# are conflicts (Merging from VS is not affected by the settings below, in VS
# the diff markers are never inserted). Diff markers may cause the following
# file extensions to fail to load in VS. An alternative would be to treat
# these files as binary and thus will always conflict and require user
# intervention with every merge. To do so, just uncomment the entries below
###############################################################################
#*.sln merge=binary
#*.vcxproj merge=binary
###############################################################################
# behavior for image files
#
# image files are treated as binary by default.
###############################################################################
#*.jpg binary
#*.png binary
#*.gif binary
###############################################################################
# diff behavior for common document formats
#
# Convert binary document formats to text before diffing them. This feature
# is only available from the command line. Turn it on by uncommenting the
# entries below.
###############################################################################
#*.doc diff=astextplain
#*.DOC diff=astextplain
#*.docx diff=astextplain
#*.DOCX diff=astextplain
#*.dot diff=astextplain
#*.DOT diff=astextplain
#*.pdf diff=astextplain
#*.PDF diff=astextplain
#*.rtf diff=astextplain
#*.RTF diff=astextplain
1车摄、text=auto:采用git認(rèn)為最好的方式來(lái)處理文件寺谤,未在.gitattributes中設(shè)置的項(xiàng)默認(rèn)按照這種方式處理;
2吮播、text eol=crlf/lf:在checkout時(shí)变屁,轉(zhuǎn)換Line Ending為crlf/lf;
3意狠、binary: 告訴git該文件為二進(jìn)制粟关,防止git修改該文件。
注意:.gitattributes文件必須要提交之后才能生效环戈。
由于目前Jenkins推送到打包服務(wù)器上的代碼默認(rèn)采用LF結(jié)尾闷板,所以建議倉(cāng)庫(kù)內(nèi)創(chuàng)建.gitattributes文件并設(shè)置澎灸。
項(xiàng)目實(shí)施一
設(shè)置原則
本地倉(cāng)庫(kù)完全一致,適合單一平臺(tái)編程遮晚。
團(tuán)隊(duì)設(shè)置
一個(gè)團(tuán)隊(duì)需要使用同一的換行符標(biāo)準(zhǔn)(UNIX標(biāo)準(zhǔn)或者Windows標(biāo)準(zhǔn))性昭,然后配置自己的代碼編輯器和IDE,達(dá)到兩項(xiàng)要求:
- 在新建文件時(shí)默認(rèn)使用團(tuán)隊(duì)統(tǒng)一的換行符標(biāo)準(zhǔn)县遣;
- 在打開文件時(shí)保持現(xiàn)有換行符格式不變(不要做自動(dòng)轉(zhuǎn)換)糜颠。
Git設(shè)置
1、關(guān)閉換行符自動(dòng)轉(zhuǎn)換功能
// 提交檢出均不轉(zhuǎn)換
git config --global core.autocrlf false
2萧求、開啟換行符檢查功能(按照需求設(shè)置)
// 拒絕提交包含混合換行符的文件
git config --global core.safecrlf true
// 允許提交包含混合換行符的文件
git config --global core.safecrlf false
// 提交包含混合換行符的文件時(shí)給出警告
git config --global core.safecrlf warn
留意每次提交
如果提交的時(shí)候變更行數(shù)過(guò)多(超過(guò)自己修改)其兴,或者增減行數(shù)相同,很有可能是整個(gè)文件的換行符被修改了夸政,這個(gè)時(shí)候就要注意檢查了元旬。
項(xiàng)目實(shí)施二
設(shè)置原則
保證倉(cāng)庫(kù)永遠(yuǎn)換行符永遠(yuǎn)采用UNIX標(biāo)準(zhǔn)(LF),在Windows工作空間設(shè)置為Windows標(biāo)準(zhǔn)(CRLF)守问,在Mac/Linux工作空間設(shè)置為Unxi標(biāo)準(zhǔn)(LF)法绵,適合跨平臺(tái)編程。
團(tuán)隊(duì)設(shè)置
統(tǒng)一不同平臺(tái)下的換行符標(biāo)準(zhǔn)酪碘,按照上面設(shè)置原則的標(biāo)準(zhǔn),配置自己的代碼編輯器和IDE盐茎,兴垦,達(dá)到兩項(xiàng)要求:
- 在新建文件時(shí)默認(rèn)使用團(tuán)隊(duì)統(tǒng)一的換行符標(biāo)準(zhǔn);
- 在打開文件時(shí)保持現(xiàn)有換行符格式不變(不要做自動(dòng)轉(zhuǎn)換)字柠。
Git設(shè)置
1探越、設(shè)置換行符自動(dòng)轉(zhuǎn)換功能
# Configure Git on OS X or Linux to properly handle line endings
git config --global core.autocrlf input
# Configure Git on Windows to properly handle line endings
git config --global core.autocrlf true
2、設(shè)置換行符檢查功能
// 提交包含混合換行符的文件時(shí)給出警告
git config --global core.safecrlf warn
留意每次提交
1窑业、留意每次提交的更改行數(shù)钦幔。
2、留意提交時(shí)的換行符警告常柄。