i18n: grep: mark parseopt strings for translation
[git/jnareb-git.git] / Documentation / gitignore.txt
blobc1f692a71e54e01f813d84f83eaff4a9514a27b3
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 Files already tracked by git are not affected; see the NOTES
18 below for details.
20 Each line in a `gitignore` file specifies a pattern.
21 When deciding whether to ignore a path, git normally checks
22 `gitignore` patterns from multiple sources, with the following
23 order of precedence, from highest to lowest (within one level of
24 precedence, the last matching pattern decides the outcome):
26  * Patterns read from the command line for those commands that support
27    them.
29  * Patterns read from a `.gitignore` file in the same directory
30    as the path, or in any parent directory, with patterns in the
31    higher level files (up to the toplevel of the work tree) being overridden
32    by those in lower level files down to the directory containing the file.
33    These patterns match relative to the location of the
34    `.gitignore` file.  A project normally includes such
35    `.gitignore` files in its repository, containing patterns for
36    files generated as part of the project build.
38  * Patterns read from `$GIT_DIR/info/exclude`.
40  * Patterns read from the file specified by the configuration
41    variable 'core.excludesfile'.
43 Which file to place a pattern in depends on how the pattern is meant to
44 be used. Patterns which should be version-controlled and distributed to
45 other repositories via clone (i.e., files that all developers will want
46 to ignore) should go into a `.gitignore` file. Patterns which are
47 specific to a particular repository but which do not need to be shared
48 with other related repositories (e.g., auxiliary files that live inside
49 the repository but are specific to one user's workflow) should go into
50 the `$GIT_DIR/info/exclude` file.  Patterns which a user wants git to
51 ignore in all situations (e.g., backup or temporary files generated by
52 the user's editor of choice) generally go into a file specified by
53 `core.excludesfile` in the user's `~/.gitconfig`. Its default value is
54 $XDG_CONFIG_HOME/git/ignore. If $XDG_CONFIG_HOME is either not set or empty,
55 $HOME/.config/git/ignore is used instead.
57 The underlying git plumbing tools, such as
58 'git ls-files' and 'git read-tree', read
59 `gitignore` patterns specified by command-line options, or from
60 files specified by command-line options.  Higher-level git
61 tools, such as 'git status' and 'git add',
62 use patterns from the sources specified above.
64 PATTERN FORMAT
65 --------------
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 NOTES
102 -----
104 The purpose of gitignore files is to ensure that certain files
105 not tracked by git remain untracked.
107 To ignore uncommitted changes in a file that is already tracked,
108 use 'git update-index {litdd}assume-unchanged'.
110 To stop tracking a file that is currently tracked, use
111 'git rm --cached'.
113 EXAMPLES
114 --------
116 --------------------------------------------------------------
117     $ git status
118     [...]
119     # Untracked files:
120     [...]
121     #       Documentation/foo.html
122     #       Documentation/gitignore.html
123     #       file.o
124     #       lib.a
125     #       src/internal.o
126     [...]
127     $ cat .git/info/exclude
128     # ignore objects and archives, anywhere in the tree.
129     *.[oa]
130     $ cat Documentation/.gitignore
131     # ignore generated html files,
132     *.html
133     # except foo.html which is maintained by hand
134     !foo.html
135     $ git status
136     [...]
137     # Untracked files:
138     [...]
139     #       Documentation/foo.html
140     [...]
141 --------------------------------------------------------------
143 Another example:
145 --------------------------------------------------------------
146     $ cat .gitignore
147     vmlinux*
148     $ ls arch/foo/kernel/vm*
149     arch/foo/kernel/vmlinux.lds.S
150     $ echo '!/vmlinux*' >arch/foo/kernel/.gitignore
151 --------------------------------------------------------------
153 The second .gitignore prevents git from ignoring
154 `arch/foo/kernel/vmlinux.lds.S`.
156 SEE ALSO
157 --------
158 linkgit:git-rm[1], linkgit:git-update-index[1],
159 linkgit:gitrepository-layout[5]
163 Part of the linkgit:git[1] suite