简体中文 ▾ 主题 ▾ 最新版本 ▾ gitignore 最后更新于 2.52.0

名称

gitignore - 指定故意不追踪的忽略文件

概要

$XDG_CONFIG_HOME/git/ignore, $GIT_DIR/info/exclude, .gitignore

描述

gitignore 文件用于指定 Git 应忽略的故意不追踪的文件。Git 已经追踪的文件不受影响；详情请参阅下文的注意事项。

gitignore 文件中的每一行都指定一个模式。在决定是否忽略某个路径时，Git 通常会检查来自多个源的 gitignore 模式，优先级从高到低如下（在同一优先级内，最后匹配的模式决定结果）：

  • 对于支持命令行模式的命令，从命令行读取的模式。

  • 从与路径相同目录中的 .gitignore 文件或任何父目录（直至工作树的顶层目录）中读取的模式，较深层目录文件中的模式会覆盖较浅层目录文件中的模式。这些模式相对于 .gitignore 文件所在的位置进行匹配。项目通常会在其仓库中包含此类 .gitignore 文件，其中包含项目构建过程中产生的文件模式。

  • 从 $GIT_DIR/info/exclude 读取的模式。

  • 从配置变量 core.excludesFile 指定的文件中读取的模式。

将模式放置在哪个文件中取决于该模式的用途。

  • 应该进行版本控制并通过克隆分发到其他仓库的模式（即所有开发者都希望忽略的文件）应放入 .gitignore 文件中。

  • 特定于某个特定仓库但不需要与其他相关仓库共享的模式（例如，位于仓库内但特定于某个用户工作流的辅助文件）应放入 $GIT_DIR/info/exclude 文件中。

  • 用户希望 Git 在所有情况下都忽略的模式（例如，由用户选择的编辑器生成的备份或临时文件）通常放入用户 ~/.gitconfig 中由 core.excludesFile 指定的文件里。其默认值为 $XDG_CONFIG_HOME/git/ignore。如果 $XDG_CONFIG_HOME 未设置或为空，则使用 $HOME/.config/git/ignore。

底层的 Git plumbing 工具，如 git ls-files 和 git read-tree，会读取由命令行选项指定的 gitignore 模式，或从命令行选项指定的文件中读取。高层 Git 工具，如 git status 和 git add，则使用上述来源的模式。

模式格式

  • 空行不匹配任何文件，因此可以作为分隔符以提高可读性。

  • 以 # 开头的行作为注释。对于以井号开头的模式，请在第一个井号前加反斜杠（"\"）。

  • 行尾空格会被忽略，除非用反斜杠（"\"）转义。

  • 可选的前缀 "!" 用于对模式取反；任何被先前模式排除的匹配文件都将重新包含。如果该文件的父目录已被排除，则无法重新包含该文件。出于性能原因，Git 不会列出已排除的目录，因此无论定义在哪里，包含在该目录中的文件的任何模式都不会起作用。对于以字面量 "!" 开头的模式，请在第一个 "!" 前加反斜杠（"\"），例如 "\!important!.txt"。

  • 斜杠 "/" 用作目录分隔符。分隔符可能出现在 .gitignore 搜索模式的开头、中间或末尾。

  • 如果模式的开头或中间（或两者都有）有分隔符，则该模式相对于特定 .gitignore 文件本身的目录级别。否则，该模式也可能在 .gitignore 级别下的任何级别匹配。

  • 如果模式末尾有分隔符，则该模式仅匹配目录；否则，该模式既可以匹配文件也可以匹配目录。

  • 例如，模式 doc/frotz/ 匹配 doc/frotz 目录，但不匹配 a/doc/frotz 目录；然而 frotz/ 匹配 frotz 和 a/frotz 目录（所有路径都是相对于 .gitignore 文件的）。

  • 星号 "*" 匹配除斜杠外的任何内容。字符 "?" 匹配除 "/" 外的任何一个字符。范围表示法（例如 [a-zA-Z]）可用于匹配范围内的其中一个字符。有关更详细的说明，请参阅 fnmatch(3) 和 FNM_PATHNAME 标志。

  • 反斜杠（"\"）可用于转义任何字符。例如，"\*" 匹配字面量星号（而 "\a" 匹配 "a"，尽管此处不需要转义）。与 fnmatch(3) 一样，模式末尾的反斜杠是无效模式，永远不会匹配。

与完整路径名匹配的模式中，两个连续的星号（**）可能具有特殊含义：

  • 开头的 "**" 后跟一个斜杠表示在所有目录中匹配。例如，"**/foo" 匹配任何位置的文件或目录 "foo"，与模式 "foo" 相同。"**/foo/bar" 匹配直接位于目录 "foo" 下任何位置的文件或目录 "bar"。

  • 末尾的 "/**" 匹配内部的所有内容。例如，"abc/**" 匹配目录 "abc" 内的所有文件（相对于 .gitignore 文件的位置），具有无限深度。

  • 斜杠后跟两个连续的星号，然后是斜杠，匹配零个或多个目录。例如，“a/**/b”匹配“a/b”、“a/x/b”、“a/x/y/b”等等。

  • 其他连续的星号被视为普通星号，并根据之前的规则进行匹配。

配置

可选配置变量 core.excludesFile 指向包含要排除的文件名模式的文件路径，类似于 $GIT_DIR/info/exclude。排除文件中的模式与 $GIT_DIR/info/exclude 中的模式结合使用。

注意事项

gitignore 文件的目的是确保某些不被 Git 追踪的文件保持未追踪状态。

要停止追踪当前已被追踪的文件，请使用 git rm --cached 从索引中删除该文件。然后可以将该文件名添加到 .gitignore 文件中，以防止该文件在以后的提交中被重新引入。

Git 在访问工作树中的 .gitignore 文件时不会遵循符号链接。这使得从索引或树访问文件与从文件系统访问文件时的行为保持一致。

示例

  • 模式 hello.* 匹配任何名称以 hello. 开头的文件或目录。如果只想将其限制在该目录而不是其子目录中，可以在模式前加一个斜杠，即 /hello.*；现在该模式匹配 hello.txt、hello.c，但不匹配 a/hello.java。

  • 模式 foo/ 将匹配目录 foo 及其下方的路径，但不会匹配普通文件或符号链接 foo（这与 Git 中 pathspec 的一般工作方式一致）。

  • 模式 doc/frotz 和 /doc/frotz 在任何 .gitignore 文件中具有相同的效果。换句话说，如果模式中已经存在中间斜杠，则开头的斜杠无关紧要。

  • 模式 foo/* 匹配 foo/test.json（普通文件）、foo/bar（目录），但不匹配 foo/bar/hello.c（普通文件），因为模式中的星号不匹配其中包含斜杠的 bar/hello.c。

    $ git status
    [...]
    # Untracked files:
    [...]
    #       Documentation/foo.html
    #       Documentation/gitignore.html
    #       file.o
    #       lib.a
    #       src/internal.o
    [...]
    $ cat .git/info/exclude
    # ignore objects and archives, anywhere in the tree.
    *.[oa]
    $ cat Documentation/.gitignore
    # ignore generated html files,
    *.html
    # except foo.html which is maintained by hand
    !foo.html
    $ git status
    [...]
    # Untracked files:
    [...]
    #       Documentation/foo.html
    [...]

另一个例子

    $ cat .gitignore
    vmlinux*
    $ ls arch/foo/kernel/vm*
    arch/foo/kernel/vmlinux.lds.S
    $ echo '!/vmlinux*' >arch/foo/kernel/.gitignore

第二个 .gitignore 防止 Git 忽略 arch/foo/kernel/vmlinux.lds.S。

排除除特定目录 foo/bar 以外的所有内容的示例（注意 /* - 如果没有斜杠，通配符也会排除 foo/bar 内的所有内容）

    $ cat .gitignore
    # exclude everything except directory foo/bar
    /*
    !/foo
    /foo/*
    !/foo/bar

另请参阅

git-rm[1], gitrepository-layout[5], git-check-ignore[1]

GIT

Git[1] 套件的一部分