Git 多平台换行符问题(LF or CRLF)

目前,在开发中,使用 Git 作为版本管理工具还是比较流行的,大量的开源项目都在往 Github 迁移。Windows 上有 Git bash 客户端,基于 MinGW,有很多 GNU 工具可用,体验还不错。
在做完工作后,我尝试 git add .,想着这块工作可以告一段落了,而事实是:
$ git add .
fatal: CRLF would be replaced by LF ...

一脸懵逼,Google 一下吧,看看是什么原因。发现,这已经是一个非常经典的问题了:
早就听说过这个问题,总算是亲自踩到这个坑里了。
文本文件所使用的换行符,在不同的系统平台上是不一样的。UNIX/Linux 使用的是 0x0A(LF),早期的 Mac OS 使用的是 0x0D(CR),后来的 OS X 在更换内核后与 UNIX 保持一致了。但 DOS/Windows 一直使用 0x0D0A(CRLF) 作为换行符。
跨平台协作开发是常有的,不统一的换行符确实对跨平台的文件交换带来了麻烦。最大的问题是,在不同平台上,换行符发生改变时,Git 会认为整个文件被修改,这就造成我们没法 diff,不能正确反映本次的修改。还好 Git 在设计时就考虑了这一点,其提供了一个 autocrlf 的配置项,用于在提交和检出时自动转换换行符,该配置有三个可选项:
true: 提交时转换为 LF,检出时转换为 CRLF
false: 提交检出均不转换
input: 提交时转换为LF,检出时不转换
用如下命令即可完成配置:
#提交时转换为LF,检出时转换为CRLF
git config --global core.autocrlf true

#提交时转换为LF,检出时不转换
git config --global core.autocrlf input

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

在 Windows 上,系统默认配置一般为 true。如果文件编码是 UTF8 并且包含中文字符,那最好还是把 autocrlf 设置为 false。否则,就会遇到我所遇到的问题,Git 尝试将 CRLF 转化为 LF 时失败,导致无法 add 。
如果把 autocrlf 设置为 false 时,那另一个配置项 safecrlf 最好设置为 ture。该选项用于检查文件是否包含混合换行符,其有三个可选项:
true: 拒绝提交包含混合换行符的文件
false: 允许提交包含混合换行符的文件
warn: 提交包含混合换行符的文件时给出警告
配置方法:
#拒绝提交包含混合换行符的文件
git config --global core.safecrlf true
#允许提交包含混合换行符的文件
git config --global core.safecrlf false
#提交包含混合换行符的文件时给出警告
git config --global core.safecrlf warn

到此,还并未解决我遇到的问题。实际上,我们有两种办法解决。
一种是将配置项改为如下的形式:
$ git config --global core.autocrlf false
$ git config --global core.safecrlf false

这种方式是不推荐的,虽然代码能被提交,但是项目中的文件可能会包含两种格式的换行符。而且会有如上提到的问题,文件被视为整个被修改,无法 diff,之所以使用版本控制工具,最重要的原因之一就是其 diff 功能。

另一种办法是,手动将文件的换行符转化为 LF,这可以通过编辑器来完成,大部分编辑器都可以将文件的换行符风格设置为 unix 的形式。也可以使用 dos2unix 转换工具来完成,Windows 上 Git bash 客户端自带了该工具。其他系统上也可以安装该工具,例如 Ubuntu 上安装:
sudo apt-get install dos2unix
有了该工具,可以批量的把项目中的文件都转化一遍:
find . -type f xargs dos2unix
或者
find . -type f -exec dos2unix {} +
到此,问题解决。go home!
参考文档:http://kuanghy.github.io/2017/03/19/git-lf-or-crlf

发表评论

电子邮件地址不会被公开。 必填项已用*标注

此站点使用Akismet来减少垃圾评论。了解我们如何处理您的评论数据