Gitignore文件
Gitignore是一个用于指定Git版本控制系统忽略特定文件或目录的规则文件。它的发展可以追溯到早期的版本控制系统,如CVS和SVN,这些系统使用类似的机制来忽略特定文件。
在Git中,Gitignore文件的原理是通过定义一系列规则来告诉Git哪些文件应该被忽略。这些规则可以是简单的通配符模式,也可以是正则表达式。当Git执行某个操作时,如添加文件到版本控制或提交更改,它会检查Gitignore文件中的规则,并根据规则来决定是否忽略某个文件。
Gitignore文件的作用是帮助开发者过滤掉不需要被版本控制的文件,以减少仓库的体积和提高操作效率。它可以用于忽略一些临时文件、编译生成的文件、日志文件、配置文件等。通过忽略这些文件,可以使版本控制系统更加干净和专注于源代码的管理。
使用描述
一个.gitignore文件指定了Git应该忽略的意图上未跟踪的文件。已经被Git跟踪的文件不受影响;有关详细信息,请参阅下面的注释。
gitignore文件中的每一行都指定了一个模式。在决定是否忽略一个路径时,Git通常会从多个来源检查gitignore模式,按照以下优先顺序(在一个优先级级别内,最后匹配的模式决定结果):
对于支持它们的命令,从命令行读取的模式。
从与路径相同目录中的.gitignore文件,或者从任何父目录(直到工作树的顶级)中读取的模式,其中较高级别文件中的模式会被较低级别文件中的模式覆盖,直到包含该文件的目录。这些模式相对于.gitignore文件的位置进行匹配。一个项目通常会在其存储库中包含这样的.gitignore文件,其中包含作为项目构建的一部分生成的文件的模式。
从$GIT_DIR/info/exclude
中读取的模式。
从由配置变量core.excludesFile
指定的文件中读取的模式。
将模式放在哪个文件中取决于模式的使用方式。
应该进行版本控制并通过克隆分发到其他存储库(即,所有开发人员都希望忽略的文件)的模式应该放在.gitignore
文件中。
特定于特定存储库但不需要与其他相关存储库共享的模式(例如,存储库内部但特定于一个用户工作流程的辅助文件)应该放在$GIT_DIR/info/exclude
文件中。
用户希望Git在所有情况下都忽略的模式(例如,用户选择的编辑器生成的备份或临时文件)通常放在由core.excludesFile
在用户的~/.gitconfig
中指定的文件中。它的默认值是$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
,使用上述来源中的模式。
Gitignore基本语法
Gitignore文件的基本使用方法是通过定义规则来告诉Git哪些文件应该被忽略。下面是Gitignore文件的基本语法和配置方法:
1. 基本语法★★★★★
- 空行不匹配任何文件,因此可以用作可读性的分隔符。
- 以“
#
”开头的行作为注释。对于以“#
”开头的模式,可以在第一个“#
”前面加上反斜杠(“\
”)。 - 尾随空格会被忽略,除非用反斜杠(“
\
”)引用。 - 可选的前缀“
!
”可以否定模式;被先前模式排除的任何匹配文件将重新包含。如果排除了文件的父目录,则无法重新包含该文件。出于性能原因,Git不会列出被排除的目录,因此对包含的文件的任何模式都没有影响,无论它们在何处定义。对于以字面“!”开头的模式,例如“\!important!.txt
”,可以在第一个“!
”前面加上反斜杠(“\
”)。 - 斜杠“
/
”用作目录分隔符。分隔符可以出现在.gitignore搜索模式的开头、中间或结尾。
如果模式的开头或中间(或两者都有)有分隔符/
,则该模式相对于特定.gitignore文件所在的目录级别。否则,该模式也可以在.gitignore级别以下的任何级别匹配。(比如a/b
中间有斜杠,需要a
与.gitignore同级才会被匹配,c/a/b
不会匹配;/a
同样)
如果模式的结尾有分隔符/
,则该模式只匹配目录,否则该模式可以匹配文件和目录。
例如,模式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/**
”匹配相对于.gitignore文件位置的目录“abc”中的所有文件,具有无限深度。 - 斜杠后面跟着两个连续的星号然后是斜杠,表示匹配零个或多个目录。例如,“
a/**/b
”匹配“a/b
”、“a/x/b
”、“a/x/y/b
”等。
- 以“
- 其他连续的星号被视为普通的星号,并根据前面的规则进行匹配。
2. 配置方法
- 在项目根目录下创建一个名为
.gitignore
的文件。 - 在
.gitignore
文件中添加需要忽略的文件或目录的规则。 - 每行一个规则,可以使用上述基本语法来定义规则。
- 保存
.gitignore
文件。
对于有多个目录的情况,想要忽略某种类型文件的目录和不想忽略的目录,可以在.gitignore
文件中分别定义规则。例如,假设有两个目录dir1
和dir2
,想要忽略dir1
目录下的.txt
文件,但不想忽略dir2
目录下的.txt
文件,可以按照以下步骤进行配置:
-
在
.gitignore
文件中添加以下规则:# 忽略dir1目录下的.txt文件 /dir1/*.txt
-
在
dir2
目录下创建一个名为.gitignore
的文件。 -
在
dir2/.gitignore
文件中添加以下规则:# 不忽略dir2目录下的.txt文件 !*.txt
这样配置后,Git会忽略dir1
目录下的.txt
文件,但不会忽略dir2
目录下的.txt
文件。注意,.gitignore
文件的规则是逐级生效的,所以在dir2/.gitignore
文件中使用!*.txt
来取反,表示不忽略dir2
目录下的.txt
文件。
匹配示例
示例1
模式 hello.*
匹配以 hello.
开头的任何文件或目录。如果只想限制在目录中而不包括其子目录,可以在模式前加上斜杠,即 /hello.*
;现在模式匹配 hello.txt
、hello.c
,但不匹配 a/hello.java
。
模式 foo/
匹配目录 foo
及其下面的路径,但不匹配普通文件或符号链接 foo
(这与 Git 中 pathspec 的工作方式一致)。
模式 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
[...]
上面这段代码是一个示例,用来说明git中的文件忽略功能。在这个示例中,首先使用git status
命令查看当前仓库的状态,发现有一些未跟踪的文件。然后,通过查看.git/info/exclude
文件和Documentation/.gitignore
文件,可以看到哪些文件被设置为忽略。最后再次使用git status
命令查看仓库的状态,发现只有Documentation/foo.html
文件没有被忽略。
示例2
$ 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
。
示例3
例子:排除除了特定目录 foo/bar
之外的所有内容(注意 /*
- 如果没有斜杠,通配符也会排除 foo/bar
内的所有内容):
$ cat .gitignore
# 排除除了目录 foo/bar 之外的所有内容
/*
!/foo
/foo/*
!/foo/bar
其他命令
git status --ignored(用于显示被Git忽略的文件和文件夹的状态)
git status --ignored
命令用于显示被Git忽略的文件和文件夹的状态。
Git有一个名为.gitignore
的文件,用于指定哪些文件和文件夹应该被忽略,不纳入版本控制。这些被忽略的文件和文件夹不会出现在git status
命令的输出中。
然而,有时候我们可能想要查看被忽略的文件和文件夹的状态,以确保我们的.gitignore
文件配置正确。这时就可以使用git status --ignored
命令。
以下是一个示例输出:
On branch master
Your branch is up to date with 'origin/master'.
Changes not staged for commit:
(use "git add <file>..." to update what will be committed)
(use "git restore <file>..." to discard changes in working directory)
modified: index.html
Ignored files:
(use "git add -f <file>..." to include in what will be committed)
ignored_file.txt
ignored_folder/
no changes added to commit (use "git add" and/or "git commit -a")
在上面的示例中,index.html
文件被修改但未暂存,而ignored_file.txt
和ignored_folder/
被.gitignore
文件忽略。
git check-ignore -v <file>(用于检查指定文件是否被Git忽略,并显示忽略规则的详细信息)
git check-ignore -v <file>
命令用于检查指定文件是否被Git忽略,并显示忽略规则的详细信息。
当我们在使用.gitignore
文件或其他忽略规则时,有时候我们想要验证某个文件是否被正确地忽略。这时就可以使用git check-ignore -v <file>
命令。
以下是一个示例输出:
.gitignore:3:ignored_file.txt ignored_file.txt
在上面的示例中,.gitignore
文件的第3行规则忽略了ignored_file.txt
文件,并且git check-ignore -v
命令显示了这个信息。
如果文件没有被忽略,那么该命令将不会有任何输出。
这个命令对于调试和验证忽略规则非常有用,可以帮助我们确保文件被正确地忽略。
答疑
关于“否定模式!中,被先前模式排除的任何匹配文件将重新包含。如果排除了文件的父目录,则无法重新包含该文件”
看一个示例:
我的/test/test/
中有a.txt
和b.txt
两个文件(/test/test/
与.gitignore
同级)
模式1:
/*
!/test/test/
# !/test/
/test/test/*
!/test/test/a.txt
结果:
模式2:
/*
# !/test/test/
!/test/
/test/test/*
!/test/test/a.txt
结果:
就是说,在这个示例中,用/*
排除了所有文件后,如果想恢复一个目录或者目录中的文件,一定要先恢复与/*
同级下的这个目录或文件的最终父目录,在这个示例中是/test/
目录,可以看到,恢复/test/test/
是没有效果的。
如何取消已跟踪的文件?
比如已经有一些大文件已经被跟踪了,但是我们不想跟踪了,想在下一次提交的时候排除掉怎么办?
可以用:
git rm --cached <文件名/目录>
或者用通配符:
git rm --cached *.txt
或者用递归目录方式:
git rm --cached -r <文件夹路径>
示例
执行git rm --cached *.tar
取消所有.tar
文件的跟踪:
在.gitignore
中增加一个*.tar
:
执行git status --ignored
查看,发现文件被取消跟踪了,那我们下次提交的时候,就不会把这些二文件提交上去了:
在gitignore中增加忽略的项目后,如何删除云上仓库中相应的项目
.gitignore 文件用于告诉 Git 哪些文件或目录不应该被提交到 Git 仓库。然而,如果你在设置 .gitignore 后想从云上的仓库中删除某个文件夹,你需要手动进行这个操作。
.gitignore 不会自动从远程仓库删除任何文件或目录。它只是忽略了本地的一些文件或目录,防止它们被提交到远程仓库。
所以,如果你希望删除云端(远程仓库)的文件夹,你需要首先在本地删除那个文件夹,然后提交这次改动,并推送到远程仓库。如此,云上的文件夹才会被删除。
步骤如下:
- 删除本地的文件夹:
rm -rf foldername/
- 将删除操作添加到暂存区:
git add .
- 提交这次改动:
git commit -m "remove foldername"
- 推送到远程仓库:
git push origin master
(假设你正在主分支上工作)
注意,以上步骤会永久性地删除文件和文件夹。在执行前,请确保你真的不再需要这些文件和文件夹。
参考文章
https://git-scm.com/docs/gitignore
.gitignore文件作用及使用方法详解文章来源:https://www.toymoban.com/news/detail-715528.html
Git – Ignore命令文章来源地址https://www.toymoban.com/news/detail-715528.html
到了这里,关于gitignore文件使用方法(gitignore教程)(git status --ignored)(git check-ignore -v <file>)的文章就介绍完了。如果您还想了解更多内容,请在右上角搜索TOY模板网以前的文章或继续浏览下面的相关文章,希望大家以后多多支持TOY模板网!