在使用Git的过程中,我们喜欢有的文件比如日志,临时文件,编译的中间文件等不要提交到代码仓库,这时就要设置相应的忽略规则,来忽略这些文件的提交。简单来说一个场景:在你使用git add .
的时候,遇到了把你不想提交的文件也添加到了缓存中去的情况,比如项目的本地配置信息,git为我们提供了一个.gitignore
文件只要在这个文件中申明那些文件你不希望添加到git中去,这样当你使用git add .
的时候这些文件就会被自动忽略掉。
首先,在你的 (Git项目)
工作区新建一个名称为.gitignore的
文件。然后,把要忽略的文件名填进去,Git就会自动忽略这些文件。 不需要从头写.gitignore文件,GitHub已经为我们准备了各种配置文件,只需要组合一下就可以使用了
具体的匹配规则如下:
- 首先在git项目根目录中 定义一个
.gitignore
文件
.gitignore注释用#, *
表示匹配0个或多个
任意字符,所以上面的模式就是要忽略所有的xml文件,log文件和apk文件。
.gitignore
忽略规则的匹配语法
在 .gitignore 文件中,每一行的忽略规则的语法如下:
- 空行会被忽略
- 匹配是区分大小写的,如:/abc 和 /Abc 含义不同
#
开头是注释,会被忽略*
通配多个字符,即匹配多个任意字符,如*.[oa]
忽略所有以".o"或".a"结尾**
两个星含义是子目录(子子目录)等多层匹配?
匹配1个字符(注意不是0-1个字符!)[]
用来匹配括号内的任一字符,如 [abc],也可以在括号内加连接符
,如 [0-9] 匹配0至9的数- *~ 忽略所有以~结尾的文件(这种文件通常被许多编辑器标记为临时文件)
- ! 表示不忽略某文件(为什么要特别指出不忽略? 不写规则不就不会被忽略吗?,这是配合使用的,比如要忽略*.log,但是要排除a.log,这种需求就需要使用!)
需要谨记:
-
git对于.gitignore配置文件是 按行从上到下进行规则匹配的,意味着如果前面的规则匹配的范围更大,则后面的规则将不会生效;
-
以
斜杠/开头表示目录
,分为 根目录 和 子目录
fd1/*
说明:忽略目录 fd1 下的全部内容;注意,不管是根目录下的 /fd1/ 目录,还是某个子目录 /child/fd1/ 目录,都会被忽略;
/fd1/*
说明:仅忽略根目录下的 /fd1/ 目录的全部内容;
使用示例
# 表示此为注释,将被Git忽略
*.a 表示忽略所有 .a 结尾的文件
!lib.a 表示但lib.a除外
/TODO 表示仅仅忽略项目根目录下的 TODO 文件,不包括 subdir/TODO
TODO 表示忽略当前项目下所有的 TODO 文件,包括**/**/TODO
build/ 表示忽略 build/目录下的所有文件,过滤整个build文件夹;
doc/*.txt 表示会忽略doc/notes.txt但不包括 doc/server/arch.txt
bin/ 表示忽略当前路径下的bin文件夹,该文件夹下的所有内容都会被忽略,不忽略 bin 文件
/bin 表示忽略根目录下的bin文件
/*.c 表示忽略cat.c,不忽略 build/cat.c
debug/*.obj: 表示忽略debug/io.obj,不忽略 debug/common/io.obj和tools/debug/io.obj
**/foo 表示忽略/foo,a/foo,a/b/foo等
a/**/b 表示忽略a/b, a/x/b,a/x/y/b等
!/bin/run.sh 表示不忽略bin目录下的run.sh文件
*.log 表示忽略所有 .log 文件
/*.log 表示忽略根目录下的 .log 文件
config.php: 表示忽略当前路径的 config.php 文件
/mtk/ 表示过滤整个文件夹
*.zip 表示过滤所有.zip文件
/mtk/do.c 表示过滤某个具体文件
# 被过滤掉的文件就不会出现在git仓库中(gitlab或github)了,当然本地库中还有,只是push的时候不会上传。
/mtk/*
!/mtk/one.txt
注意上面的/mtk/*不能写为/mtk/,否则父目录被前面的规则排除掉了,one.txt文件虽然加了!过滤规则,也不会生效!
----------------------------------------------------------------------------------
还有一些规则如下:
fd1/*
说明:忽略目录 fd1 下的全部内容;注意,不管是根目录下的 /fd1/ 目录,还是某个子目录 /child/fd1/ 目录,都会被忽略;
/fd1/*
说明:忽略根目录下的 /fd1/ 目录的全部内容;
/*
!.gitignore
!/fw/
/fw/*
!/fw/bin/
!/fw/sf/
说明:忽略全部内容,但是不忽略 .gitignore 文件、根目录下的 /fw/bin/ 和 /fw/sf/ 目录;注意要先对bin/的父目录使用!规则,使其不被排除。
已经添加的文件
如果你不慎在创建.gitignore
文件之前就push
了项目,那么即使你在.gitignore
文件中写入新的过滤规则,这些规则也不会起作用,Git仍然会对所有文件进行版本管理。简单来说出现这种问题的原因就是Git已经开始管理这些文件了,所以你无法再通过过滤规则过滤它们。所以大家一定要养成在项目开始就创建.gitignore文件的习惯,否则一单push,处理起来会非常麻烦。
如果已经提交过的文件或者文件夹怎么办?此时更改.gitignore文件对已经提交的文件是无效的。
- 首先,编辑.gitignore文件。
- 然后如果是单个文件,可以使用如下命令从仓库中删除:
git rm --cached logs/xx.log
如果是整个目录:
git rm --cached -r logs
如果文件很多,那么直接
git rm --cached -r .
如果提示某个文件无法忽略,可以添加-f参数强制忽略。
git rm -f --cached logs/xx.log
- 然后
git add .
git commit -m "Update .gitignore"
git仓库文件的4种状态
-
Untracked:
未跟踪, 此文件在文件夹中, 但并没有加入到git库, 不参与版本控制. 通过git add 状态变为Staged. -
Unmodify:
文件已经入库, 未修改, 即版本库中的文件快照内容与文件夹中完全一致. 这种类型的文件有两种去处, 如果它被修改, 而变为Modified. 如果使用git rm移出版本库, 则成为Untracked文件 -
Modified:
文件已修改, 仅仅是修改, 并没有进行其他的操作. 这个文件也有两个去处, 通过git add可进入暂存staged状态, 使用git checkout 则丢弃修改过, 返回到unmodify状态, 这个git checkout即从库中取出文件, 覆盖当前修改 -
Staged:
暂存状态. 执行git commit则将修改同步到库中, 这时库中的文件和本地文件又变为一致, 文件为Unmodify状态. 执行git reset HEAD filename取消暂存, 文件状态为Modified
Git 状态 untracked 和 not staged的区别
- untrack 表示是新文件,没有被add过,是为跟踪的意思。
- not staged 表示add过的文件,即跟踪文件,再次修改没有add,就是没有暂存的意思