table of contents
other versions
- wheezy 1:1.7.10.4-1+wheezy3
- wheezy-backports 1:1.9.1-1~bpo70+2
- jessie 1:2.1.4-2.1+deb8u2
- jessie-backports 1:2.11.0-3~bpo8+1
- testing 1:2.11.0-3
- unstable 1:2.11.0-4
- experimental 1:2.13.1+next.20170610-1
GITIGNORE(5) | Git Manual | GITIGNORE(5) |
NAME¶
gitignore - Specifies intentionally untracked files to ignoreSYNOPSIS¶
$GIT_DIR/info/exclude, .gitignoreDESCRIPTION¶
A gitignore file specifies intentionally untracked files that git should ignore. Files already tracked by git are not affected; see the NOTES below for details.•Patterns read from the command line for
those commands that support them.
•Patterns read from a .gitignore file in
the same directory as the path, or in any parent directory, with patterns in
the higher level files (up to the toplevel of the work tree) being overridden
by those in lower level files down to the directory containing the file. These
patterns match relative to the location of the .gitignore file. A project
normally includes such .gitignore files in its repository, containing patterns
for files generated as part of the project build.
•Patterns read from
$GIT_DIR/info/exclude.
•Patterns read from the file specified
by the configuration variable core.excludesfile.
PATTERN FORMAT¶
•A blank line matches no files, so it
can serve as a separator for readability.
•A line starting with # serves as a
comment.
•An optional prefix ! which
negates the pattern; any matching file excluded by a previous pattern will
become included again. If a negated pattern matches, this will override lower
precedence patterns sources.
•If the pattern ends with a slash, it is
removed for the purpose of the following description, but it would only find a
match with a directory. In other words, foo/ will match a directory foo and
paths underneath it, but will not match a regular file or a symbolic link foo
(this is consistent with the way how pathspec works in general in git).
•If the pattern does not contain a slash
/, git treats it as a shell glob pattern and checks for a match against
the pathname relative to the location of the .gitignore file (relative to the
toplevel of the work tree if not from a .gitignore file).
•Otherwise, git treats the pattern as a
shell glob suitable for consumption by fnmatch(3) with the FNM_PATHNAME flag:
wildcards in the pattern will not match a / in the pathname. For example,
"Documentation/*.html" matches "Documentation/git.html"
but not "Documentation/ppc/ppc.html" or
"tools/perf/Documentation/perf.html".
•A leading slash matches the beginning
of the pathname. For example, "/*.c" matches "cat-file.c"
but not "mozilla-sha1/sha1.c".
NOTES¶
The purpose of gitignore files is to ensure that certain files not tracked by git remain untracked.EXAMPLES¶
$ 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 [...]
$ cat .gitignore vmlinux* $ ls arch/foo/kernel/vm* arch/foo/kernel/vmlinux.lds.S $ echo '!/vmlinux*' >arch/foo/kernel/.gitignore
SEE ALSO¶
git-rm(1), git-update-index(1), gitrepository-layout(5)GIT¶
Part of the git(1) suite03/19/2016 | Git 1.7.10.4 |