简体中文 ▾ 主题 ▾ 最新版本 ▾ gitignore 最后更新于 2.42.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 核心工具，例如 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 标志。

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

  • 前导的 "**" 后跟斜杠表示在所有目录中匹配。例如，"**/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 中路径规范通常的工作方式一致）

  • 模式 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] 套件的一部分

scroll-to-top