Git 处理 CRLF（回车、换行）的策略是什么？

Question

我尝试提交以 CRLF 结尾的行的文件，但失败了。

我花了一整天的时间在我的 Windows 计算机上尝试不同的策略，并且几乎被吸引停止尝试使用 Git，而是尝试 水银。

如何正确处理 CRLF 行结尾？

Answer 1

在问这个问题近四年后，我终于
找到一个完全令我满意的答案！

请参阅 github:help 指南中的详细信息
处理行结尾。

Git 允许您设置行结束属性
直接使用 文本属性 进行存储
.gitattributes 文件。 该文件被提交到
存储库并覆盖 core.autocrlf 设置，
让您确保所有人的行为一致
用户无论其 git 设置如何。

因此

这样做的好处是你的行尾
配置现在与您的存储库一起移动，并且您
无需担心是否有合作者
有正确的全局设置。

这是 .gitattributes 文件的示例

# Auto detect text files and perform LF normalization
*        text=auto

*.cs     text diff=csharp
*.java   text diff=java
*.html   text diff=html
*.css    text
*.js     text
*.sql    text

*.csproj text merge=union
*.sln    text merge=union eol=crlf

*.docx   diff=astextplain
*.DOCX   diff=astextplain

# absolute paths are ok, as are globs
/**/postinst* text eol=lf

# paths that don't start with / are treated relative to the .gitattributes folder
relative/path/*.txt text eol=lf

有一个方便的现成使用的集合。最流行的编程语言的 gitattributes 文件。 这对您入门很有用。

创建或调整 .gitattributes 后，您应该执行一劳永逸的 行尾重新规范化。

请注意，GitHub Desktop 应用程序可以在您选择后建议并创建一个 .gitattributes 文件在应用程序中打开项目的 Git 存储库。 要尝试此操作，请单击齿轮图标（位于右上角）> 存储库设置...>> 行结束符和属性。 系统会要求您添加推荐的 .gitattributes，如果您同意，该应用程序还将对存储库中的所有文件执行规范化。

最后，注意行尾一文
提供更多背景知识并解释 Git 的演变过程
关于手头的事情。 我认为这是必读的内容。

您的团队中可能有用户使用 EGit 或 JGit（Eclipse 和 TeamCity 等工具使用它们）来提交更改。 那么你就不走运了，正如 @gatinueta 在这个答案的评论中解释的那样：

如果您的团队中有人使用 Egit 或 JGit，则此设置不会完全满足您的要求，因为这些工具只会忽略 .gitattributes 并愉快地签入 CRLF 文件 https://bugs.eclipse.org/bugs/show_bug.cgi?id=342372

一个技巧可能是让他们在另一个客户端中提交更改，例如 SourceTree。 对于许多用例，我们的团队当时更喜欢该工具，而不是 Eclipse 的 Egit。

谁说软件很简单？ :-/

Answer 2

不要转换行结尾。 VCS 的工作不是解释数据，而是存储数据并对其进行版本控制。 无论如何，每个现代文本编辑器都可以读取这两种行结尾。

Answer 3

除非您真的知道自己在做什么，否则您几乎总是需要autocrlf=input。

下面是一些附加上下文：

如果您愿意，它应该是 core.autocrlf=true
如果您愿意，DOS 结尾或 core.autocrlf=input
Unix 换行符。 在这两种情况下，您的 Git 存储库都会
只有 LF，这是正确的事情。 唯一的
core.autocrlf=false 的参数是自动的
启发式可能会错误地将某些二进制文件检测为文本
然后你的瓷砖就会被损坏。 所以，
引入了 core.safecrlf 选项来警告用户
发生不可逆转的变化。 事实上，有两个
不可逆转的变化的可能性 -- -- 混合的
文本文件中的行结束符，在此标准化中是
理想的，因此可以忽略此警告，或者
（极不可能）Git 错误地检测到你的
二进制文件作为文本。 然后你需要使用属性
告诉 Git 该文件是二进制文件。

上面的段落最初是从 gmane.org 上的一个帖子中提取的，但后来它已经被删除了。

Answer 4

在混合环境（Microsoft + Linux + Mac）中保持行尾一致的两种替代策略：

A. 全局 所有存储库设置

1. 转换全部为一种格式

   查找 .   -type f -not -path "./.git/*" -exec dos2unix {} \; 
     git commit -a -m 'dos2unix 转换' 
     

2. 在 Linux/UNIX 上将 core.autocrlf 设置为 input 或在 MS Windows（存储库或全局）上设置 true

   git config --global core.autocrlf 输入 
     

3. （可选）将core.safecrlf设置为true（停止）或warn（唱歌：）以添加额外的保护来比较反向换行符转换将产生相同的文件

   git config --global core.safecrlf true 
     

B. 或每个存储库设置

1. 将全部转换为一种格式

   查找 .   -type f -not -path "./.git/*" -exec dos2unix {} \; 
     git commit -a -m 'dos2unix 转换' 
     

2. 将 .gitattributes 文件添加到您的存储库

   echo "* text=auto" >   .gitattributes 
     git 添加 .gitattributes 
     git commit -m '添加 .gitattributes 以实现统一行结束' 
     

不要担心您的二进制文件 - Git 应该对它们足够聪明。

---

有关 safecrlf/autocrlf 变量的更多信息

Answer 5

--- UPDATE 3 --- （与 UPDATE 2 不冲突）

考虑到 Windows 用户更喜欢在 CRLF 上工作，而 linux/mac 用户更喜欢在 LF 上工作文本文件。 从存储库维护者的角度提供答案：

对我来说，最佳策略（需要解决的问题较少）是：保留所有文本文件即使您正在处理仅限 Windows 的项目，LF inside git repo 也是如此。 然后，给予客户自由，让他们可以使用他们偏好的行结束样式，前提是他们选择的 core.autocrlf 属性值符合以下条件：在暂存文件以供提交时将尊重您的策略（LF on repo）。

分期是许多人在试图理解换行策略如何工作时感到困惑的地方。 在为 core.autocrlf 属性选择正确的值之前，必须了解以下几点：

• 添加用于提交的文本文件（暂存）就像复制文件到 .git/ 子目录中的另一个位置，并带有转换后的行尾（取决于您的 core.autocrlf 值）客户端配置）。 所有这些都是在本地完成的。
• 设置core.autocrlf就像为问题提供答案（在所有操作系统上都完全相同）：“应该git 客户端：
  • a. 从远程签出（拉取）存储库更改时将 LF 转换为 CRLF？
  • b. 添加文件进行提交时将 CRLF 转换为 LF？"
• ，可能的答案（值）是：
  • false:“不执行上述任何操作”，
  • 输入：“只做b”
  • true：“执行a 和 b”
  • 请注意，没有“只做一个”

幸运的是

• git 客户端默认值 (windows: core.autocrlf: true, linux/mac:
  core.autocrlf: false) 将与 LF-only-repo 策略兼容。
  含义：Windows 客户端在签出存储库时默认会转换为 CRLF，在添加提交时会默认转换为 LF。 Linux 客户端默认不会进行任何转换。 从理论上讲，这只会使您的存储库保持在 lf 状态。

不幸的是：

• 可能有 GUI 客户端不尊重 git core.autocrlf 值
• 可能有人不使用值来尊重您的 lf-repo 策略。 例如，他们使用 core.autocrlf=false 并添加带有 CRLF 的文件进行提交。

要尽快检测上述客户端提交的非 lf 文本文件，您可以按照 --- update 2 --- 中的描述进行操作：(git grep -I --files-with-匹配 --perl-regexp '\r' HEAD，在使用 --with-libpcre 标志编译的客户端上）

这里是问题：。 作为仓库维护者，我保留了一个 git.autocrlf=input ，这样我就可以通过再次添加它们进行提交来修复任何错误提交的文件。 我提供了一个提交文本：“修复错误提交的文件”。

就 .gitattributes 而言。 我不指望它，因为有更多的 ui 客户端不理解它。 我只用它来提供文本和二进制文件的提示，并且可能标记一些应该在各处保持相同行结尾的特殊文件：

*.java          text !eol # Don't do auto-detection. Treat as text (don't set any eol rule. use client's)
*.jpg           -text     # Don't do auto-detection. Treat as binary
*.sh            text eol=lf # Don't do auto-detection. Treat as text. Checkout and add with eol=lf
*.bat           text eol=crlf # Treat as text. Checkout and add with eol=crlf

问题：但是为什么我们对换行处理策略感兴趣？

答案：为了避免单字母更改提交，显示为 5000 行更改，只是因为执行更改的客户端自动将整个文件从 crlf 转换为 lf （或相反）在添加它进行提交之前。 当涉及冲突解决时，这可能会相当痛苦。 或者在某些情况下它可能成为不合理冲突的原因。

---

--- 更新 2 ---

git 客户端的默认设置在大多数情况下都可以工作。 即使您只有 Windows 客户端、Linux 客户端或两者都有。 它们是：

• windows： core.autocrlf=true 表示在签出时将行转换为 CRLF，在添加文件时将行转换为 LF。
• linux: core.autocrlf=input 表示在签出时不转换行（不需要，因为文件预计以 LF 提交）并将行转换为 LF（如果添加文件时需要）。
  （-- update3 --：默认情况下似乎这是 false，但同样没问题）

该属性可以在不同的范围内设置。 我建议在 --global 范围中显式设置，以避免最后描述的一些 IDE 问题。

git config core.autocrlf
git config --global core.autocrlf
git config --system core.autocrlf
git config --local core.autocrlf
git config --show-origin core.autocrlf

另外，我强烈不鼓励在Windows上使用git config --global core.autocrlf false（如果您只有Windows客户端）与提议的内容相反 git 文档。 设置为 false 将在存储库中提交带有 CRLF 的文件。 但确实没有理由。 您永远不知道是否需要与 Linux 用户共享该项目。 另外，对于加入该项目的每个客户来说，这是一个额外的步骤，而不是使用默认值。

现在，对于某些特殊情况的文件（例如 *.bat *.sh），您希望使用 LF 或 CRLF 检出它们，您可以使用 .gitattributes

对我来说，最佳实践是：

• 确保每个非二进制文件都在 git repo 上使用 LF 提交（默认行为）。
• 使用此命令确保没有使用 CRLF 提交文件：git grep -I --files-with-matches --perl-regexp '\r' HEAD （注意： 在 Windows 客户端上只能通过 git-bash 工作，在 Linux 客户端上只有在 ./configure 中使用 --with-libpcre 编译时才有效） 。
• 如果执行上述命令发现任何此类文件，请更正它们。 这涉及（至少在 Linux 上）：
  • 设置core.autocrlf=input（---更新3--）
  • 更改文件
  • 恢复更改（文件仍显示为已更改）
  • 提交
• 仅使用最低限度.gitattributes
• 指示用户将上述 core.autocrlf 设置为其默认值。
• 不要 100% 相信 .gitattributes 的存在。 IDE 的 git 客户端可能会忽略它们或以不同的方式对待它们。

正如所说，有些东西可以在 git 属性中添加：

# Always checkout with LF
*.sh            text eol=lf
# Always checkout with CRLF
*.bat           text eol=crlf

我认为 .gitattributes 的其他一些安全选项而不是对二进制文件使用自动检测：

• -text（例如 < code>*.zip 或 *.jpg 文件：不会被视为文本，因此可能不会通过转换程序尝试进​​行行结束转换）
• 。 text !eol （例如，对于*.java、*.html：视为文本，但未设置 eol 样式首选项。因此使用客户端设置。 )
• -text -diff -merge （例如对于 *.hugefile：不被视为文本。无法进行差异/合并）

--- 上一次更新 ---

一个 错误提交文件的客户端的痛苦示例：

netbeans 8.2（在 Windows 上），将错误地使用 CRLF 提交所有文本文件，除非您有<强>显式将core.autocrlf设置为全局。 这与标准 git 客户端行为相矛盾，并在更新/合并时导致很多问题。 这就是为什么某些文件看起来不同（尽管事实并非如此）即使您恢复了的原因。

即使您已将正确的 .gitattributes 添加到项目中，netbeans 中也会发生相同的行为。

提交后使用以下命令，至少可以帮助您尽早检测 git 存储库是否存在行结束问题： git grep -I --files-with-matches --perl-regexp '\r' HEAD

我花了几个小时来想出 .gitattributes 的最佳用法，最终意识到我不能指望它。
不幸的是，只要基于 JGit 的编辑器存在（无法正确处理 .gitattributes），安全的解决方案就是在任何地方强制使用 LF，甚至在编辑器级别也是如此。

使用以下 抗CRLF消毒剂。

• windows/linux 客户端：core.autocrlf=input

• 提交的.gitattributes：* text=auto eol=lf

• 提交的.editorconfig（http://editorconfig.org/)，这是一种标准化格式，与编辑器插件相结合：

  <罢工>
  • https://github.com/editorconfig/
  • https://github.com/welovecoding/editorconfig-netbeans/
    

  
  

  
  

Answer 6

当我在我的 Visual Studio 2010 项目。 开发团队的另外两名成员也使用 Windows 系统，因此混合环境没有发挥作用，但存储库附带的默认设置始终将所有文件标记为在克隆后立即更新。

我想最重要的是找到适合您的环境的 CRLF 设置。 特别是因为在我们的 Linux 机器上的许多其他存储库中设置 autocrlf = true 会产生更好的结果。

20 多年过去了，我们仍在处理操作系统之间的行尾差异......令人难过。

Answer 7

尝试将 core.autocrlf 配置选项设置为 true。 另请查看 core.safecrlf 选项。

实际上，听起来 core.safecrlf 可能已经在您的存储库中设置了，因为（强调我的）：

如果 core.autocrlf 的当前设置不是这种情况，git 将拒绝该文件。

如果是这种情况，那么您可能需要检查您的文本编辑器是否配置为一致地使用行结尾。 如果文本文件包含 LF 和 CRLF 行结尾的混合，您可能会遇到问题。

最后，我认为简单地“使用你所得到的”并在 Windows 上使用 LF 终止行的建议会导致比它解决的问题更多的问题。 Git 有上述选项来尝试以合理的方式处理行结尾，因此使用它们是有意义的。

Answer 8

对于与 Mac 或 Linux 用户共享代码的 Windows 和 Visual Studio 用户来说，有两个选项。 有关详细说明，请阅读 gitattributes 手册。

* text=auto

在存储库的 .gitattributes 文件中添加：

*   text=auto

这将规范存储库中以 LF 行结尾的所有文件。

根据您的操作系统（core.eol 设置），工作树中的文件将标准化为 LF（对于基于 Unix 的系统）或 CRLF对于 Windows 系统。

这是 Microsoft .NET 存储库使用的配置。

示例：

Hello\r\nWorld

将在存储库中始终标准化为：

Hello\nWorld

结帐时，Windows 中的工作树将转换为：

Hello\r\nWorld

结帐时，Mac 中的工作树将保留为：

Hello\nWorld

注意：如果您的存储库已包含未标准化的文件，则下次对这些文件进行任何更改时，git status 会将这些文件显示为已完全修改，并且其他用户可能会很痛苦稍后合并他们的更改。 请参阅刷新更改行结尾后的存储库以获取更多信息。

core.autocrlf = true

如果 .gitattributes 文件中未指定 text，Git 使用 core.autocrlf 配置变量来确定该文件是否应该被转换。

对于 Windows 用户，git config --global core.autocrlf true 是一个不错的选择，因为：

• 文件仅在添加时标准化为 LF 行结尾到回购协议。 如果存储库中存在未标准化的文件，则此设置不会影响它们。
• 所有文本文件都将转换为工作目录中的 CRLF 行结尾。

这种方法的问题在于：

• 如果您是使用 autocrlf = input 的 Windows 用户，您将看到一堆带有 LF 行结尾的文件。 对于团队的其他成员来说这不是危险，因为您的提交仍将以 LF 行结尾进行标准化。
• 如果您是使用 core.autocrlf = false 的 Windows 用户，您将看到一堆带有 LF 行结尾的文件，并且您可能会引入带有 CRLF 的文件code> 行结尾到存储库中。
• 大多数 Mac 用户使用 autocrlf = input，并且可能会获取带有 CRLF 文件结尾的文件，这些文件可能来自带有 core.autocrlf = false 的 Windows 用户。

Answer 9

这只是一个解决方法解决方案：

在正常情况下，使用 git 附带的解决方案。 这些在大多数情况下都很有效。 如果您通过设置 .gitattributes 在基于 Windows 和 Unix 的系统上共享开发，则强制为 LF。

就我而言，有超过 10 名程序员在 Windows 中开发一个项目。 这个项目是用 CRLF 签入的，没有强制换成 LF 的选项。

一些设置是在我的机器上内部编写的，对 LF 格式没有任何影响； 因此，在每次小文件更改时，某些文件都会全局更改为 LF。

我的解决方案：

Windows 机器：
让一切保持原样。 无需关心任何事情，因为您是默认的 Windows“独狼”开发人员，并且您必须这样处理：“世界上没有其他系统，不是吗？”

Unix-Machines

1. 将以下行添加到配置的 [alias] 部分。 此命令列出所有已更改（即修改/新）的文件：

   lc = "!f() { git status --porcelain \ 
                  |   egrep -r \"^(\?| ).\*\\(.[a-zA-Z])*\" \ 
                  |   切-c 4- ;   };   F ” 
     

2. 将所有这些已更改文件转换为 dos 格式：

   unix2dos $(git lc) 
     

3. 可选...

   1. 为此创建一个 git 钩子自动化此过程的操作

   2. 使用参数并包含它并修改 grep 函数以仅匹配特定文件名，例如：

      <代码>... |   egrep -r "^(\?| ).*\.(txt|conf)" |   ... 
        

   3. 随意使用额外的快捷方式使其更加方便：

      c2dos = "!f() { unix2dos $(git lc) ; }; f " 
        

      ...并通过键入来触发转换后的内容

      git c2dos