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