OSDN Git Service

Add Git official document to help
[tortoisegit/TortoiseGitJp.git] / doc / source / en / TortoiseGit / git_doc / gitignore.html.xml
1 <?xml version="1.0" encoding="UTF-8"?>\r
2 <!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">\r
3 \r
4 <article lang="en" id="gitignore(5)">\r
5 <articleinfo>\r
6     <title>gitignore(5)</title>\r
7         <indexterm>\r
8                 <primary>gitignore(5)</primary>\r
9         </indexterm>\r
10 </articleinfo>\r
11 <simplesect id="_name">\r
12 <title>NAME</title>\r
13 <simpara>gitignore - Specifies intentionally untracked files to ignore</simpara>\r
14 </simplesect>\r
15 <simplesect id="_synopsis">\r
16 <title>SYNOPSIS</title>\r
17 <simpara>$GIT_DIR/info/exclude, .gitignore</simpara>\r
18 </simplesect>\r
19 <simplesect id="_description">\r
20 <title>DESCRIPTION</title>\r
21 <simpara>A <literal>gitignore</literal> file specifies intentionally untracked files that\r
22 git should ignore.\r
23 Note that all the <literal>gitignore</literal> files really concern only files\r
24 that are not already tracked by git;\r
25 in order to ignore uncommitted changes in already tracked files,\r
26 please refer to the <emphasis>git update-index --assume-unchanged</emphasis>\r
27 documentation.</simpara>\r
28 <simpara>Each line in a <literal>gitignore</literal> file specifies a pattern.\r
29 When deciding whether to ignore a path, git normally checks\r
30 <literal>gitignore</literal> patterns from multiple sources, with the following\r
31 order of precedence, from highest to lowest (within one level of\r
32 precedence, the last matching pattern decides the outcome):</simpara>\r
33 <itemizedlist>\r
34 <listitem>\r
35 <simpara>\r
36 Patterns read from the command line for those commands that support\r
37    them.\r
38 </simpara>\r
39 </listitem>\r
40 <listitem>\r
41 <simpara>\r
42 Patterns read from a <literal>.gitignore</literal> file in the same directory\r
43    as the path, or in any parent directory, with patterns in the\r
44    higher level files (up to the root) being overridden by those in\r
45    lower level files down to the directory containing the file.\r
46    These patterns match relative to the location of the\r
47    <literal>.gitignore</literal> file.  A project normally includes such\r
48    <literal>.gitignore</literal> files in its repository, containing patterns for\r
49    files generated as part of the project build.\r
50 </simpara>\r
51 </listitem>\r
52 <listitem>\r
53 <simpara>\r
54 Patterns read from <literal>$GIT_DIR/info/exclude</literal>.\r
55 </simpara>\r
56 </listitem>\r
57 <listitem>\r
58 <simpara>\r
59 Patterns read from the file specified by the configuration\r
60    variable <emphasis>core.excludesfile</emphasis>.\r
61 </simpara>\r
62 </listitem>\r
63 </itemizedlist>\r
64 <simpara>Which file to place a pattern in depends on how the pattern is meant to\r
65 be used. Patterns which should be version-controlled and distributed to\r
66 other repositories via clone (i.e., files that all developers will want\r
67 to ignore) should go into a <literal>.gitignore</literal> file. Patterns which are\r
68 specific to a particular repository but which do not need to be shared\r
69 with other related repositories (e.g., auxiliary files that live inside\r
70 the repository but are specific to one user&#8217;s workflow) should go into\r
71 the <literal>$GIT_DIR/info/exclude</literal> file.  Patterns which a user wants git to\r
72 ignore in all situations (e.g., backup or temporary files generated by\r
73 the user&#8217;s editor of choice) generally go into a file specified by\r
74 <literal>core.excludesfile</literal> in the user&#8217;s <literal>~/.gitconfig</literal>.</simpara>\r
75 <simpara>The underlying git plumbing tools, such as\r
76 <emphasis>git-ls-files</emphasis> and <emphasis>git-read-tree</emphasis>, read\r
77 <literal>gitignore</literal> patterns specified by command-line options, or from\r
78 files specified by command-line options.  Higher-level git\r
79 tools, such as <emphasis>git-status</emphasis> and <emphasis>git-add</emphasis>,\r
80 use patterns from the sources specified above.</simpara>\r
81 <simpara>Patterns have the following format:</simpara>\r
82 <itemizedlist>\r
83 <listitem>\r
84 <simpara>\r
85 A blank line matches no files, so it can serve as a separator\r
86    for readability.\r
87 </simpara>\r
88 </listitem>\r
89 <listitem>\r
90 <simpara>\r
91 A line starting with # serves as a comment.\r
92 </simpara>\r
93 </listitem>\r
94 <listitem>\r
95 <simpara>\r
96 An optional prefix <emphasis>!</emphasis> which negates the pattern; any\r
97    matching file excluded by a previous pattern will become\r
98    included again.  If a negated pattern matches, this will\r
99    override lower precedence patterns sources.\r
100 </simpara>\r
101 </listitem>\r
102 <listitem>\r
103 <simpara>\r
104 If the pattern ends with a slash, it is removed for the\r
105    purpose of the following description, but it would only find\r
106    a match with a directory.  In other words, <literal>foo/</literal> will match a\r
107    directory <literal>foo</literal> and paths underneath it, but will not match a\r
108    regular file or a symbolic link <literal>foo</literal> (this is consistent\r
109    with the way how pathspec works in general in git).\r
110 </simpara>\r
111 </listitem>\r
112 <listitem>\r
113 <simpara>\r
114 If the pattern does not contain a slash <emphasis>/</emphasis>, git treats it as\r
115    a shell glob pattern and checks for a match against the\r
116    pathname without leading directories.\r
117 </simpara>\r
118 </listitem>\r
119 <listitem>\r
120 <simpara>\r
121 Otherwise, git treats the pattern as a shell glob suitable\r
122    for consumption by fnmatch(3) with the FNM_PATHNAME flag:\r
123    wildcards in the pattern will not match a / in the pathname.\r
124    For example, "Documentation/*.html" matches\r
125    "Documentation/git.html" but not\r
126    "Documentation/ppc/ppc.html".  A leading slash matches the\r
127    beginning of the pathname; for example, "/*.c" matches\r
128    "cat-file.c" but not "mozilla-sha1/sha1.c".\r
129 </simpara>\r
130 </listitem>\r
131 </itemizedlist>\r
132 <simpara>An example:</simpara>\r
133 <literallayout>    $ git status\r
134     [...]\r
135     # Untracked files:\r
136     [...]\r
137     #       Documentation/foo.html\r
138     #       Documentation/gitignore.html\r
139     #       file.o\r
140     #       lib.a\r
141     #       src/internal.o\r
142     [...]\r
143     $ cat .git/info/exclude\r
144     # ignore objects and archives, anywhere in the tree.\r
145     *.[oa]\r
146     $ cat Documentation/.gitignore\r
147     # ignore generated html files,\r
148     *.html\r
149     # except foo.html which is maintained by hand\r
150     !foo.html\r
151     $ git status\r
152     [...]\r
153     # Untracked files:\r
154     [...]\r
155     #       Documentation/foo.html\r
156     [...]</literallayout>\r
157 <simpara>Another example:</simpara>\r
158 <literallayout>    $ cat .gitignore\r
159     vmlinux*\r
160     $ ls arch/foo/kernel/vm*\r
161     arch/foo/kernel/vmlinux.lds.S\r
162     $ echo '!/vmlinux*' &gt;arch/foo/kernel/.gitignore</literallayout>\r
163 <simpara>The second .gitignore prevents git from ignoring\r
164 <literal>arch/foo/kernel/vmlinux.lds.S</literal>.</simpara>\r
165 </simplesect>\r
166 <simplesect id="_documentation">\r
167 <title>Documentation</title>\r
168 <simpara>Documentation by David Greaves, Junio C Hamano, Josh Triplett,\r
169 Frank Lichtenheld, and the git-list &lt;<ulink url="mailto:git@vger.kernel.org">git@vger.kernel.org</ulink>&gt;.</simpara>\r
170 </simplesect>\r
171 <simplesect id="_git">\r
172 <title>GIT</title>\r
173 <simpara>Part of the <xref linkend="git(1)"/> suite</simpara>\r
174 </simplesect>\r
175 </article>\r