一、描述
总会有些文件无需纳入 Git 的管理,也不希望它们总出现在未跟踪文件列表。 通常都是些自动生成的文件,比如日志文件,或者编译过程中创建的临时文件等。 在这种情况下,我们可以创建一个名为 .gitignore
的文件,列出要忽略的文件模式。
二、语法
文件 .gitignore
的格式规范如下:
- 所有空行或者以
#
开头的行都会被 Git 忽略。 - 可以使用标准的 glob 模式匹配。
- 匹配模式可以以(
/
)开头防止递归。 - 匹配模式可以以(
/
)结尾指定目录。 - 要忽略指定模式以外的文件或目录,可以在模式前加上惊叹号(
!
)取反。
正则匹配如下:
- 星号(
*
)匹配零个或多个任意字符; [abc]
匹配任何一个列在方括号中的字符(这个例子要么匹配一个 a,要么匹配一个 b,要么匹配一个 c);- 问号(
?
)只匹配一个任意字符; -
[0-9]
表示匹配所有 0 到 9 的数字,[a-c]表示匹配所有a-c的字母,即a b c; - 使用两个星号(
*
) 表示匹配任意中间目录,比如a/**/z
可以匹配a/z
,a/b/z
或a/b/c/z
等。
三、具体应用
以STM32 CubeMX生成的工程为例,创建Git仓库,并对编译生成的结果和日志忽略。gitignore按照文本中的内容自上而下依次匹配,这里我设置忽略output编译结果,bak备份,htm描述,jlinklog日志,工程相关的一级调试配置。可以按如下的格式:
.gitignore
Project/output
Project/*.bak
Project/*.htm
Project/JLinkLog.txt
Project/*uvguix*
Project/DebugConfig