Merge branch 'cb/maint-orphan-merge-noclobber'
[git/kirr.git] / Documentation / gitignore.txt
blob7dc2e8b0bcdfb189724ef9b2204f4e624e3be589
1 gitignore(5)
2 ============
4 NAME
5 ----
6 gitignore - Specifies intentionally untracked files to ignore
8 SYNOPSIS
9 --------
10 $GIT_DIR/info/exclude, .gitignore
12 DESCRIPTION
13 -----------
15 A `gitignore` file specifies intentionally untracked files that
16 git should ignore.
17 Note that all the `gitignore` files really concern only files
18 that are not already tracked by git;
19 in order to ignore uncommitted changes in already tracked files,
20 please refer to the 'git update-index --assume-unchanged'
21 documentation.
23 Each line in a `gitignore` file specifies a pattern.
24 When deciding whether to ignore a path, git normally checks
25 `gitignore` patterns from multiple sources, with the following
26 order of precedence, from highest to lowest (within one level of
27 precedence, the last matching pattern decides the outcome):
29  * Patterns read from the command line for those commands that support
30    them.
32  * Patterns read from a `.gitignore` file in the same directory
33    as the path, or in any parent directory, with patterns in the
34    higher level files (up to the toplevel of the work tree) being overridden
35    by those in lower level files down to the directory containing the file.
36    These patterns match relative to the location of the
37    `.gitignore` file.  A project normally includes such
38    `.gitignore` files in its repository, containing patterns for
39    files generated as part of the project build.
41  * Patterns read from `$GIT_DIR/info/exclude`.
43  * Patterns read from the file specified by the configuration
44    variable 'core.excludesfile'.
46 Which file to place a pattern in depends on how the pattern is meant to
47 be used. Patterns which should be version-controlled and distributed to
48 other repositories via clone (i.e., files that all developers will want
49 to ignore) should go into a `.gitignore` file. Patterns which are
50 specific to a particular repository but which do not need to be shared
51 with other related repositories (e.g., auxiliary files that live inside
52 the repository but are specific to one user's workflow) should go into
53 the `$GIT_DIR/info/exclude` file.  Patterns which a user wants git to
54 ignore in all situations (e.g., backup or temporary files generated by
55 the user's editor of choice) generally go into a file specified by
56 `core.excludesfile` in the user's `~/.gitconfig`.
58 The underlying git plumbing tools, such as
59 'git ls-files' and 'git read-tree', read
60 `gitignore` patterns specified by command-line options, or from
61 files specified by command-line options.  Higher-level git
62 tools, such as 'git status' and 'git add',
63 use patterns from the sources specified above.
65 Patterns have the following format:
67  - A blank line matches no files, so it can serve as a separator
68    for readability.
70  - A line starting with # serves as a comment.
72  - An optional prefix '!' which negates the pattern; any
73    matching file excluded by a previous pattern will become
74    included again.  If a negated pattern matches, this will
75    override lower precedence patterns sources.
77  - If the pattern ends with a slash, it is removed for the
78    purpose of the following description, but it would only find
79    a match with a directory.  In other words, `foo/` will match a
80    directory `foo` and paths underneath it, but will not match a
81    regular file or a symbolic link `foo` (this is consistent
82    with the way how pathspec works in general in git).
84  - If the pattern does not contain a slash '/', git treats it as
85    a shell glob pattern and checks for a match against the
86    pathname relative to the location of the `.gitignore` file
87    (relative to the toplevel of the work tree if not from a
88    `.gitignore` file).
90  - Otherwise, git treats the pattern as a shell glob suitable
91    for consumption by fnmatch(3) with the FNM_PATHNAME flag:
92    wildcards in the pattern will not match a / in the pathname.
93    For example, "Documentation/{asterisk}.html" matches
94    "Documentation/git.html" but not "Documentation/ppc/ppc.html"
95    or "tools/perf/Documentation/perf.html".
97  - A leading slash matches the beginning of the pathname.
98    For example, "/{asterisk}.c" matches "cat-file.c" but not
99    "mozilla-sha1/sha1.c".
101 An example:
103 --------------------------------------------------------------
104     $ git status
105     [...]
106     # Untracked files:
107     [...]
108     #       Documentation/foo.html
109     #       Documentation/gitignore.html
110     #       file.o
111     #       lib.a
112     #       src/internal.o
113     [...]
114     $ cat .git/info/exclude
115     # ignore objects and archives, anywhere in the tree.
116     *.[oa]
117     $ cat Documentation/.gitignore
118     # ignore generated html files,
119     *.html
120     # except foo.html which is maintained by hand
121     !foo.html
122     $ git status
123     [...]
124     # Untracked files:
125     [...]
126     #       Documentation/foo.html
127     [...]
128 --------------------------------------------------------------
130 Another example:
132 --------------------------------------------------------------
133     $ cat .gitignore
134     vmlinux*
135     $ ls arch/foo/kernel/vm*
136     arch/foo/kernel/vmlinux.lds.S
137     $ echo '!/vmlinux*' >arch/foo/kernel/.gitignore
138 --------------------------------------------------------------
140 The second .gitignore prevents git from ignoring
141 `arch/foo/kernel/vmlinux.lds.S`.
143 Documentation
144 -------------
145 Documentation by David Greaves, Junio C Hamano, Josh Triplett,
146 Frank Lichtenheld, and the git-list <git@vger.kernel.org>.
150 Part of the linkgit:git[1] suite