Autogenerated HTML docs for v1.7.7-rc2-4-g5ec82
[git/jnareb-git.git] / gitignore.html
blob674889f0c7101462870f7f7382c9182ed51c0379
1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
2 "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
3 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
4 <head>
5 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
6 <meta name="generator" content="AsciiDoc 8.5.2" />
7 <title>gitignore(5)</title>
8 <style type="text/css">
9 /* Debug borders */
10 p, li, dt, dd, div, pre, h1, h2, h3, h4, h5, h6 {
12 border: 1px solid red;
16 body {
17 margin: 1em 5% 1em 5%;
20 a {
21 color: blue;
22 text-decoration: underline;
24 a:visited {
25 color: fuchsia;
28 em {
29 font-style: italic;
30 color: navy;
33 strong {
34 font-weight: bold;
35 color: #083194;
38 tt {
39 color: navy;
42 h1, h2, h3, h4, h5, h6 {
43 color: #527bbd;
44 font-family: sans-serif;
45 margin-top: 1.2em;
46 margin-bottom: 0.5em;
47 line-height: 1.3;
50 h1, h2, h3 {
51 border-bottom: 2px solid silver;
53 h2 {
54 padding-top: 0.5em;
56 h3 {
57 float: left;
59 h3 + * {
60 clear: left;
63 div.sectionbody {
64 font-family: serif;
65 margin-left: 0;
68 hr {
69 border: 1px solid silver;
72 p {
73 margin-top: 0.5em;
74 margin-bottom: 0.5em;
77 ul, ol, li > p {
78 margin-top: 0;
81 pre {
82 padding: 0;
83 margin: 0;
86 span#author {
87 color: #527bbd;
88 font-family: sans-serif;
89 font-weight: bold;
90 font-size: 1.1em;
92 span#email {
94 span#revnumber, span#revdate, span#revremark {
95 font-family: sans-serif;
98 div#footer {
99 font-family: sans-serif;
100 font-size: small;
101 border-top: 2px solid silver;
102 padding-top: 0.5em;
103 margin-top: 4.0em;
105 div#footer-text {
106 float: left;
107 padding-bottom: 0.5em;
109 div#footer-badges {
110 float: right;
111 padding-bottom: 0.5em;
114 div#preamble {
115 margin-top: 1.5em;
116 margin-bottom: 1.5em;
118 div.tableblock, div.imageblock, div.exampleblock, div.verseblock,
119 div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
120 div.admonitionblock {
121 margin-top: 1.0em;
122 margin-bottom: 1.5em;
124 div.admonitionblock {
125 margin-top: 2.0em;
126 margin-bottom: 2.0em;
127 margin-right: 10%;
128 color: #606060;
131 div.content { /* Block element content. */
132 padding: 0;
135 /* Block element titles. */
136 div.title, caption.title {
137 color: #527bbd;
138 font-family: sans-serif;
139 font-weight: bold;
140 text-align: left;
141 margin-top: 1.0em;
142 margin-bottom: 0.5em;
144 div.title + * {
145 margin-top: 0;
148 td div.title:first-child {
149 margin-top: 0.0em;
151 div.content div.title:first-child {
152 margin-top: 0.0em;
154 div.content + div.title {
155 margin-top: 0.0em;
158 div.sidebarblock > div.content {
159 background: #ffffee;
160 border: 1px solid silver;
161 padding: 0.5em;
164 div.listingblock > div.content {
165 border: 1px solid silver;
166 background: #f4f4f4;
167 padding: 0.5em;
170 div.quoteblock, div.verseblock {
171 padding-left: 1.0em;
172 margin-left: 1.0em;
173 margin-right: 10%;
174 border-left: 5px solid #dddddd;
175 color: #777777;
178 div.quoteblock > div.attribution {
179 padding-top: 0.5em;
180 text-align: right;
183 div.verseblock > div.content {
184 white-space: pre;
186 div.verseblock > div.attribution {
187 padding-top: 0.75em;
188 text-align: left;
190 /* DEPRECATED: Pre version 8.2.7 verse style literal block. */
191 div.verseblock + div.attribution {
192 text-align: left;
195 div.admonitionblock .icon {
196 vertical-align: top;
197 font-size: 1.1em;
198 font-weight: bold;
199 text-decoration: underline;
200 color: #527bbd;
201 padding-right: 0.5em;
203 div.admonitionblock td.content {
204 padding-left: 0.5em;
205 border-left: 3px solid #dddddd;
208 div.exampleblock > div.content {
209 border-left: 3px solid #dddddd;
210 padding-left: 0.5em;
213 div.imageblock div.content { padding-left: 0; }
214 span.image img { border-style: none; }
215 a.image:visited { color: white; }
217 dl {
218 margin-top: 0.8em;
219 margin-bottom: 0.8em;
221 dt {
222 margin-top: 0.5em;
223 margin-bottom: 0;
224 font-style: normal;
225 color: navy;
227 dd > *:first-child {
228 margin-top: 0.1em;
231 ul, ol {
232 list-style-position: outside;
234 ol.arabic {
235 list-style-type: decimal;
237 ol.loweralpha {
238 list-style-type: lower-alpha;
240 ol.upperalpha {
241 list-style-type: upper-alpha;
243 ol.lowerroman {
244 list-style-type: lower-roman;
246 ol.upperroman {
247 list-style-type: upper-roman;
250 div.compact ul, div.compact ol,
251 div.compact p, div.compact p,
252 div.compact div, div.compact div {
253 margin-top: 0.1em;
254 margin-bottom: 0.1em;
257 div.tableblock > table {
258 border: 3px solid #527bbd;
260 thead, p.table.header {
261 font-family: sans-serif;
262 font-weight: bold;
264 tfoot {
265 font-weight: bold;
267 td > div.verse {
268 white-space: pre;
270 p.table {
271 margin-top: 0;
273 /* Because the table frame attribute is overriden by CSS in most browsers. */
274 div.tableblock > table[frame="void"] {
275 border-style: none;
277 div.tableblock > table[frame="hsides"] {
278 border-left-style: none;
279 border-right-style: none;
281 div.tableblock > table[frame="vsides"] {
282 border-top-style: none;
283 border-bottom-style: none;
287 div.hdlist {
288 margin-top: 0.8em;
289 margin-bottom: 0.8em;
291 div.hdlist tr {
292 padding-bottom: 15px;
294 dt.hdlist1.strong, td.hdlist1.strong {
295 font-weight: bold;
297 td.hdlist1 {
298 vertical-align: top;
299 font-style: normal;
300 padding-right: 0.8em;
301 color: navy;
303 td.hdlist2 {
304 vertical-align: top;
306 div.hdlist.compact tr {
307 margin: 0;
308 padding-bottom: 0;
311 .comment {
312 background: yellow;
315 .footnote, .footnoteref {
316 font-size: 0.8em;
319 span.footnote, span.footnoteref {
320 vertical-align: super;
323 #footnotes {
324 margin: 20px 0 20px 0;
325 padding: 7px 0 0 0;
328 #footnotes div.footnote {
329 margin: 0 0 5px 0;
332 #footnotes hr {
333 border: none;
334 border-top: 1px solid silver;
335 height: 1px;
336 text-align: left;
337 margin-left: 0;
338 width: 20%;
339 min-width: 100px;
343 @media print {
344 div#footer-badges { display: none; }
347 div#toc {
348 margin-bottom: 2.5em;
351 div#toctitle {
352 color: #527bbd;
353 font-family: sans-serif;
354 font-size: 1.1em;
355 font-weight: bold;
356 margin-top: 1.0em;
357 margin-bottom: 0.1em;
360 div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
361 margin-top: 0;
362 margin-bottom: 0;
364 div.toclevel2 {
365 margin-left: 2em;
366 font-size: 0.9em;
368 div.toclevel3 {
369 margin-left: 4em;
370 font-size: 0.9em;
372 div.toclevel4 {
373 margin-left: 6em;
374 font-size: 0.9em;
376 /* Overrides for manpage documents */
377 h1 {
378 padding-top: 0.5em;
379 padding-bottom: 0.5em;
380 border-top: 2px solid silver;
381 border-bottom: 2px solid silver;
383 h2 {
384 border-style: none;
386 div.sectionbody {
387 margin-left: 5%;
390 @media print {
391 div#toc { display: none; }
394 /* Workarounds for IE6's broken and incomplete CSS2. */
396 div.sidebar-content {
397 background: #ffffee;
398 border: 1px solid silver;
399 padding: 0.5em;
401 div.sidebar-title, div.image-title {
402 color: #527bbd;
403 font-family: sans-serif;
404 font-weight: bold;
405 margin-top: 0.0em;
406 margin-bottom: 0.5em;
409 div.listingblock div.content {
410 border: 1px solid silver;
411 background: #f4f4f4;
412 padding: 0.5em;
415 div.quoteblock-attribution {
416 padding-top: 0.5em;
417 text-align: right;
420 div.verseblock-content {
421 white-space: pre;
423 div.verseblock-attribution {
424 padding-top: 0.75em;
425 text-align: left;
428 div.exampleblock-content {
429 border-left: 3px solid #dddddd;
430 padding-left: 0.5em;
433 /* IE6 sets dynamically generated links as visited. */
434 div#toc a:visited { color: blue; }
435 </style>
436 <script type="text/javascript">
437 /*<![CDATA[*/
438 window.onload = function(){asciidoc.footnotes();}
439 var asciidoc = { // Namespace.
441 /////////////////////////////////////////////////////////////////////
442 // Table Of Contents generator
443 /////////////////////////////////////////////////////////////////////
445 /* Author: Mihai Bazon, September 2002
446 * http://students.infoiasi.ro/~mishoo
448 * Table Of Content generator
449 * Version: 0.4
451 * Feel free to use this script under the terms of the GNU General Public
452 * License, as long as you do not remove or alter this notice.
455 /* modified by Troy D. Hanson, September 2006. License: GPL */
456 /* modified by Stuart Rackham, 2006, 2009. License: GPL */
458 // toclevels = 1..4.
459 toc: function (toclevels) {
461 function getText(el) {
462 var text = "";
463 for (var i = el.firstChild; i != null; i = i.nextSibling) {
464 if (i.nodeType == 3 /* Node.TEXT_NODE */) // IE doesn't speak constants.
465 text += i.data;
466 else if (i.firstChild != null)
467 text += getText(i);
469 return text;
472 function TocEntry(el, text, toclevel) {
473 this.element = el;
474 this.text = text;
475 this.toclevel = toclevel;
478 function tocEntries(el, toclevels) {
479 var result = new Array;
480 var re = new RegExp('[hH]([2-'+(toclevels+1)+'])');
481 // Function that scans the DOM tree for header elements (the DOM2
482 // nodeIterator API would be a better technique but not supported by all
483 // browsers).
484 var iterate = function (el) {
485 for (var i = el.firstChild; i != null; i = i.nextSibling) {
486 if (i.nodeType == 1 /* Node.ELEMENT_NODE */) {
487 var mo = re.exec(i.tagName);
488 if (mo && (i.getAttribute("class") || i.getAttribute("className")) != "float") {
489 result[result.length] = new TocEntry(i, getText(i), mo[1]-1);
491 iterate(i);
495 iterate(el);
496 return result;
499 var toc = document.getElementById("toc");
500 var entries = tocEntries(document.getElementById("content"), toclevels);
501 for (var i = 0; i < entries.length; ++i) {
502 var entry = entries[i];
503 if (entry.element.id == "")
504 entry.element.id = "_toc_" + i;
505 var a = document.createElement("a");
506 a.href = "#" + entry.element.id;
507 a.appendChild(document.createTextNode(entry.text));
508 var div = document.createElement("div");
509 div.appendChild(a);
510 div.className = "toclevel" + entry.toclevel;
511 toc.appendChild(div);
513 if (entries.length == 0)
514 toc.parentNode.removeChild(toc);
518 /////////////////////////////////////////////////////////////////////
519 // Footnotes generator
520 /////////////////////////////////////////////////////////////////////
522 /* Based on footnote generation code from:
523 * http://www.brandspankingnew.net/archive/2005/07/format_footnote.html
526 footnotes: function () {
527 var cont = document.getElementById("content");
528 var noteholder = document.getElementById("footnotes");
529 var spans = cont.getElementsByTagName("span");
530 var refs = {};
531 var n = 0;
532 for (i=0; i<spans.length; i++) {
533 if (spans[i].className == "footnote") {
534 n++;
535 // Use [\s\S] in place of . so multi-line matches work.
536 // Because JavaScript has no s (dotall) regex flag.
537 note = spans[i].innerHTML.match(/\s*\[([\s\S]*)]\s*/)[1];
538 noteholder.innerHTML +=
539 "<div class='footnote' id='_footnote_" + n + "'>" +
540 "<a href='#_footnoteref_" + n + "' title='Return to text'>" +
541 n + "</a>. " + note + "</div>";
542 spans[i].innerHTML =
543 "[<a id='_footnoteref_" + n + "' href='#_footnote_" + n +
544 "' title='View footnote' class='footnote'>" + n + "</a>]";
545 var id =spans[i].getAttribute("id");
546 if (id != null) refs["#"+id] = n;
549 if (n == 0)
550 noteholder.parentNode.removeChild(noteholder);
551 else {
552 // Process footnoterefs.
553 for (i=0; i<spans.length; i++) {
554 if (spans[i].className == "footnoteref") {
555 var href = spans[i].getElementsByTagName("a")[0].getAttribute("href");
556 href = href.match(/#.*/)[0]; // Because IE return full URL.
557 n = refs[href];
558 spans[i].innerHTML =
559 "[<a href='#_footnote_" + n +
560 "' title='View footnote' class='footnote'>" + n + "</a>]";
567 /*]]>*/
568 </script>
569 </head>
570 <body>
571 <div id="header">
572 <h1>
573 gitignore(5) Manual Page
574 </h1>
575 <h2>NAME</h2>
576 <div class="sectionbody">
577 <p>gitignore -
578 Specifies intentionally untracked files to ignore
579 </p>
580 </div>
581 </div>
582 <div id="content">
583 <h2 id="_synopsis">SYNOPSIS</h2>
584 <div class="sectionbody">
585 <div class="paragraph"><p>$GIT_DIR/info/exclude, .gitignore</p></div>
586 </div>
587 <h2 id="_description">DESCRIPTION</h2>
588 <div class="sectionbody">
589 <div class="paragraph"><p>A <tt>gitignore</tt> file specifies intentionally untracked files that
590 git should ignore.
591 Files already tracked by git are not affected; see the NOTES
592 below for details.</p></div>
593 <div class="paragraph"><p>Each line in a <tt>gitignore</tt> file specifies a pattern.
594 When deciding whether to ignore a path, git normally checks
595 <tt>gitignore</tt> patterns from multiple sources, with the following
596 order of precedence, from highest to lowest (within one level of
597 precedence, the last matching pattern decides the outcome):</p></div>
598 <div class="ulist"><ul>
599 <li>
601 Patterns read from the command line for those commands that support
602 them.
603 </p>
604 </li>
605 <li>
607 Patterns read from a <tt>.gitignore</tt> file in the same directory
608 as the path, or in any parent directory, with patterns in the
609 higher level files (up to the toplevel of the work tree) being overridden
610 by those in lower level files down to the directory containing the file.
611 These patterns match relative to the location of the
612 <tt>.gitignore</tt> file. A project normally includes such
613 <tt>.gitignore</tt> files in its repository, containing patterns for
614 files generated as part of the project build.
615 </p>
616 </li>
617 <li>
619 Patterns read from <tt>$GIT_DIR/info/exclude</tt>.
620 </p>
621 </li>
622 <li>
624 Patterns read from the file specified by the configuration
625 variable <em>core.excludesfile</em>.
626 </p>
627 </li>
628 </ul></div>
629 <div class="paragraph"><p>Which file to place a pattern in depends on how the pattern is meant to
630 be used. Patterns which should be version-controlled and distributed to
631 other repositories via clone (i.e., files that all developers will want
632 to ignore) should go into a <tt>.gitignore</tt> file. Patterns which are
633 specific to a particular repository but which do not need to be shared
634 with other related repositories (e.g., auxiliary files that live inside
635 the repository but are specific to one user&#8217;s workflow) should go into
636 the <tt>$GIT_DIR/info/exclude</tt> file. Patterns which a user wants git to
637 ignore in all situations (e.g., backup or temporary files generated by
638 the user&#8217;s editor of choice) generally go into a file specified by
639 <tt>core.excludesfile</tt> in the user&#8217;s <tt>~/.gitconfig</tt>.</p></div>
640 <div class="paragraph"><p>The underlying git plumbing tools, such as
641 <em>git ls-files</em> and <em>git read-tree</em>, read
642 <tt>gitignore</tt> patterns specified by command-line options, or from
643 files specified by command-line options. Higher-level git
644 tools, such as <em>git status</em> and <em>git add</em>,
645 use patterns from the sources specified above.</p></div>
646 </div>
647 <h2 id="_pattern_format">PATTERN FORMAT</h2>
648 <div class="sectionbody">
649 <div class="ulist"><ul>
650 <li>
652 A blank line matches no files, so it can serve as a separator
653 for readability.
654 </p>
655 </li>
656 <li>
658 A line starting with # serves as a comment.
659 </p>
660 </li>
661 <li>
663 An optional prefix <em>!</em> which negates the pattern; any
664 matching file excluded by a previous pattern will become
665 included again. If a negated pattern matches, this will
666 override lower precedence patterns sources.
667 </p>
668 </li>
669 <li>
671 If the pattern ends with a slash, it is removed for the
672 purpose of the following description, but it would only find
673 a match with a directory. In other words, <tt>foo/</tt> will match a
674 directory <tt>foo</tt> and paths underneath it, but will not match a
675 regular file or a symbolic link <tt>foo</tt> (this is consistent
676 with the way how pathspec works in general in git).
677 </p>
678 </li>
679 <li>
681 If the pattern does not contain a slash <em>/</em>, git treats it as
682 a shell glob pattern and checks for a match against the
683 pathname relative to the location of the <tt>.gitignore</tt> file
684 (relative to the toplevel of the work tree if not from a
685 <tt>.gitignore</tt> file).
686 </p>
687 </li>
688 <li>
690 Otherwise, git treats the pattern as a shell glob suitable
691 for consumption by fnmatch(3) with the FNM_PATHNAME flag:
692 wildcards in the pattern will not match a / in the pathname.
693 For example, "Documentation/&#42;.html" matches
694 "Documentation/git.html" but not "Documentation/ppc/ppc.html"
695 or "tools/perf/Documentation/perf.html".
696 </p>
697 </li>
698 <li>
700 A leading slash matches the beginning of the pathname.
701 For example, "/&#42;.c" matches "cat-file.c" but not
702 "mozilla-sha1/sha1.c".
703 </p>
704 </li>
705 </ul></div>
706 </div>
707 <h2 id="_notes">NOTES</h2>
708 <div class="sectionbody">
709 <div class="paragraph"><p>The purpose of gitignore files is to ensure that certain files
710 not tracked by git remain untracked.</p></div>
711 <div class="paragraph"><p>To ignore uncommitted changes in a file that is already tracked,
712 use <em>git update-index &#45;&#45;assume-unchanged</em>.</p></div>
713 <div class="paragraph"><p>To stop tracking a file that is currently tracked, use
714 <em>git rm --cached</em>.</p></div>
715 </div>
716 <h2 id="_examples">EXAMPLES</h2>
717 <div class="sectionbody">
718 <div class="listingblock">
719 <div class="content">
720 <pre><tt> $ git status
721 [...]
722 # Untracked files:
723 [...]
724 # Documentation/foo.html
725 # Documentation/gitignore.html
726 # file.o
727 # lib.a
728 # src/internal.o
729 [...]
730 $ cat .git/info/exclude
731 # ignore objects and archives, anywhere in the tree.
732 *.[oa]
733 $ cat Documentation/.gitignore
734 # ignore generated html files,
735 *.html
736 # except foo.html which is maintained by hand
737 !foo.html
738 $ git status
739 [...]
740 # Untracked files:
741 [...]
742 # Documentation/foo.html
743 [...]</tt></pre>
744 </div></div>
745 <div class="paragraph"><p>Another example:</p></div>
746 <div class="listingblock">
747 <div class="content">
748 <pre><tt> $ cat .gitignore
749 vmlinux*
750 $ ls arch/foo/kernel/vm*
751 arch/foo/kernel/vmlinux.lds.S
752 $ echo '!/vmlinux*' &gt;arch/foo/kernel/.gitignore</tt></pre>
753 </div></div>
754 <div class="paragraph"><p>The second .gitignore prevents git from ignoring
755 <tt>arch/foo/kernel/vmlinux.lds.S</tt>.</p></div>
756 </div>
757 <h2 id="_see_also">SEE ALSO</h2>
758 <div class="sectionbody">
759 <div class="paragraph"><p><a href="git-rm.html">git-rm(1)</a>, <a href="git-update-index.html">git-update-index(1)</a>,
760 <a href="gitrepository-layout.html">gitrepository-layout(5)</a></p></div>
761 </div>
762 <h2 id="_git">GIT</h2>
763 <div class="sectionbody">
764 <div class="paragraph"><p>Part of the <a href="git.html">git(1)</a> suite</p></div>
765 </div>
766 </div>
767 <div id="footnotes"><hr /></div>
768 <div id="footer">
769 <div id="footer-text">
770 Last updated 2011-09-21 23:01:14 PDT
771 </div>
772 </div>
773 </body>
774 </html>