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

名称

gitignore - 指定要忽略的未跟踪文件

概要

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

描述

一个 gitignore 文件指定要忽略的未跟踪文件。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 标志。

  • 反斜杠 ("\") 可用于转义任何字符。例如，"\*" 匹配字面上的星号（而 "\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 中路径名的一般工作方式一致）。

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