.gitignore 详解

2023-04-22
上海
本文字数：1857 字
阅读完需：约 6 分钟

什么是 .gitignore 文件？

.gitignore 是一个文本文件，用于指定在 Git 仓库中不应被 Git 跟踪的文件或目录。它通常位于项目的根目录中，是 Git 仓库的基本组成部分之一。.gitignore 文件的内容是由一些预定义的模板指令和注释组成的。这些指令和注释告诉 Git 如何跟踪或忽略特定的文件或目录。

:::info 一般来说每个 Git 项目中都需要一个“.gitignore”文件，这个文件的作用就是告诉 Git 哪些文件不需要添加到版本管理中。:::

常用一些指令

以 ! 可以使该文件或目录不被跟踪，但前提是该文件或目录没有被 Git 跟踪过  !README.md  

# 忽略所有以 ".txt" 结尾的文件  .txt$  # 忽略所有以 ".md" 结尾的文件，但不包括 "README.md"  .md$  # 忽略所有以 ".sh" 结尾的文件，但不包括 "script.sh"  .sh$  # 忽略所有以 ".c" 结尾的文件，但不包括 "main.c"  .c$  # 忽略所有以 ".h" 结尾的文件，但不包括 "header.h"  .h$  

# 忽略所有以 "bin" 结尾的文件  bin$  # 忽略所有以 "lib" 结尾的文件，但不包括 "linux-kernel-headers.lib"  lib$  # 忽略所有以 "include" 结尾的文件，但不包括 "linux-kernel-headers.include"  include$  # 忽略所有以 "src" 结尾的文件，但不包括 "linux-kernel-headers.src"  src$  # 忽略所有以 "doc" 结尾的文件，但不包括 "README.md"  doc$  # 忽略所有以 "www" 结尾的文件，但不包括 "index.html"  www$ 



#               表示此为注释,将被Git忽略*.a             表示忽略所有 .a 结尾的文件!lib.a          表示但lib.a除外/TODO           表示仅仅忽略项目根目录下的 TODO 文件，不包括 subdir/TODObuild/          表示忽略 build/目录下的所有文件，过滤整个build文件夹；doc/*.txt       表示会忽略doc/notes.txt但不包括 doc/server/arch.txt bin/:           表示忽略当前路径下的bin文件夹，该文件夹下的所有内容都会被忽略，不忽略 bin 文件/bin:           表示忽略根目录下的bin文件/*.c:           表示忽略cat.c，不忽略 build/cat.cdebug/*.obj:    表示忽略debug/io.obj，不忽略 debug/common/io.obj和tools/debug/io.obj**/foo:         表示忽略/foo,a/foo,a/b/foo等a/**/b:         表示忽略a/b, a/x/b,a/x/y/b等!/bin/run.sh    表示不忽略bin目录下的run.sh文件*.log:          表示忽略所有 .log 文件config.php:     表示忽略当前路径的 config.php 文件 /mtk/           表示过滤整个文件夹*.zip           表示过滤所有.zip文件/mtk/do.c       表示过滤某个具体文件

复制代码

要忽略特定文件 / 目录

将名称添加到 .gitignore 文件中。如果要忽略多个文件或目录，请使用逗号分隔它们

# 忽略两个以 "footer" 开头的文件  footer.h,config.h

复制代码

匹配规则语法

:::info 在 .gitignore 文件中，每一行的忽略规则的语法如下：1）空格不匹配任意文件，可作为分隔符，可用反斜杠转义 2）以“＃”开头的行都会被 Git 忽略。即 #开头的文件标识注释，可以使用反斜杠进行转义。3）可以使用标准的 glob 模式匹配。所谓的 glob 模式是指 shell 所使用的简化了的正则表达式。4）以斜杠"/"开头表示目录；"/"结束的模式只匹配文件夹以及在该文件夹路径下的内容，但是不匹配该文件；"/"开始的模式匹配项目跟目录；如果一个模式不包含斜杠，则它匹配相对于当前 .gitignore 文件路径的内容，如果该模式不在 .gitignore 文件中，则相对于项目根目录。5）以星号""通配多个字符，即匹配多个任意字符；使用两个星号"*" 表示匹配任意中间目录，比如a/**/z可以匹配 a/z, a/b/z 或 a/b/c/z 等。6）以问号"?"通配单个字符，即匹配一个任意字符；7）以方括号"[]"包含单个字符的匹配列表，即匹配任何一个列在方括号中的字符。比如[abc]表示要么匹配一个 a，要么匹配一个 b，要么匹配一个 c；如果在方括号中使用短划线分隔两个字符，表示所有在这两个字符范围内的都可以匹配。比如[0-9]表示匹配所有 0 到 9 的数字，[a-z]表示匹配任意的小写字母）。8）以叹号"!"表示不忽略(跟踪)匹配到的文件或目录，即要忽略指定模式以外的文件或目录，可以在模式前加上惊叹号（!）取反。需要特别注意的是：如果文件的父目录已经被前面的规则排除掉了，那么对这个文件用"!"规则是不起作用的。也就是说"!"开头的模式表示否定，该文件将会再次被包含，如果排除了该文件的父级目录，则使用"!"也不会再次被包含。可以使用反斜杠进行转义。:::