How to ignore files in git

In the project, we may encounter some files that do not need to be tracked by Git, such as binary files, log files, and temporary files generated by compilation. At this time, Git provides a method to ignore files, which can ignore these files and not perform version management on them.

In Git, the .gitignore file is used to ignore files, which can tell Git to ignore which files or directories will not be tracked in the version history. In this article, we will explain how Git ignores files.

1. Create a .gitignore file

Creating a .gitignore file is very simple. You only need to create a file named .gitignore in the project root directory. It should be noted that the contents of the .gitignore file must be set according to Git rules. Here is an example of a .gitignore file:

# 忽略所有 .a 文件
*.a

# 但是 lib.a 文件除外
!lib.a

# 仅仅忽略项目根目录下的 TODO 文件，不包括 subdir/TODO
/TODO

# 忽略 build/ 目录下的所有文件
build/

# 忽略 doc/notes.txt 文件，但不包括 doc/server/arch.txt 文件
doc/*.txt

# 忽略所有 .pdf 文件在 doc/ 目录下以及子目录下
doc/**/*.pdf

In the above example, we can see multiple ways to set up ignored files. Among them, *.a in the first line means to ignore all .a files, and !lib.a means not to ignore lib.a files. /TODO indicates that TODO files in the project root directory are ignored, but TODO files in subdirectories are not included. build/ means to ignore all files in the build/ directory, doc/*.txt means to ignore all .txt files in the doc/ directory, doc/**/* .pdf means ignore all .pdf files in the doc/ directory and subdirectories. In the .gitignore file, we can also use the # sign to indicate a comment, and the ! sign to cancel ignoring.

2. Ignore submitted files

In the project, sometimes we need to ignore certain files, but these files have been submitted to Git. At this point, if we modify the contents of the .gitignore file, these files will still be tracked in the version history. Therefore, if some committed files need to be ignored, we need to use the git rm --cached command to delete the records of these files from Git.

For example, if we need to ignore the README.md file, but this file has been tracked in the version history in Git, then we can use the following command:

git rm --cached README.md

After executing this command , the README.md file will not be deleted from the local file system, only from the Git repository. At this point, we can add the README.md file to .gitignore to successfully ignore this file.

3. Ignore folders

In Git, we can not only ignore a file, but also a folder. For example, if we need to ignore the build/ folder, then we can add the following content to the .gitignore file:

build/

In this way, all files in the build/ folder will be ignored and will not be tracked by Git version history.

4. Summary

In development projects, ignoring files is a common requirement. Git provides a .gitignore file to help us ignore files that do not need to be tracked. Through the .gitignore file, we can set rules to ignore files, ignore certain files or folders, and not perform version management on them. If you need to ignore files that have been submitted to Git, we need to use the git rm --cached command to delete the records of these files. For file management in projects, the setting of ignore files is a very useful technique.

The above is the detailed content of How to ignore files in git. For more information, please follow other related articles on the PHP Chinese website!