Documentation/gitignore.txt

   1 gitignore(5)
   2 ============
   3
   4 NAME
   5 ----
   6 gitignore - Specifies intentionally untracked files to ignore
   7
   8 SYNOPSIS
   9 --------
  10 $GIT_DIR/info/exclude, .gitignore
  11
  12 DESCRIPTION
  13 -----------
  14
  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.
  19
  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):
  25
  26  * Patterns read from the command line for those commands that support
  27    them.
  28
  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.
  37
  38  * Patterns read from `$GIT_DIR/info/exclude`.
  39
  40  * Patterns read from the file specified by the configuration
  41    variable 'core.excludesfile'.
  42
  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.
  56
  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.
  63
  64 PATTERN FORMAT
  65 --------------
  66
  67  - A blank line matches no files, so it can serve as a separator
  68    for readability.
  69
  70  - A line starting with # serves as a comment.
  71    Put a backslash ("`\`") in front of the first hash for patterns
  72    that begin with a hash.
  73
  74  - An optional prefix "`!`" which negates the pattern; any
  75    matching file excluded by a previous pattern will become
  76    included again.  If a negated pattern matches, this will
  77    override lower precedence patterns sources.
  78    Put a backslash ("`\`") in front of the first "`!`" for patterns
  79    that begin with a literal "`!`", for example, "`\!important!.txt`".
  80
  81  - If the pattern ends with a slash, it is removed for the
  82    purpose of the following description, but it would only find
  83    a match with a directory.  In other words, `foo/` will match a
  84    directory `foo` and paths underneath it, but will not match a
  85    regular file or a symbolic link `foo` (this is consistent
  86    with the way how pathspec works in general in git).
  87
  88  - If the pattern does not contain a slash '/', git treats it as
  89    a shell glob pattern and checks for a match against the
  90    pathname relative to the location of the `.gitignore` file
  91    (relative to the toplevel of the work tree if not from a
  92    `.gitignore` file).
  93
  94  - Otherwise, git treats the pattern as a shell glob suitable
  95    for consumption by fnmatch(3) with the FNM_PATHNAME flag:
  96    wildcards in the pattern will not match a / in the pathname.
  97    For example, "Documentation/{asterisk}.html" matches
  98    "Documentation/git.html" but not "Documentation/ppc/ppc.html"
  99    or "tools/perf/Documentation/perf.html".
 100
 101  - A leading slash matches the beginning of the pathname.
 102    For example, "/{asterisk}.c" matches "cat-file.c" but not
 103    "mozilla-sha1/sha1.c".
 104
 105 NOTES
 106 -----
 107
 108 The purpose of gitignore files is to ensure that certain files
 109 not tracked by git remain untracked.
 110
 111 To ignore uncommitted changes in a file that is already tracked,
 112 use 'git update-index {litdd}assume-unchanged'.
 113
 114 To stop tracking a file that is currently tracked, use
 115 'git rm --cached'.
 116
 117 EXAMPLES
 118 --------
 119
 120 --------------------------------------------------------------
 121     $ git status
 122     [...]
 123     # Untracked files:
 124     [...]
 125     #       Documentation/foo.html
 126     #       Documentation/gitignore.html
 127     #       file.o
 128     #       lib.a
 129     #       src/internal.o
 130     [...]
 131     $ cat .git/info/exclude
 132     # ignore objects and archives, anywhere in the tree.
 133     *.[oa]
 134     $ cat Documentation/.gitignore
 135     # ignore generated html files,
 136     *.html
 137     # except foo.html which is maintained by hand
 138     !foo.html
 139     $ git status
 140     [...]
 141     # Untracked files:
 142     [...]
 143     #       Documentation/foo.html
 144     [...]
 145 --------------------------------------------------------------
 146
 147 Another example:
 148
 149 --------------------------------------------------------------
 150     $ cat .gitignore
 151     vmlinux*
 152     $ ls arch/foo/kernel/vm*
 153     arch/foo/kernel/vmlinux.lds.S
 154     $ echo '!/vmlinux*' >arch/foo/kernel/.gitignore
 155 --------------------------------------------------------------
 156
 157 The second .gitignore prevents git from ignoring
 158 `arch/foo/kernel/vmlinux.lds.S`.
 159
 160 SEE ALSO
 161 --------
 162 linkgit:git-rm[1], linkgit:git-update-index[1],
 163 linkgit:gitrepository-layout[5]
 164
 165 GIT
 166 ---
 167 Part of the linkgit:git[1] suite