gitignore

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

    概要

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

    文件指定Git应忽略的故意未跟踪文件。 Git已经跟踪的文件不受影响;有关详细信息,请参阅下面的注释。

    gitignore文件中的每一行都指定一个模式。在决定是否忽略路径时,Git通常会检查来自多个源的gitignore模式,具有以下优先顺序,从最高到最低(在一个优先级内,最后一个匹配模式决定结果):

    • 从与路径相同的目录中的.gitignore文件读取的模式,或在任何父目录中读取的模式,其中较高级别文件中的模式(直到工作树的顶层)被较低级别文件中的模式覆盖到包含该文件的目录。这些模式相对于.gitignore文件的位置匹配。项目通常在其存储库中包含此类.gitignore文件,其中包含作为项目构建的一部分生成的文件的模式。

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

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

    放置模式的文件取决于模式的使用方式。

    • 应该通过克隆进行版本控制并分发到其他存储库的模式(即所有开发人员都希望忽略的文件)应该进入.gitignore文件。

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

    底层的Git管道工具,如 git ls-filesgit read-tree ,读取命令行选项指定的gitignore模式,或者命令行指定的文件选项。更高级别的Git工具,例如 git statusgit add ,使用上面指定的来源的模式。

    模式格式

    • 空行不匹配任何文件,因此它可以作为可读性的分隔符。

    • 以#开头的行作为注释。对于以哈希开头的模式,在第一个哈希值前加一个反斜杠(“\”)。

    • 可选的前缀“!”否定模式;之前模式排除的任何匹配文件将再次包含在内。如果排除该文件的父目录,则无法重新包含文件。出于性能原因,Git不会列出排除的目录,因此无论在何处定义,所包含文件的任何模式都不起作用。对于以文字“”开头的模式,在第一个“!”前放置一个反斜杠(“\”),例如“\!important!.txt”。

    • 如果模式以斜杠结尾,则为了以下描述的目的将其删除,但它只会找到与目录的匹配项。换句话说,foo/将匹配目录foo和它下面的路径,但不匹配常规文件或符号链接foo(这与在Git中一般使用pathspec的方式一致)。

    • 如果模式不包含斜杠 / ,Git会将其视为shell glob模式,并检查相对于.gitignore文件位置的路径名匹配(相对于工作的顶层)树,如果不是来自.gitignore文件)。

    • 否则,Git将模式视为shell glob:“*”匹配除“/”之外的任何内容,“?”匹配除“/”之外的任何一个字符,并且“[]”匹配一个字符选定的范围。有关更详细的说明,请参阅fnmatch(3)和FNM_PATHNAME标志。

    • 前导斜杠与路径名的开头匹配。例如,“/ *。c”匹配“cat-file.c”但不匹配“mozilla-sha1 / sha1.c”。

    • 前导“**”后跟斜杠表示在所有目录中匹配。例如,“”在任何地方匹配文件或目录“foo”,与模式“foo”相同。 “**/foo/bar”将文件或目录“bar”匹配在“foo”目录下的任何位置。

    • 尾随“/**”匹配内部的所有内容。例如,“abc/**”匹配目录“abc”内的所有文件,相对于.gitignore文件的位置,具有无限深度。

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

    gitignore文件的目的是确保Git未跟踪的某些文件保持未跟踪。

    要停止跟踪当前跟踪的文件,请使用 git rm —cached

    例子

    另一个例子:

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

    排除除特定目录foo/bar以外的所有内容的示例(注意 - 没有斜杠,通配符也会排除foo/bar中的所有内容):

    gitrepository-layout [5]

    GIT