idea中使用git add出现“warning: LF will be replaced by CRLF”

问题复现:

  • 操作系统:win10;开发工具:idea2018.3
  • 在idea中,打开terminal,使用git add指令将一个.xml文件从工作区加入暂存区时,出现警告


    批注 2020-02-27 114342.png

问题分析

  • 对该警告信息进行搜索,发现这是一个关于不同平台下换行符的存储形式不同的问题。

  • 首先要知道什么是CR什么是LF,CR(carriage-return character)指的是回车符,而LF(linefeed character)指的是换行符。Windows系统中,默认使用CR+LF存储文件中的换行,而在Linux系统中,默认使用LF保存文件中的换行,老式mac系统中使用CR保存文件中的换行。这就会导致,windows中打开linux中编写的文件时,可能会发现全文没有换行整个是一行,而在Linux中打开Windows中编写的文件时,可能会发现每一行末尾多一个符号。

  • 在git版本库中默认使用LF保存换行信息,而在idea工作区中,文件换行信息以何种形式保存,默认取决于idea所处的操作系统类型的,如下图所示


    批注 2020-02-27 114342.png
  • 其次还要知道core.autocrlf/core.safecrlf/core.eol的有关概念,可参考https://xiaozhuanlan.com/topic/4053786912中的介绍

  • core.autocrlf有三种可取的值:

    1. $ git config --global core.autocrlf true:在windows系统中,应该把这个值设置为true,这样在checkout代码的时候(从版本库到工作区),LF会被转换成CRLF,这样版本库中以LF表示的换行才能在Windows中正常显式。总结一下,这种设置比较适合windows平台下的Git。
    2. $ git config --global core.autocrlf input:在Linux平台下,checkout(从版本库到工作区)时也就不需要进行转换了(因为git默认使用LF换行)。但是如果Linux平台下,引入了一个CRLF换行的文件,那就应该将此处置为input,这样Git在提交时会将CRLF转换为LF,checkout时就不再将LF转换为CRLF(这样一转换在Linux平台上反而无法识别换行)。总结一下,这种设置比较适合linux平台下的Git。
    3. $ git config --global core.autocrlf false:如果十分确定自己在当前Windows平台编写的文件不会在其他平台被打开,可以将此处置为false,将CRLF保留在版本库中。
  • core.eol也有三种可能的取值

    1. lf:lf换行
    2. crlf:crlf换行
    3. 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版本库保持一致,无需使用任何转换。
    git config --global core.safecrlf false
    
    但是,这种方法不够安全,稍不注意,从windows系统向工作区导入CRLF换行的文件,就容易引起换行符混乱。并且还有可能影响diff指令的使用。
  • 使用.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操作
    
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 212,332评论 6 493
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 90,508评论 3 385
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 157,812评论 0 348
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 56,607评论 1 284
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 65,728评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,919评论 1 290
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,071评论 3 410
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,802评论 0 268
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,256评论 1 303
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,576评论 2 327
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,712评论 1 341
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,389评论 4 332
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,032评论 3 316
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,798评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,026评论 1 266
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,473评论 2 360
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,606评论 2 350

推荐阅读更多精彩内容