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">
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">
10 p
, li
, dt
, dd
, div
, pre
, h1
, h2
, h3
, h4
, h5
, h6
{
12 border: 1px solid red;
17 margin: 1em 5% 1em 5%;
22 text-decoration: underline
;
42 h1
, h2
, h3
, h4
, h5
, h6
{
44 font-family: sans-serif
;
51 border-bottom: 2px solid silver
;
69 border: 1px solid silver
;
88 font-family: sans-serif
;
94 span#revnumber
, span#revdate
, span#revremark
{
95 font-family: sans-serif
;
99 font-family: sans-serif
;
101 border-top: 2px solid silver
;
107 padding-bottom: 0.5em;
111 padding-bottom: 0.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
{
122 margin-bottom: 1.5em;
124 div
.admonitionblock
{
126 margin-bottom: 2.0em;
131 div
.content
{ /* Block element content. */
135 /* Block element titles. */
136 div
.title
, caption
.title
{
138 font-family: sans-serif
;
142 margin-bottom: 0.5em;
148 td div
.title:first-child
{
151 div
.content div
.title:first-child
{
154 div
.content
+ div
.title
{
158 div
.sidebarblock
> div
.content
{
160 border: 1px solid silver
;
164 div
.listingblock
> div
.content
{
165 border: 1px solid silver
;
170 div
.quoteblock
, div
.verseblock
{
174 border-left: 5px solid
#dddddd;
178 div
.quoteblock
> div
.attribution
{
183 div
.verseblock
> div
.content
{
186 div
.verseblock
> div
.attribution
{
190 /* DEPRECATED: Pre version 8.2.7 verse style literal block. */
191 div
.verseblock
+ div
.attribution
{
195 div
.admonitionblock
.icon
{
199 text-decoration: underline
;
201 padding-right: 0.5em;
203 div
.admonitionblock td
.content
{
205 border-left: 3px solid
#dddddd;
208 div
.exampleblock
> div
.content
{
209 border-left: 3px solid
#dddddd;
213 div
.imageblock div
.content
{ padding-left: 0; }
214 span
.image img
{ border-style: none
; }
215 a
.image:visited
{ color: white
; }
219 margin-bottom: 0.8em;
232 list-style-position: outside
;
235 list-style-type: decimal
;
238 list-style-type: lower-alpha
;
241 list-style-type: upper-alpha
;
244 list-style-type: lower-roman
;
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
{
254 margin-bottom: 0.1em;
257 div
.tableblock
> table
{
258 border: 3px solid
#527bbd;
260 thead
, p
.table
.header
{
261 font-family: sans-serif
;
273 /* Because the table frame attribute is overriden by CSS in most browsers. */
274 div
.tableblock
> table
[frame
="void"] {
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
;
289 margin-bottom: 0.8em;
292 padding-bottom: 15px;
294 dt
.hdlist1
.strong
, td
.hdlist1
.strong
{
300 padding-right: 0.8em;
306 div
.hdlist
.compact tr
{
315 .footnote, .footnoteref {
319 span
.footnote
, span
.footnoteref
{
320 vertical-align: super
;
324 margin: 20px 0 20px 0;
328 #footnotes div
.footnote
{
334 border-top: 1px solid silver
;
344 div#footer-badges
{ display: none
; }
348 margin-bottom: 2.5em;
353 font-family: sans-serif
;
357 margin-bottom: 0.1em;
360 div
.toclevel1
, div
.toclevel2
, div
.toclevel3
, div
.toclevel4
{
376 /* Overrides for manpage documents */
379 padding-bottom: 0.5em;
380 border-top: 2px solid silver
;
381 border-bottom: 2px solid silver
;
391 div#toc
{ display: none
; }
394 /* Workarounds for IE6's broken and incomplete CSS2. */
396 div
.sidebar-content
{
398 border: 1px solid silver
;
401 div
.sidebar-title
, div
.image-title
{
403 font-family: sans-serif
;
406 margin-bottom: 0.5em;
409 div
.listingblock div
.content
{
410 border: 1px solid silver
;
415 div
.quoteblock-attribution
{
420 div
.verseblock-content
{
423 div
.verseblock-attribution
{
428 div
.exampleblock-content
{
429 border-left: 3px solid
#dddddd;
433 /* IE6 sets dynamically generated links as visited. */
434 div#toc
a:visited
{ color: blue
; }
436 <script type=
"text/javascript">
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
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 */
459 toc: function (toclevels
) {
461 function getText(el
) {
463 for (var i
= el
.firstChild
; i
!= null; i
= i
.nextSibling
) {
464 if (i
.nodeType
== 3 /* Node.TEXT_NODE */) // IE doesn't speak constants.
466 else if (i
.firstChild
!= null)
472 function TocEntry(el
, text
, toclevel
) {
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
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);
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");
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");
532 for (i
=0; i
<spans
.length
; i
++) {
533 if (spans
[i
].className
== "footnote") {
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>";
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
;
550 noteholder
.parentNode
.removeChild(noteholder
);
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.
559 "[<a href='#_footnote_" + n
+
560 "' title='View footnote' class='footnote'>" + n
+ "</a>]";
573 gitignore(
5) Manual Page
576 <div class=
"sectionbody">
578 Specifies intentionally untracked files to ignore
583 <h2 id=
"_synopsis">SYNOPSIS
</h2>
584 <div class=
"sectionbody">
585 <div class=
"paragraph"><p>$GIT_DIR/info/exclude, .gitignore
</p></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
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>
601 Patterns read from the command line for those commands that support
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.
619 Patterns read from
<tt>$GIT_DIR/info/exclude
</tt>.
624 Patterns read from the file specified by the configuration
625 variable
<em>core.excludesfile
</em>.
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
’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
’s editor of choice) generally go into a file specified by
639 <tt>core.excludesfile
</tt> in the user
’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>
647 <h2 id=
"_pattern_format">PATTERN FORMAT
</h2>
648 <div class=
"sectionbody">
649 <div class=
"ulist"><ul>
652 A blank line matches no files, so it can serve as a separator
658 A line starting with # serves as a comment.
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.
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).
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).
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/*.html" matches
694 "Documentation/git.html" but not
"Documentation/ppc/ppc.html"
695 or
"tools/perf/Documentation/perf.html".
700 A leading slash matches the beginning of the pathname.
701 For example,
"/*.c" matches
"cat-file.c" but not
702 "mozilla-sha1/sha1.c".
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
--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>
716 <h2 id=
"_examples">EXAMPLES
</h2>
717 <div class=
"sectionbody">
718 <div class=
"listingblock">
719 <div class=
"content">
720 <pre><tt> $ git status
724 # Documentation/foo.html
725 # Documentation/gitignore.html
730 $ cat .git/info/exclude
731 # ignore objects and archives, anywhere in the tree.
733 $ cat Documentation/.gitignore
734 # ignore generated html files,
736 # except foo.html which is maintained by hand
742 # Documentation/foo.html
745 <div class=
"paragraph"><p>Another example:
</p></div>
746 <div class=
"listingblock">
747 <div class=
"content">
748 <pre><tt> $ cat .gitignore
750 $ ls arch/foo/kernel/vm*
751 arch/foo/kernel/vmlinux.lds.S
752 $ echo '!/vmlinux*'
>arch/foo/kernel/.gitignore
</tt></pre>
754 <div class=
"paragraph"><p>The second .gitignore prevents git from ignoring
755 <tt>arch/foo/kernel/vmlinux.lds.S
</tt>.
</p></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>
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>
767 <div id=
"footnotes"><hr /></div>
769 <div id=
"footer-text">
770 Last updated
2011-
09-
21 23:
01:
14 PDT