问题复现:
- 操作系统:win10;开发工具:idea2018.3
-
在idea中,打开terminal,使用git add指令将一个.xml文件从工作区加入暂存区时,出现警告
问题分析
对该警告信息进行搜索,发现这是一个关于不同平台下换行符的存储形式不同的问题。
首先要知道什么是CR什么是LF,CR(carriage-return character)指的是回车符,而LF(linefeed character)指的是换行符。Windows系统中,默认使用CR+LF存储文件中的换行,而在Linux系统中,默认使用LF保存文件中的换行,老式mac系统中使用CR保存文件中的换行。这就会导致,windows中打开linux中编写的文件时,可能会发现全文没有换行整个是一行,而在Linux中打开Windows中编写的文件时,可能会发现每一行末尾多一个符号。
-
在git版本库中默认使用LF保存换行信息,而在idea工作区中,文件换行信息以何种形式保存,默认取决于idea所处的操作系统类型的,如下图所示
其次还要知道core.autocrlf/core.safecrlf/core.eol的有关概念,可参考https://xiaozhuanlan.com/topic/4053786912中的介绍
-
core.autocrlf有三种可取的值:
-
$ git config --global core.autocrlf true
:在windows系统中,应该把这个值设置为true,这样在checkout代码的时候(从版本库到工作区),LF会被转换成CRLF,这样版本库中以LF表示的换行才能在Windows中正常显式。总结一下,这种设置比较适合windows平台下的Git。 -
$ git config --global core.autocrlf input
:在Linux平台下,checkout(从版本库到工作区)时也就不需要进行转换了(因为git默认使用LF换行)。但是如果Linux平台下,引入了一个CRLF换行的文件,那就应该将此处置为input,这样Git在提交时会将CRLF转换为LF,checkout时就不再将LF转换为CRLF(这样一转换在Linux平台上反而无法识别换行)。总结一下,这种设置比较适合linux平台下的Git。 -
$ git config --global core.autocrlf false
:如果十分确定自己在当前Windows平台编写的文件不会在其他平台被打开,可以将此处置为false,将CRLF保留在版本库中。
-
-
core.eol也有三种可能的取值
- lf:lf换行
- crlf:crlf换行
- native:这个值默认为native,native表示跟随操作系统默认配置
当core.autocrlf为true或者input时,算是激活了eol,此时若core.safecrlf为true,Git会检查crlf转换是否正常,对于Windows平台,将core.autocrlf设置为true,则Git会认为工作区的文件都应该是以CRLF换行的,那git add一个LF换行的文件,就会报出本文开头提示的warning。
但是如果按照这个逻辑的话,在我的windows环境下,idea中的这个xml文件的换行信息与windwos系统保持一致,git add操作不应该引起这样的warning。故又查询了xml语法规范,xml文件以LF保存换行!
问题成因
- xml文件使用LF保存换行
- 在windows环境中,core.autocrlf设置为了true,core.safecrlf也为true,这会让Git认为工作区文件都应该使用CRLF换行。
- 那么在Windows中git add一个LF换行的文件的话,Git认为出现了换行符号混用的问题,就会报出这样的警告,提示使用者LF会被转换为CRLF,但是仔细观察上图警告信息可以发现,Git所修改的只是暂存区xml文件的换行符号,工作区的文件换行符号不做任何改动。
问题解决
- 关闭自动转换,在上述图片中的设置界面,修改idea设置,将工作区全部文件以LF换行,这样可以与Git版本库保持一致,无需使用任何转换。
但是,这种方法不够安全,稍不注意,从windows系统向工作区导入CRLF换行的文件,就容易引起换行符混乱。并且还有可能影响diff指令的使用。git config --global core.safecrlf false
- 使用.gitattributes文件来明确工作区中不同类型文件的转换配置,
git config --global core.safecrlf true #windows平台下 git config --global core.autocrlf true #Linux平台下 git config --global core.autocrlf input #在.gitaatributes文件中 *.sh text eol=lf # 控制行尾规范性,入库时将行尾规范为LF,出库时禁止转换为CRLF *.py eol=lf #入库时将行尾规范为LF,出库时禁止转换为CRLF *.xml eol=lf merge=text # 入库时将行尾规范为LF,出库时禁止转换为CRLF,当作text文件进行merge操作