gitattributes文件
格式
Git的gitattributes文件是一个文本文件,文件中的一行定义一个路径的若干属性。以行为单位设置一个路径下所有文件的属性,格式如下:
要匹配的文件模式 属性1 属性2
GRLF和LF
CRLF,LF都是用来表示文本换行的方式。CR代表回车,对应字符\r。LF表示换行,对应字符\n。不同操作系统文本使用的换行符各不相同。Windows系统使用的是CRLF,Unix系统(包括Linux,MacOS近些年的版本)使用的是LF。
实例
* text=auto
# 文件的行尾自动转换。如果是文本文件,则在文件入Git库时,行尾自动转换为LF。如果已经在入Git库中的文件的行尾是GRLF,则文件在入Git库时,不再转换为LF。
*.txt text
# 对于.txt文件,标记为文本文件,并进行行尾规范化。
*.jpg -text
# 对于`.jpg`文件,标记为非文本文件
*.vcproj text eol=crlf
# 对于.vcproj文件,标记为文本文件,在文件入Git库时进行规范化,行尾转换为LF。在检测到出工作目录时,行尾自动转换为GRLF。
*.sh text eol=lf
# 对于sh文件,标记为文本文件,在文件入Git库时进行规范化,即行尾为LF。在检出到工作目录时,行尾也不会转换为CRLF(即保持LF)。
*.py eol=lf
# 对于py文件,只针对工作目录中的文件,行尾为LF。
属性
text
控制行尾的规范性。如果一个文本文件是规范的,则Git库汇总该文件的行尾总是LF
。对于工作目录,除了text
属性之外,还可以设置eol
属性或core.eol
配置变量。
eol
设置行末字符。
eol=lf
,入库时将行尾规范为LF
,检出时禁止将行尾转换为CRLF
eol=crlf
,入库时将行尾规范为LF
,检出时将行尾转换为CRLF
。
diff
diff
属性影响Git
对特殊文件生成差异的方式。它可以告诉Git
是否为路径生成文本补丁还是将路径视为二进制文件。它也可以影响在hunk
头部显示的@@ -k,l +n,m @@
,告诉Git
使用外部命令来生成差异,或者是在生成差异之前让Git
将二进制文件转换为文本文件。
设置diff
如果一个路径设置diff
属性,它将被视为文本文件,即使它包含一些通常从不会出现在文本文件的字节值,例如NUL
。
不设置diff
没有设置diff
属性的路径会生成differ
二进制文件(如果启用了二进制补丁,会生成二进制补丁)。
不确定
未指明diff
属性的路径首先会检查其内容,如果它看起来像文本文件并且小于core.bigFileThreshold
,则将其视为文本文件,否则将生成differ
二进制文件。
core.bigFileThreshold
:所有平台上的默认值为512MiB。大于此大小的文件将被缩减,而不会尝试增量压缩。
字符串
diff
是使用指定的diff
驱动程序显示的。每个驱动程序可以指定一个或多个选项。如下部分所述。驱动程序foo
是由Git的配置文件中diff.foo
的配置值定义的。
定义一个外部的diff驱动程序
diff
驱动程序的定义是在gitconfig
中完成的,并不是在gitattributes
文件中,所以严格来说,这里并不适合谈论它。
将文件标记为二进制
实例
*.js eol=lf
*.json eol=lf
*.jsx eol=lf
*.ts eol=lf