换行符与Git CRLF

不同的操作系统有不同的换行符格式,跨平台协作时需要考虑版本工具(git)对换行符的处理

回车和换行

回车(Carriage Return)和换行(Line Feed)概念:

  • 回车CR:将光标移动到当前行开头;
  • 换行LF:将光标“垂直”移动到下一行,并不改变光标水平位置。

以上的概念只适用于打字机,现代计算机沿用的时候主要使用的是回到行首换行+回到行首的功能。看下面的例子:

1、在Windows下应用程序输出\n到文件,会被自动转换成\r\n

1
2
3
4
5
6
7
8
9
10
11
12
13
/* 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下应用程序输出\r到文件,不会被转换,并且并不会起到“将光标移动到当前行开头”的作用

1
2
3
4
5
6
7
8
9
10
11
12
/* 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下应用程序输出\r\n到文件,\r\n会被自动转换成\r\r\n

1
2
3
4
5
6
7
8
9
10
11
12
13
/* 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();
}

不同系统下的换行符

CR、LF、CR/LF为不同操作系统上使用的换行符:

  • Windows/DOS系统:采用CR/LF表示下一行;
  • Unix/Linux系统:采用LF表示下一行;
  • Mac OS系统:采用CR表示下一行;
  • Mac OS X系统:采用LF表示下一行(Mac OS X已经改成和Unix/Linx一样使用LF)。

CR使用符号’\r’,十进制ASCII代码是13,十六进制代码为0x0D;LF使用’\n’符号表示,ASCII代码是10,十六制为0x0A。所以Windows平台上换行在文本文件中是使用 0d 0a 两个字节表示,而UNIX和苹果平台上换行则是使用 0a 或 0d 一个字节表示。

Unix/Linux/Mac系统下的文件在Windows里打开的话(使用Windows自带记事本),会出现换行丢失,所有文字会变成一行,整个文本会乱成一团。Windows系统下的文件在Unix/Linux/Mac里打开的话,在每行的结尾可能会多出一个^M符号。

目前大部分的编辑器和IDE都支持这几种换行符(除了notepad),但是跨平台协作项目源码到底保存为哪种风格的换行符呢?输出的文本需要保存为哪种风格的换行符呢?Git提供了一个解决方案——在跨平台协作场景时,会提供一个“换行符自动转换”的功能。

Git CRLF

Git默认在提交时将Windows换行符(CRLF)转换为LF,在拉取时将UNIX换行符(LF)替换成CRLF。我们可以通过设置autocrlf和safecrlf来设置具体的操作。

autocrlf and saftcrlf

1、autocrlf

1
2
3
4
5
6
7
8
// 提交时转换为LF,检出时转换为CRLF
git config --global core.autocrlf true
// 提交时转换为LF,检出时不转换
git config --global core.autocrlf input
// 提交检出均不转换
git config --global core.autocrlf false

2、safecrlf

1
2
3
4
5
6
7
8
// 拒绝提交包含混合换行符的文件
git config --global core.safecrlf true
// 允许提交包含混合换行符的文件
git config --global core.safecrlf false
// 提交包含混合换行符的文件时给出警告
git config --global core.safecrlf warn

.gitattributes

.gitattributes文件能够设置每个仓库的换行符配置,摘取github中的设置为例:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
###############################################################################
# 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认为最好的方式来处理文件,未在.gitattributes中设置的项默认按照这种方式处理;

2、text eol=crlf/lf:在checkout时,转换Line Ending为crlf/lf;

3、binary: 告诉git该文件为二进制,防止git修改该文件。

注意:.gitattributes文件必须要提交之后才能生效。

由于目前Jenkins推送到打包服务器上的代码默认采用LF结尾,所以建议仓库内创建.gitattributes文件并设置。

项目实施一

设置原则

本地仓库完全一致,适合单一平台编程

团队设置

一个团队需要使用同一的换行符标准(UNIX标准或者Windows标准),然后配置自己的代码编辑器和IDE,达到两项要求:

  • 在新建文件时默认使用团队统一的换行符标准;
  • 在打开文件时保持现有换行符格式不变(不要做自动转换)。

Git设置

1、关闭换行符自动转换功能

1
2
// 提交检出均不转换
git config --global core.autocrlf false

2、开启换行符检查功能(按照需求设置)

1
2
3
4
5
6
7
8
// 拒绝提交包含混合换行符的文件
git config --global core.safecrlf true
// 允许提交包含混合换行符的文件
git config --global core.safecrlf false
// 提交包含混合换行符的文件时给出警告
git config --global core.safecrlf warn

留意每次提交

如果提交的时候变更行数过多(超过自己修改),或者增减行数相同,很有可能是整个文件的换行符被修改了,这个时候就要注意检查了。

项目实施二

设置原则

保证仓库永远换行符永远采用UNIX标准(LF),在Windows工作空间设置为Windows标准(CRLF),在Mac/Linux工作空间设置为Unxi标准(LF),适合跨平台编程

团队设置

统一不同平台下的换行符标准,按照上面设置原则的标准,配置自己的代码编辑器和IDE,,达到两项要求:

  • 在新建文件时默认使用团队统一的换行符标准;
  • 在打开文件时保持现有换行符格式不变(不要做自动转换)。

Git设置

1、设置换行符自动转换功能

1
2
3
4
5
# 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、设置换行符检查功能

1
2
// 提交包含混合换行符的文件时给出警告
git config --global core.safecrlf warn

留意每次提交

1、留意每次提交的更改行数。

2、留意提交时的换行符警告。


本文作者:ZeroJiu
本文链接: http://www.freehacker.cn/tools/git-autocrlf/
版权声明:本博客所有文章除特别声明外,均采用 CC BY-NC-SA 3.0 CN 许可协议。转载请注明出处!
温馨提示:开启科学上网访问本站,能获得更好的阅读体验,并启用Disqus评论功能和作者交流。