Google Git
Sign in
chromium / external / gitster / git-htmldocs / 98c882d1c4c1d32487bb11a3ba40f66f34b764e4 / . / git-check-ignore.html
blob: 0b792ee81e53969fbe616d7eaf0e211bbae4d0d8 [file] [log] [blame]
Junio C Hamano944ce252018-05-30 22:25:26[diff] [blame]1<?xml version="1.0" encoding="UTF-8"?>
Junio C Hamano36d52292013-01-25 21:32:36[diff] [blame]2<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
3 "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
4<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
5<head>
6<meta http-equiv="Content-Type" content="application/xhtml+xml; charset=UTF-8" />
Junio C Hamano98c882d2020-08-13 22:06:57[diff] [blame^]7<meta name="generator" content="AsciiDoc 9.0.0rc2" />
Junio C Hamano36d52292013-01-25 21:32:36[diff] [blame]8<title>git-check-ignore(1)</title>
9<style type="text/css">
10/* Shared CSS for AsciiDoc xhtml11 and html5 backends */
11
12/* Default font. */
13body {
14 font-family: Georgia,serif;
15}
16
17/* Title font. */
18h1, h2, h3, h4, h5, h6,
19div.title, caption.title,
20thead, p.table.header,
21#toctitle,
22#author, #revnumber, #revdate, #revremark,
23#footer {
24 font-family: Arial,Helvetica,sans-serif;
25}
26
27body {
28 margin: 1em 5% 1em 5%;
29}
30
31a {
32 color: blue;
33 text-decoration: underline;
34}
35a:visited {
36 color: fuchsia;
37}
38
39em {
40 font-style: italic;
41 color: navy;
42}
43
44strong {
45 font-weight: bold;
46 color: #083194;
47}
48
49h1, h2, h3, h4, h5, h6 {
50 color: #527bbd;
51 margin-top: 1.2em;
52 margin-bottom: 0.5em;
53 line-height: 1.3;
54}
55
56h1, h2, h3 {
57 border-bottom: 2px solid silver;
58}
59h2 {
60 padding-top: 0.5em;
61}
62h3 {
63 float: left;
64}
65h3 + * {
66 clear: left;
67}
68h5 {
69 font-size: 1.0em;
70}
71
72div.sectionbody {
73 margin-left: 0;
74}
75
76hr {
77 border: 1px solid silver;
78}
79
80p {
81 margin-top: 0.5em;
82 margin-bottom: 0.5em;
83}
84
85ul, ol, li > p {
86 margin-top: 0;
87}
88ul > li { color: #aaa; }
89ul > li > * { color: black; }
90
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]91.monospaced, code, pre {
92 font-family: "Courier New", Courier, monospace;
93 font-size: inherit;
94 color: navy;
Junio C Hamano36d52292013-01-25 21:32:36[diff] [blame]95 padding: 0;
96 margin: 0;
97}
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]98pre {
99 white-space: pre-wrap;
100}
Junio C Hamano36d52292013-01-25 21:32:36[diff] [blame]101
Junio C Hamano36d52292013-01-25 21:32:36[diff] [blame]102#author {
103 color: #527bbd;
104 font-weight: bold;
105 font-size: 1.1em;
106}
107#email {
108}
109#revnumber, #revdate, #revremark {
110}
111
112#footer {
113 font-size: small;
114 border-top: 2px solid silver;
115 padding-top: 0.5em;
116 margin-top: 4.0em;
117}
118#footer-text {
119 float: left;
120 padding-bottom: 0.5em;
121}
122#footer-badges {
123 float: right;
124 padding-bottom: 0.5em;
125}
126
127#preamble {
128 margin-top: 1.5em;
129 margin-bottom: 1.5em;
130}
131div.imageblock, div.exampleblock, div.verseblock,
132div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
133div.admonitionblock {
134 margin-top: 1.0em;
135 margin-bottom: 1.5em;
136}
137div.admonitionblock {
138 margin-top: 2.0em;
139 margin-bottom: 2.0em;
140 margin-right: 10%;
141 color: #606060;
142}
143
144div.content { /* Block element content. */
145 padding: 0;
146}
147
148/* Block element titles. */
149div.title, caption.title {
150 color: #527bbd;
151 font-weight: bold;
152 text-align: left;
153 margin-top: 1.0em;
154 margin-bottom: 0.5em;
155}
156div.title + * {
157 margin-top: 0;
158}
159
160td div.title:first-child {
161 margin-top: 0.0em;
162}
163div.content div.title:first-child {
164 margin-top: 0.0em;
165}
166div.content + div.title {
167 margin-top: 0.0em;
168}
169
170div.sidebarblock > div.content {
171 background: #ffffee;
172 border: 1px solid #dddddd;
173 border-left: 4px solid #f0f0f0;
174 padding: 0.5em;
175}
176
177div.listingblock > div.content {
178 border: 1px solid #dddddd;
179 border-left: 5px solid #f0f0f0;
180 background: #f8f8f8;
181 padding: 0.5em;
182}
183
184div.quoteblock, div.verseblock {
185 padding-left: 1.0em;
186 margin-left: 1.0em;
187 margin-right: 10%;
188 border-left: 5px solid #f0f0f0;
189 color: #888;
190}
191
192div.quoteblock > div.attribution {
193 padding-top: 0.5em;
194 text-align: right;
195}
196
197div.verseblock > pre.content {
198 font-family: inherit;
199 font-size: inherit;
200}
201div.verseblock > div.attribution {
202 padding-top: 0.75em;
203 text-align: left;
204}
205/* DEPRECATED: Pre version 8.2.7 verse style literal block. */
206div.verseblock + div.attribution {
207 text-align: left;
208}
209
210div.admonitionblock .icon {
211 vertical-align: top;
212 font-size: 1.1em;
213 font-weight: bold;
214 text-decoration: underline;
215 color: #527bbd;
216 padding-right: 0.5em;
217}
218div.admonitionblock td.content {
219 padding-left: 0.5em;
220 border-left: 3px solid #dddddd;
221}
222
223div.exampleblock > div.content {
224 border-left: 3px solid #dddddd;
225 padding-left: 0.5em;
226}
227
228div.imageblock div.content { padding-left: 0; }
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]229span.image img { border-style: none; vertical-align: text-bottom; }
Junio C Hamano36d52292013-01-25 21:32:36[diff] [blame]230a.image:visited { color: white; }
231
232dl {
233 margin-top: 0.8em;
234 margin-bottom: 0.8em;
235}
236dt {
237 margin-top: 0.5em;
238 margin-bottom: 0;
239 font-style: normal;
240 color: navy;
241}
242dd > *:first-child {
243 margin-top: 0.1em;
244}
245
246ul, ol {
247 list-style-position: outside;
248}
249ol.arabic {
250 list-style-type: decimal;
251}
252ol.loweralpha {
253 list-style-type: lower-alpha;
254}
255ol.upperalpha {
256 list-style-type: upper-alpha;
257}
258ol.lowerroman {
259 list-style-type: lower-roman;
260}
261ol.upperroman {
262 list-style-type: upper-roman;
263}
264
265div.compact ul, div.compact ol,
266div.compact p, div.compact p,
267div.compact div, div.compact div {
268 margin-top: 0.1em;
269 margin-bottom: 0.1em;
270}
271
272tfoot {
273 font-weight: bold;
274}
275td > div.verse {
276 white-space: pre;
277}
278
279div.hdlist {
280 margin-top: 0.8em;
281 margin-bottom: 0.8em;
282}
283div.hdlist tr {
284 padding-bottom: 15px;
285}
286dt.hdlist1.strong, td.hdlist1.strong {
287 font-weight: bold;
288}
289td.hdlist1 {
290 vertical-align: top;
291 font-style: normal;
292 padding-right: 0.8em;
293 color: navy;
294}
295td.hdlist2 {
296 vertical-align: top;
297}
298div.hdlist.compact tr {
299 margin: 0;
300 padding-bottom: 0;
301}
302
303.comment {
304 background: yellow;
305}
306
307.footnote, .footnoteref {
308 font-size: 0.8em;
309}
310
311span.footnote, span.footnoteref {
312 vertical-align: super;
313}
314
315#footnotes {
316 margin: 20px 0 20px 0;
317 padding: 7px 0 0 0;
318}
319
320#footnotes div.footnote {
321 margin: 0 0 5px 0;
322}
323
324#footnotes hr {
325 border: none;
326 border-top: 1px solid silver;
327 height: 1px;
328 text-align: left;
329 margin-left: 0;
330 width: 20%;
331 min-width: 100px;
332}
333
334div.colist td {
335 padding-right: 0.5em;
336 padding-bottom: 0.3em;
337 vertical-align: top;
338}
339div.colist td img {
340 margin-top: 0.3em;
341}
342
343@media print {
344 #footer-badges { display: none; }
345}
346
347#toc {
348 margin-bottom: 2.5em;
349}
350
351#toctitle {
352 color: #527bbd;
353 font-size: 1.1em;
354 font-weight: bold;
355 margin-top: 1.0em;
356 margin-bottom: 0.1em;
357}
358
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]359div.toclevel0, div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
Junio C Hamano36d52292013-01-25 21:32:36[diff] [blame]360 margin-top: 0;
361 margin-bottom: 0;
362}
363div.toclevel2 {
364 margin-left: 2em;
365 font-size: 0.9em;
366}
367div.toclevel3 {
368 margin-left: 4em;
369 font-size: 0.9em;
370}
371div.toclevel4 {
372 margin-left: 6em;
373 font-size: 0.9em;
374}
375
376span.aqua { color: aqua; }
377span.black { color: black; }
378span.blue { color: blue; }
379span.fuchsia { color: fuchsia; }
380span.gray { color: gray; }
381span.green { color: green; }
382span.lime { color: lime; }
383span.maroon { color: maroon; }
384span.navy { color: navy; }
385span.olive { color: olive; }
386span.purple { color: purple; }
387span.red { color: red; }
388span.silver { color: silver; }
389span.teal { color: teal; }
390span.white { color: white; }
391span.yellow { color: yellow; }
392
393span.aqua-background { background: aqua; }
394span.black-background { background: black; }
395span.blue-background { background: blue; }
396span.fuchsia-background { background: fuchsia; }
397span.gray-background { background: gray; }
398span.green-background { background: green; }
399span.lime-background { background: lime; }
400span.maroon-background { background: maroon; }
401span.navy-background { background: navy; }
402span.olive-background { background: olive; }
403span.purple-background { background: purple; }
404span.red-background { background: red; }
405span.silver-background { background: silver; }
406span.teal-background { background: teal; }
407span.white-background { background: white; }
408span.yellow-background { background: yellow; }
409
410span.big { font-size: 2em; }
411span.small { font-size: 0.6em; }
412
413span.underline { text-decoration: underline; }
414span.overline { text-decoration: overline; }
415span.line-through { text-decoration: line-through; }
416
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]417div.unbreakable { page-break-inside: avoid; }
418
Junio C Hamano36d52292013-01-25 21:32:36[diff] [blame]419
420/*
421 * xhtml11 specific
422 *
423 * */
424
425div.tableblock {
426 margin-top: 1.0em;
427 margin-bottom: 1.5em;
428}
429div.tableblock > table {
430 border: 3px solid #527bbd;
431}
432thead, p.table.header {
433 font-weight: bold;
434 color: #527bbd;
435}
436p.table {
437 margin-top: 0;
438}
Junio C Hamano725b0da2020-01-22 22:02:40[diff] [blame]439/* Because the table frame attribute is overridden by CSS in most browsers. */
Junio C Hamano36d52292013-01-25 21:32:36[diff] [blame]440div.tableblock > table[frame="void"] {
441 border-style: none;
442}
443div.tableblock > table[frame="hsides"] {
444 border-left-style: none;
445 border-right-style: none;
446}
447div.tableblock > table[frame="vsides"] {
448 border-top-style: none;
449 border-bottom-style: none;
450}
451
452
453/*
454 * html5 specific
455 *
456 * */
457
458table.tableblock {
459 margin-top: 1.0em;
460 margin-bottom: 1.5em;
461}
462thead, p.tableblock.header {
463 font-weight: bold;
464 color: #527bbd;
465}
466p.tableblock {
467 margin-top: 0;
468}
469table.tableblock {
470 border-width: 3px;
471 border-spacing: 0px;
472 border-style: solid;
473 border-color: #527bbd;
474 border-collapse: collapse;
475}
476th.tableblock, td.tableblock {
477 border-width: 1px;
478 padding: 4px;
479 border-style: solid;
480 border-color: #527bbd;
481}
482
483table.tableblock.frame-topbot {
484 border-left-style: hidden;
485 border-right-style: hidden;
486}
487table.tableblock.frame-sides {
488 border-top-style: hidden;
489 border-bottom-style: hidden;
490}
491table.tableblock.frame-none {
492 border-style: hidden;
493}
494
495th.tableblock.halign-left, td.tableblock.halign-left {
496 text-align: left;
497}
498th.tableblock.halign-center, td.tableblock.halign-center {
499 text-align: center;
500}
501th.tableblock.halign-right, td.tableblock.halign-right {
502 text-align: right;
503}
504
505th.tableblock.valign-top, td.tableblock.valign-top {
506 vertical-align: top;
507}
508th.tableblock.valign-middle, td.tableblock.valign-middle {
509 vertical-align: middle;
510}
511th.tableblock.valign-bottom, td.tableblock.valign-bottom {
512 vertical-align: bottom;
513}
514
515
516/*
517 * manpage specific
518 *
519 * */
520
521body.manpage h1 {
522 padding-top: 0.5em;
523 padding-bottom: 0.5em;
524 border-top: 2px solid silver;
525 border-bottom: 2px solid silver;
526}
527body.manpage h2 {
528 border-style: none;
529}
530body.manpage div.sectionbody {
531 margin-left: 3em;
532}
533
534@media print {
535 body.manpage div#toc { display: none; }
536}
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]537
538
Junio C Hamano36d52292013-01-25 21:32:36[diff] [blame]539</style>
540<script type="text/javascript">
541/*<![CDATA[*/
542var asciidoc = { // Namespace.
543
544/////////////////////////////////////////////////////////////////////
545// Table Of Contents generator
546/////////////////////////////////////////////////////////////////////
547
548/* Author: Mihai Bazon, September 2002
549 * http://students.infoiasi.ro/~mishoo
550 *
551 * Table Of Content generator
552 * Version: 0.4
553 *
554 * Feel free to use this script under the terms of the GNU General Public
555 * License, as long as you do not remove or alter this notice.
556 */
557
558 /* modified by Troy D. Hanson, September 2006. License: GPL */
559 /* modified by Stuart Rackham, 2006, 2009. License: GPL */
560
561// toclevels = 1..4.
562toc: function (toclevels) {
563
564 function getText(el) {
565 var text = "";
566 for (var i = el.firstChild; i != null; i = i.nextSibling) {
567 if (i.nodeType == 3 /* Node.TEXT_NODE */) // IE doesn't speak constants.
568 text += i.data;
569 else if (i.firstChild != null)
570 text += getText(i);
571 }
572 return text;
573 }
574
575 function TocEntry(el, text, toclevel) {
576 this.element = el;
577 this.text = text;
578 this.toclevel = toclevel;
579 }
580
581 function tocEntries(el, toclevels) {
582 var result = new Array;
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]583 var re = new RegExp('[hH]([1-'+(toclevels+1)+'])');
Junio C Hamano36d52292013-01-25 21:32:36[diff] [blame]584 // Function that scans the DOM tree for header elements (the DOM2
585 // nodeIterator API would be a better technique but not supported by all
586 // browsers).
587 var iterate = function (el) {
588 for (var i = el.firstChild; i != null; i = i.nextSibling) {
589 if (i.nodeType == 1 /* Node.ELEMENT_NODE */) {
590 var mo = re.exec(i.tagName);
591 if (mo && (i.getAttribute("class") || i.getAttribute("className")) != "float") {
592 result[result.length] = new TocEntry(i, getText(i), mo[1]-1);
593 }
594 iterate(i);
595 }
596 }
597 }
598 iterate(el);
599 return result;
600 }
601
602 var toc = document.getElementById("toc");
603 if (!toc) {
604 return;
605 }
606
607 // Delete existing TOC entries in case we're reloading the TOC.
608 var tocEntriesToRemove = [];
609 var i;
610 for (i = 0; i < toc.childNodes.length; i++) {
611 var entry = toc.childNodes[i];
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]612 if (entry.nodeName.toLowerCase() == 'div'
Junio C Hamano36d52292013-01-25 21:32:36[diff] [blame]613 && entry.getAttribute("class")
614 && entry.getAttribute("class").match(/^toclevel/))
615 tocEntriesToRemove.push(entry);
616 }
617 for (i = 0; i < tocEntriesToRemove.length; i++) {
618 toc.removeChild(tocEntriesToRemove[i]);
619 }
620
621 // Rebuild TOC entries.
622 var entries = tocEntries(document.getElementById("content"), toclevels);
623 for (var i = 0; i < entries.length; ++i) {
624 var entry = entries[i];
625 if (entry.element.id == "")
626 entry.element.id = "_toc_" + i;
627 var a = document.createElement("a");
628 a.href = "#" + entry.element.id;
629 a.appendChild(document.createTextNode(entry.text));
630 var div = document.createElement("div");
631 div.appendChild(a);
632 div.className = "toclevel" + entry.toclevel;
633 toc.appendChild(div);
634 }
635 if (entries.length == 0)
636 toc.parentNode.removeChild(toc);
637},
638
639
640/////////////////////////////////////////////////////////////////////
641// Footnotes generator
642/////////////////////////////////////////////////////////////////////
643
644/* Based on footnote generation code from:
645 * http://www.brandspankingnew.net/archive/2005/07/format_footnote.html
646 */
647
648footnotes: function () {
649 // Delete existing footnote entries in case we're reloading the footnodes.
650 var i;
651 var noteholder = document.getElementById("footnotes");
652 if (!noteholder) {
653 return;
654 }
655 var entriesToRemove = [];
656 for (i = 0; i < noteholder.childNodes.length; i++) {
657 var entry = noteholder.childNodes[i];
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]658 if (entry.nodeName.toLowerCase() == 'div' && entry.getAttribute("class") == "footnote")
Junio C Hamano36d52292013-01-25 21:32:36[diff] [blame]659 entriesToRemove.push(entry);
660 }
661 for (i = 0; i < entriesToRemove.length; i++) {
662 noteholder.removeChild(entriesToRemove[i]);
663 }
664
665 // Rebuild footnote entries.
666 var cont = document.getElementById("content");
667 var spans = cont.getElementsByTagName("span");
668 var refs = {};
669 var n = 0;
670 for (i=0; i<spans.length; i++) {
671 if (spans[i].className == "footnote") {
672 n++;
673 var note = spans[i].getAttribute("data-note");
674 if (!note) {
675 // Use [\s\S] in place of . so multi-line matches work.
676 // Because JavaScript has no s (dotall) regex flag.
677 note = spans[i].innerHTML.match(/\s*\[([\s\S]*)]\s*/)[1];
678 spans[i].innerHTML =
679 "[<a id='_footnoteref_" + n + "' href='#_footnote_" + n +
680 "' title='View footnote' class='footnote'>" + n + "</a>]";
681 spans[i].setAttribute("data-note", note);
682 }
683 noteholder.innerHTML +=
684 "<div class='footnote' id='_footnote_" + n + "'>" +
685 "<a href='#_footnoteref_" + n + "' title='Return to text'>" +
686 n + "</a>. " + note + "</div>";
687 var id =spans[i].getAttribute("id");
688 if (id != null) refs["#"+id] = n;
689 }
690 }
691 if (n == 0)
692 noteholder.parentNode.removeChild(noteholder);
693 else {
694 // Process footnoterefs.
695 for (i=0; i<spans.length; i++) {
696 if (spans[i].className == "footnoteref") {
697 var href = spans[i].getElementsByTagName("a")[0].getAttribute("href");
698 href = href.match(/#.*/)[0]; // Because IE return full URL.
699 n = refs[href];
700 spans[i].innerHTML =
701 "[<a href='#_footnote_" + n +
702 "' title='View footnote' class='footnote'>" + n + "</a>]";
703 }
704 }
705 }
706},
707
708install: function(toclevels) {
709 var timerId;
710
711 function reinstall() {
712 asciidoc.footnotes();
713 if (toclevels) {
714 asciidoc.toc(toclevels);
715 }
716 }
717
718 function reinstallAndRemoveTimer() {
719 clearInterval(timerId);
720 reinstall();
721 }
722
723 timerId = setInterval(reinstall, 500);
724 if (document.addEventListener)
725 document.addEventListener("DOMContentLoaded", reinstallAndRemoveTimer, false);
726 else
727 window.onload = reinstallAndRemoveTimer;
728}
729
730}
731asciidoc.install();
732/*]]>*/
733</script>
734</head>
735<body class="manpage">
736<div id="header">
737<h1>
738git-check-ignore(1) Manual Page
739</h1>
740<h2>NAME</h2>
741<div class="sectionbody">
742<p>git-check-ignore -
743 Debug gitignore / exclude files
744</p>
745</div>
746</div>
747<div id="content">
748<div class="sect1">
749<h2 id="_synopsis">SYNOPSIS</h2>
750<div class="sectionbody">
751<div class="verseblock">
Junio C Hamanoc9cb5172018-06-01 07:13:44[diff] [blame]752<pre class="content"><em>git check-ignore</em> [&lt;options&gt;] &lt;pathname&gt;&#8230;
753<em>git check-ignore</em> [&lt;options&gt;] --stdin</pre>
Junio C Hamano36d52292013-01-25 21:32:36[diff] [blame]754<div class="attribution">
755</div></div>
756</div>
757</div>
758<div class="sect1">
759<h2 id="_description">DESCRIPTION</h2>
760<div class="sectionbody">
761<div class="paragraph"><p>For each pathname given via the command-line or from a file via
Junio C Hamano713eded2015-12-03 00:24:02[diff] [blame]762<code>--stdin</code>, check whether the file is excluded by .gitignore (or other
763input files to the exclude mechanism) and output the path if it is
764excluded.</p></div>
Junio C Hamano6df93d92014-12-22 22:48:09[diff] [blame]765<div class="paragraph"><p>By default, tracked files are not shown at all since they are not
766subject to exclude rules; but see &#8216;--no-index&#8217;.</p></div>
Junio C Hamano36d52292013-01-25 21:32:36[diff] [blame]767</div>
768</div>
769<div class="sect1">
770<h2 id="_options">OPTIONS</h2>
771<div class="sectionbody">
772<div class="dlist"><dl>
773<dt class="hdlist1">
774-q, --quiet
775</dt>
776<dd>
777<p>
778 Don&#8217;t output anything, just set exit status. This is only
779 valid with a single pathname.
780</p>
781</dd>
782<dt class="hdlist1">
783-v, --verbose
784</dt>
785<dd>
786<p>
Junio C Hamano03f8f072020-03-02 23:36:12[diff] [blame]787 Instead of printing the paths that are excluded, for each path
788 that matches an exclude pattern, print the exclude pattern
789 together with the path. (Matching an exclude pattern usually
790 means the path is excluded, but if the pattern begins with <em>!</em>
791 then it is a negated pattern and matching it means the path is
792 NOT excluded.)
Junio C Hamano36d52292013-01-25 21:32:36[diff] [blame]793</p>
Junio C Hamano03f8f072020-03-02 23:36:12[diff] [blame]794<div class="paragraph"><p>For precedence rules within and between exclude sources, see
795<a href="gitignore.html">gitignore(5)</a>.</p></div>
Junio C Hamano36d52292013-01-25 21:32:36[diff] [blame]796</dd>
797<dt class="hdlist1">
798--stdin
799</dt>
800<dd>
801<p>
Junio C Hamanodaf0aae2015-10-26 23:14:30[diff] [blame]802 Read pathnames from the standard input, one per line,
803 instead of from the command-line.
Junio C Hamano36d52292013-01-25 21:32:36[diff] [blame]804</p>
805</dd>
806<dt class="hdlist1">
807-z
808</dt>
809<dd>
810<p>
Junio C Hamano8ef91f32019-12-01 22:58:27[diff] [blame]811 The output format is modified to be machine-parsable (see
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]812 below). If <code>--stdin</code> is also given, input paths are separated
Junio C Hamano36d52292013-01-25 21:32:36[diff] [blame]813 with a NUL character instead of a linefeed character.
814</p>
815</dd>
Junio C Hamanoc7102962013-05-29 23:57:17[diff] [blame]816<dt class="hdlist1">
817-n, --non-matching
818</dt>
819<dd>
820<p>
821 Show given paths which don&#8217;t match any pattern. This only
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]822 makes sense when <code>--verbose</code> is enabled, otherwise it would
Junio C Hamanoc7102962013-05-29 23:57:17[diff] [blame]823 not be possible to distinguish between paths which match a
824 pattern and those which don&#8217;t.
825</p>
826</dd>
Junio C Hamano79f4c7c2013-09-20 21:03:37[diff] [blame]827<dt class="hdlist1">
828--no-index
829</dt>
830<dd>
831<p>
832 Don&#8217;t look in the index when undertaking the checks. This can
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]833 be used to debug why a path became tracked by e.g. <code>git add .</code>
Junio C Hamano79f4c7c2013-09-20 21:03:37[diff] [blame]834 and was not ignored by the rules as expected by the user or when
835 developing patterns including negation to match a path previously
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]836 added with <code>git add -f</code>.
Junio C Hamano79f4c7c2013-09-20 21:03:37[diff] [blame]837</p>
838</dd>
Junio C Hamano36d52292013-01-25 21:32:36[diff] [blame]839</dl></div>
840</div>
841</div>
842<div class="sect1">
843<h2 id="_output">OUTPUT</h2>
844<div class="sectionbody">
845<div class="paragraph"><p>By default, any of the given pathnames which match an ignore pattern
846will be output, one per line. If no pattern matches a given path,
847nothing will be output for that path; this means that path will not be
848ignored.</p></div>
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]849<div class="paragraph"><p>If <code>--verbose</code> is specified, the output is a series of lines of the form:</p></div>
Junio C Hamano36d52292013-01-25 21:32:36[diff] [blame]850<div class="paragraph"><p>&lt;source&gt; &lt;COLON&gt; &lt;linenum&gt; &lt;COLON&gt; &lt;pattern&gt; &lt;HT&gt; &lt;pathname&gt;</p></div>
851<div class="paragraph"><p>&lt;pathname&gt; is the path of a file being queried, &lt;pattern&gt; is the
852matching pattern, &lt;source&gt; is the pattern&#8217;s source file, and &lt;linenum&gt;
853is the line number of the pattern within that source. If the pattern
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]854contained a <code>!</code> prefix or <code>/</code> suffix, it will be preserved in the
Junio C Hamano36d52292013-01-25 21:32:36[diff] [blame]855output. &lt;source&gt; will be an absolute path when referring to the file
Junio C Hamano322c6242015-03-23 21:32:46[diff] [blame]856configured by <code>core.excludesFile</code>, or relative to the repository root
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]857when referring to <code>.git/info/exclude</code> or a per-directory exclude file.</p></div>
858<div class="paragraph"><p>If <code>-z</code> is specified, the pathnames in the output are delimited by the
859null character; if <code>--verbose</code> is also specified then null characters
Junio C Hamano36d52292013-01-25 21:32:36[diff] [blame]860are also used instead of colons and hard tabs:</p></div>
861<div class="paragraph"><p>&lt;source&gt; &lt;NULL&gt; &lt;linenum&gt; &lt;NULL&gt; &lt;pattern&gt; &lt;NULL&gt; &lt;pathname&gt; &lt;NULL&gt;</p></div>
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]862<div class="paragraph"><p>If <code>-n</code> or <code>--non-matching</code> are specified, non-matching pathnames will
Junio C Hamanoc7102962013-05-29 23:57:17[diff] [blame]863also be output, in which case all fields in each output record except
864for &lt;pathname&gt; will be empty. This can be useful when running
865non-interactively, so that files can be incrementally streamed to
866STDIN of a long-running check-ignore process, and for each of these
867files, STDOUT will indicate whether that file matched a pattern or
868not. (Without this option, it would be impossible to tell whether the
869absence of output for a given file meant that it didn&#8217;t match any
870pattern, or that the output hadn&#8217;t been generated yet.)</p></div>
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]871<div class="paragraph"><p>Buffering happens as documented under the <code>GIT_FLUSH</code> option in
Junio C Hamanoc7102962013-05-29 23:57:17[diff] [blame]872<a href="git.html">git(1)</a>. The caller is responsible for avoiding deadlocks
873caused by overfilling an input buffer or reading from an empty output
874buffer.</p></div>
Junio C Hamano36d52292013-01-25 21:32:36[diff] [blame]875</div>
876</div>
877<div class="sect1">
878<h2 id="_exit_status">EXIT STATUS</h2>
879<div class="sectionbody">
880<div class="dlist"><dl>
881<dt class="hdlist1">
8820
883</dt>
884<dd>
885<p>
886 One or more of the provided paths is ignored.
887</p>
888</dd>
889<dt class="hdlist1">
8901
891</dt>
892<dd>
893<p>
894 None of the provided paths are ignored.
895</p>
896</dd>
897<dt class="hdlist1">
898128
899</dt>
900<dd>
901<p>
902 A fatal error was encountered.
903</p>
904</dd>
905</dl></div>
906</div>
907</div>
908<div class="sect1">
909<h2 id="_see_also">SEE ALSO</h2>
910<div class="sectionbody">
911<div class="paragraph"><p><a href="gitignore.html">gitignore(5)</a>
Junio C Hamano198b1f12016-05-17 22:27:24[diff] [blame]912<a href="git-config.html">git-config(1)</a>
Junio C Hamano7abb8752016-03-18 22:52:54[diff] [blame]913<a href="git-ls-files.html">git-ls-files(1)</a></p></div>
Junio C Hamano36d52292013-01-25 21:32:36[diff] [blame]914</div>
915</div>
916<div class="sect1">
917<h2 id="_git">GIT</h2>
918<div class="sectionbody">
919<div class="paragraph"><p>Part of the <a href="git.html">git(1)</a> suite</p></div>
920</div>
921</div>
922</div>
923<div id="footnotes"><hr /></div>
924<div id="footer">
925<div id="footer-text">
Junio C Hamano2ef0ba32018-01-26 23:13:53[diff] [blame]926Last updated
Junio C Hamano7a46cd62020-03-15 21:57:10[diff] [blame]927 2020-03-10 08:03:13 PDT
Junio C Hamano36d52292013-01-25 21:32:36[diff] [blame]928</div>
929</div>
930</body>
931</html>