Google Git
Sign in
chromium / external / gitster / git-htmldocs / 076ffcc834f02a4f11d7f4fe8825be3b065020ff / . / technical / api-config.html
blob: 38340679c12b294365c5286b2312bdce1b66ab66 [file] [log] [blame]
Junio C Hamanoe0238c22012-02-23 22:45:50[diff] [blame]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>
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]5<meta http-equiv="Content-Type" content="application/xhtml+xml; charset=UTF-8" />
6<meta name="generator" content="AsciiDoc 8.6.8" />
Junio C Hamanoe0238c22012-02-23 22:45:50[diff] [blame]7<title>config API</title>
8<style type="text/css">
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]9/* Shared CSS for AsciiDoc xhtml11 and html5 backends */
10
11/* Default font. */
12body {
13 font-family: Georgia,serif;
14}
15
16/* Title font. */
17h1, h2, h3, h4, h5, h6,
18div.title, caption.title,
19thead, p.table.header,
20#toctitle,
21#author, #revnumber, #revdate, #revremark,
22#footer {
23 font-family: Arial,Helvetica,sans-serif;
Junio C Hamanoe0238c22012-02-23 22:45:50[diff] [blame]24}
25
26body {
27 margin: 1em 5% 1em 5%;
28}
29
30a {
31 color: blue;
32 text-decoration: underline;
33}
34a:visited {
35 color: fuchsia;
36}
37
38em {
39 font-style: italic;
40 color: navy;
41}
42
43strong {
44 font-weight: bold;
45 color: #083194;
46}
47
Junio C Hamanoe0238c22012-02-23 22:45:50[diff] [blame]48h1, h2, h3, h4, h5, h6 {
49 color: #527bbd;
Junio C Hamanoe0238c22012-02-23 22:45:50[diff] [blame]50 margin-top: 1.2em;
51 margin-bottom: 0.5em;
52 line-height: 1.3;
53}
54
55h1, h2, h3 {
56 border-bottom: 2px solid silver;
57}
58h2 {
59 padding-top: 0.5em;
60}
61h3 {
62 float: left;
63}
64h3 + * {
65 clear: left;
66}
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]67h5 {
68 font-size: 1.0em;
69}
Junio C Hamanoe0238c22012-02-23 22:45:50[diff] [blame]70
71div.sectionbody {
Junio C Hamanoe0238c22012-02-23 22:45:50[diff] [blame]72 margin-left: 0;
73}
74
75hr {
76 border: 1px solid silver;
77}
78
79p {
80 margin-top: 0.5em;
81 margin-bottom: 0.5em;
82}
83
84ul, ol, li > p {
85 margin-top: 0;
86}
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]87ul > li { color: #aaa; }
88ul > li > * { color: black; }
Junio C Hamanoe0238c22012-02-23 22:45:50[diff] [blame]89
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]90.monospaced, code, pre {
91 font-family: "Courier New", Courier, monospace;
92 font-size: inherit;
93 color: navy;
Junio C Hamanoe0238c22012-02-23 22:45:50[diff] [blame]94 padding: 0;
95 margin: 0;
96}
97
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]98
99#author {
Junio C Hamanoe0238c22012-02-23 22:45:50[diff] [blame]100 color: #527bbd;
Junio C Hamanoe0238c22012-02-23 22:45:50[diff] [blame]101 font-weight: bold;
102 font-size: 1.1em;
103}
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]104#email {
Junio C Hamanoe0238c22012-02-23 22:45:50[diff] [blame]105}
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]106#revnumber, #revdate, #revremark {
Junio C Hamanoe0238c22012-02-23 22:45:50[diff] [blame]107}
108
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]109#footer {
Junio C Hamanoe0238c22012-02-23 22:45:50[diff] [blame]110 font-size: small;
111 border-top: 2px solid silver;
112 padding-top: 0.5em;
113 margin-top: 4.0em;
114}
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]115#footer-text {
Junio C Hamanoe0238c22012-02-23 22:45:50[diff] [blame]116 float: left;
117 padding-bottom: 0.5em;
118}
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]119#footer-badges {
Junio C Hamanoe0238c22012-02-23 22:45:50[diff] [blame]120 float: right;
121 padding-bottom: 0.5em;
122}
123
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]124#preamble {
Junio C Hamanoe0238c22012-02-23 22:45:50[diff] [blame]125 margin-top: 1.5em;
126 margin-bottom: 1.5em;
127}
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]128div.imageblock, div.exampleblock, div.verseblock,
Junio C Hamanoe0238c22012-02-23 22:45:50[diff] [blame]129div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
130div.admonitionblock {
131 margin-top: 1.0em;
132 margin-bottom: 1.5em;
133}
134div.admonitionblock {
135 margin-top: 2.0em;
136 margin-bottom: 2.0em;
137 margin-right: 10%;
138 color: #606060;
139}
140
141div.content { /* Block element content. */
142 padding: 0;
143}
144
145/* Block element titles. */
146div.title, caption.title {
147 color: #527bbd;
Junio C Hamanoe0238c22012-02-23 22:45:50[diff] [blame]148 font-weight: bold;
149 text-align: left;
150 margin-top: 1.0em;
151 margin-bottom: 0.5em;
152}
153div.title + * {
154 margin-top: 0;
155}
156
157td div.title:first-child {
158 margin-top: 0.0em;
159}
160div.content div.title:first-child {
161 margin-top: 0.0em;
162}
163div.content + div.title {
164 margin-top: 0.0em;
165}
166
167div.sidebarblock > div.content {
168 background: #ffffee;
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]169 border: 1px solid #dddddd;
170 border-left: 4px solid #f0f0f0;
Junio C Hamanoe0238c22012-02-23 22:45:50[diff] [blame]171 padding: 0.5em;
172}
173
174div.listingblock > div.content {
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]175 border: 1px solid #dddddd;
176 border-left: 5px solid #f0f0f0;
177 background: #f8f8f8;
Junio C Hamanoe0238c22012-02-23 22:45:50[diff] [blame]178 padding: 0.5em;
179}
180
181div.quoteblock, div.verseblock {
182 padding-left: 1.0em;
183 margin-left: 1.0em;
184 margin-right: 10%;
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]185 border-left: 5px solid #f0f0f0;
186 color: #888;
Junio C Hamanoe0238c22012-02-23 22:45:50[diff] [blame]187}
188
189div.quoteblock > div.attribution {
190 padding-top: 0.5em;
191 text-align: right;
192}
193
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]194div.verseblock > pre.content {
195 font-family: inherit;
196 font-size: inherit;
Junio C Hamanoe0238c22012-02-23 22:45:50[diff] [blame]197}
198div.verseblock > div.attribution {
199 padding-top: 0.75em;
200 text-align: left;
201}
202/* DEPRECATED: Pre version 8.2.7 verse style literal block. */
203div.verseblock + div.attribution {
204 text-align: left;
205}
206
207div.admonitionblock .icon {
208 vertical-align: top;
209 font-size: 1.1em;
210 font-weight: bold;
211 text-decoration: underline;
212 color: #527bbd;
213 padding-right: 0.5em;
214}
215div.admonitionblock td.content {
216 padding-left: 0.5em;
217 border-left: 3px solid #dddddd;
218}
219
220div.exampleblock > div.content {
221 border-left: 3px solid #dddddd;
222 padding-left: 0.5em;
223}
224
225div.imageblock div.content { padding-left: 0; }
226span.image img { border-style: none; }
227a.image:visited { color: white; }
228
229dl {
230 margin-top: 0.8em;
231 margin-bottom: 0.8em;
232}
233dt {
234 margin-top: 0.5em;
235 margin-bottom: 0;
236 font-style: normal;
237 color: navy;
238}
239dd > *:first-child {
240 margin-top: 0.1em;
241}
242
243ul, ol {
244 list-style-position: outside;
245}
246ol.arabic {
247 list-style-type: decimal;
248}
249ol.loweralpha {
250 list-style-type: lower-alpha;
251}
252ol.upperalpha {
253 list-style-type: upper-alpha;
254}
255ol.lowerroman {
256 list-style-type: lower-roman;
257}
258ol.upperroman {
259 list-style-type: upper-roman;
260}
261
262div.compact ul, div.compact ol,
263div.compact p, div.compact p,
264div.compact div, div.compact div {
265 margin-top: 0.1em;
266 margin-bottom: 0.1em;
267}
268
Junio C Hamanoe0238c22012-02-23 22:45:50[diff] [blame]269tfoot {
270 font-weight: bold;
271}
272td > div.verse {
273 white-space: pre;
274}
Junio C Hamanoe0238c22012-02-23 22:45:50[diff] [blame]275
276div.hdlist {
277 margin-top: 0.8em;
278 margin-bottom: 0.8em;
279}
280div.hdlist tr {
281 padding-bottom: 15px;
282}
283dt.hdlist1.strong, td.hdlist1.strong {
284 font-weight: bold;
285}
286td.hdlist1 {
287 vertical-align: top;
288 font-style: normal;
289 padding-right: 0.8em;
290 color: navy;
291}
292td.hdlist2 {
293 vertical-align: top;
294}
295div.hdlist.compact tr {
296 margin: 0;
297 padding-bottom: 0;
298}
299
300.comment {
301 background: yellow;
302}
303
304.footnote, .footnoteref {
305 font-size: 0.8em;
306}
307
308span.footnote, span.footnoteref {
309 vertical-align: super;
310}
311
312#footnotes {
313 margin: 20px 0 20px 0;
314 padding: 7px 0 0 0;
315}
316
317#footnotes div.footnote {
318 margin: 0 0 5px 0;
319}
320
321#footnotes hr {
322 border: none;
323 border-top: 1px solid silver;
324 height: 1px;
325 text-align: left;
326 margin-left: 0;
327 width: 20%;
328 min-width: 100px;
329}
330
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]331div.colist td {
332 padding-right: 0.5em;
333 padding-bottom: 0.3em;
334 vertical-align: top;
335}
336div.colist td img {
337 margin-top: 0.3em;
Junio C Hamanoe0238c22012-02-23 22:45:50[diff] [blame]338}
339
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]340@media print {
341 #footer-badges { display: none; }
342}
343
344#toc {
Junio C Hamanoe0238c22012-02-23 22:45:50[diff] [blame]345 margin-bottom: 2.5em;
346}
347
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]348#toctitle {
Junio C Hamanoe0238c22012-02-23 22:45:50[diff] [blame]349 color: #527bbd;
Junio C Hamanoe0238c22012-02-23 22:45:50[diff] [blame]350 font-size: 1.1em;
351 font-weight: bold;
352 margin-top: 1.0em;
353 margin-bottom: 0.1em;
354}
355
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]356div.toclevel0, div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
Junio C Hamanoe0238c22012-02-23 22:45:50[diff] [blame]357 margin-top: 0;
358 margin-bottom: 0;
359}
360div.toclevel2 {
361 margin-left: 2em;
362 font-size: 0.9em;
363}
364div.toclevel3 {
365 margin-left: 4em;
366 font-size: 0.9em;
367}
368div.toclevel4 {
369 margin-left: 6em;
370 font-size: 0.9em;
371}
Junio C Hamanoe0238c22012-02-23 22:45:50[diff] [blame]372
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]373span.aqua { color: aqua; }
374span.black { color: black; }
375span.blue { color: blue; }
376span.fuchsia { color: fuchsia; }
377span.gray { color: gray; }
378span.green { color: green; }
379span.lime { color: lime; }
380span.maroon { color: maroon; }
381span.navy { color: navy; }
382span.olive { color: olive; }
383span.purple { color: purple; }
384span.red { color: red; }
385span.silver { color: silver; }
386span.teal { color: teal; }
387span.white { color: white; }
388span.yellow { color: yellow; }
389
390span.aqua-background { background: aqua; }
391span.black-background { background: black; }
392span.blue-background { background: blue; }
393span.fuchsia-background { background: fuchsia; }
394span.gray-background { background: gray; }
395span.green-background { background: green; }
396span.lime-background { background: lime; }
397span.maroon-background { background: maroon; }
398span.navy-background { background: navy; }
399span.olive-background { background: olive; }
400span.purple-background { background: purple; }
401span.red-background { background: red; }
402span.silver-background { background: silver; }
403span.teal-background { background: teal; }
404span.white-background { background: white; }
405span.yellow-background { background: yellow; }
406
407span.big { font-size: 2em; }
408span.small { font-size: 0.6em; }
409
410span.underline { text-decoration: underline; }
411span.overline { text-decoration: overline; }
412span.line-through { text-decoration: line-through; }
413
414div.unbreakable { page-break-inside: avoid; }
415
416
417/*
418 * xhtml11 specific
419 *
420 * */
421
422div.tableblock {
423 margin-top: 1.0em;
424 margin-bottom: 1.5em;
Junio C Hamanoe0238c22012-02-23 22:45:50[diff] [blame]425}
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]426div.tableblock > table {
427 border: 3px solid #527bbd;
428}
429thead, p.table.header {
Junio C Hamanoe0238c22012-02-23 22:45:50[diff] [blame]430 font-weight: bold;
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]431 color: #527bbd;
432}
433p.table {
434 margin-top: 0;
435}
436/* Because the table frame attribute is overriden by CSS in most browsers. */
437div.tableblock > table[frame="void"] {
438 border-style: none;
439}
440div.tableblock > table[frame="hsides"] {
441 border-left-style: none;
442 border-right-style: none;
443}
444div.tableblock > table[frame="vsides"] {
445 border-top-style: none;
446 border-bottom-style: none;
Junio C Hamanoe0238c22012-02-23 22:45:50[diff] [blame]447}
448
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]449
450/*
451 * html5 specific
452 *
453 * */
454
455table.tableblock {
456 margin-top: 1.0em;
457 margin-bottom: 1.5em;
458}
459thead, p.tableblock.header {
460 font-weight: bold;
461 color: #527bbd;
462}
463p.tableblock {
464 margin-top: 0;
465}
466table.tableblock {
467 border-width: 3px;
468 border-spacing: 0px;
469 border-style: solid;
470 border-color: #527bbd;
471 border-collapse: collapse;
472}
473th.tableblock, td.tableblock {
474 border-width: 1px;
475 padding: 4px;
476 border-style: solid;
477 border-color: #527bbd;
Junio C Hamanoe0238c22012-02-23 22:45:50[diff] [blame]478}
479
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]480table.tableblock.frame-topbot {
481 border-left-style: hidden;
482 border-right-style: hidden;
483}
484table.tableblock.frame-sides {
485 border-top-style: hidden;
486 border-bottom-style: hidden;
487}
488table.tableblock.frame-none {
489 border-style: hidden;
490}
491
492th.tableblock.halign-left, td.tableblock.halign-left {
493 text-align: left;
494}
495th.tableblock.halign-center, td.tableblock.halign-center {
496 text-align: center;
497}
498th.tableblock.halign-right, td.tableblock.halign-right {
Junio C Hamanoe0238c22012-02-23 22:45:50[diff] [blame]499 text-align: right;
500}
501
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]502th.tableblock.valign-top, td.tableblock.valign-top {
503 vertical-align: top;
Junio C Hamanoe0238c22012-02-23 22:45:50[diff] [blame]504}
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]505th.tableblock.valign-middle, td.tableblock.valign-middle {
506 vertical-align: middle;
507}
508th.tableblock.valign-bottom, td.tableblock.valign-bottom {
509 vertical-align: bottom;
Junio C Hamanoe0238c22012-02-23 22:45:50[diff] [blame]510}
511
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]512
513/*
514 * manpage specific
515 *
516 * */
517
518body.manpage h1 {
519 padding-top: 0.5em;
520 padding-bottom: 0.5em;
521 border-top: 2px solid silver;
522 border-bottom: 2px solid silver;
523}
524body.manpage h2 {
525 border-style: none;
526}
527body.manpage div.sectionbody {
528 margin-left: 3em;
Junio C Hamanoe0238c22012-02-23 22:45:50[diff] [blame]529}
530
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]531@media print {
532 body.manpage div#toc { display: none; }
533}
534
535
Junio C Hamanoe0238c22012-02-23 22:45:50[diff] [blame]536</style>
537<script type="text/javascript">
538/*<![CDATA[*/
Junio C Hamanoe0238c22012-02-23 22:45:50[diff] [blame]539var asciidoc = { // Namespace.
540
541/////////////////////////////////////////////////////////////////////
542// Table Of Contents generator
543/////////////////////////////////////////////////////////////////////
544
545/* Author: Mihai Bazon, September 2002
546 * http://students.infoiasi.ro/~mishoo
547 *
548 * Table Of Content generator
549 * Version: 0.4
550 *
551 * Feel free to use this script under the terms of the GNU General Public
552 * License, as long as you do not remove or alter this notice.
553 */
554
555 /* modified by Troy D. Hanson, September 2006. License: GPL */
556 /* modified by Stuart Rackham, 2006, 2009. License: GPL */
557
558// toclevels = 1..4.
559toc: function (toclevels) {
560
561 function getText(el) {
562 var text = "";
563 for (var i = el.firstChild; i != null; i = i.nextSibling) {
564 if (i.nodeType == 3 /* Node.TEXT_NODE */) // IE doesn't speak constants.
565 text += i.data;
566 else if (i.firstChild != null)
567 text += getText(i);
568 }
569 return text;
570 }
571
572 function TocEntry(el, text, toclevel) {
573 this.element = el;
574 this.text = text;
575 this.toclevel = toclevel;
576 }
577
578 function tocEntries(el, toclevels) {
579 var result = new Array;
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]580 var re = new RegExp('[hH]([1-'+(toclevels+1)+'])');
Junio C Hamanoe0238c22012-02-23 22:45:50[diff] [blame]581 // Function that scans the DOM tree for header elements (the DOM2
582 // nodeIterator API would be a better technique but not supported by all
583 // browsers).
584 var iterate = function (el) {
585 for (var i = el.firstChild; i != null; i = i.nextSibling) {
586 if (i.nodeType == 1 /* Node.ELEMENT_NODE */) {
587 var mo = re.exec(i.tagName);
588 if (mo && (i.getAttribute("class") || i.getAttribute("className")) != "float") {
589 result[result.length] = new TocEntry(i, getText(i), mo[1]-1);
590 }
591 iterate(i);
592 }
593 }
594 }
595 iterate(el);
596 return result;
597 }
598
599 var toc = document.getElementById("toc");
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]600 if (!toc) {
601 return;
602 }
603
604 // Delete existing TOC entries in case we're reloading the TOC.
605 var tocEntriesToRemove = [];
606 var i;
607 for (i = 0; i < toc.childNodes.length; i++) {
608 var entry = toc.childNodes[i];
609 if (entry.nodeName.toLowerCase() == 'div'
610 && entry.getAttribute("class")
611 && entry.getAttribute("class").match(/^toclevel/))
612 tocEntriesToRemove.push(entry);
613 }
614 for (i = 0; i < tocEntriesToRemove.length; i++) {
615 toc.removeChild(tocEntriesToRemove[i]);
616 }
617
618 // Rebuild TOC entries.
Junio C Hamanoe0238c22012-02-23 22:45:50[diff] [blame]619 var entries = tocEntries(document.getElementById("content"), toclevels);
620 for (var i = 0; i < entries.length; ++i) {
621 var entry = entries[i];
622 if (entry.element.id == "")
623 entry.element.id = "_toc_" + i;
624 var a = document.createElement("a");
625 a.href = "#" + entry.element.id;
626 a.appendChild(document.createTextNode(entry.text));
627 var div = document.createElement("div");
628 div.appendChild(a);
629 div.className = "toclevel" + entry.toclevel;
630 toc.appendChild(div);
631 }
632 if (entries.length == 0)
633 toc.parentNode.removeChild(toc);
634},
635
636
637/////////////////////////////////////////////////////////////////////
638// Footnotes generator
639/////////////////////////////////////////////////////////////////////
640
641/* Based on footnote generation code from:
642 * http://www.brandspankingnew.net/archive/2005/07/format_footnote.html
643 */
644
645footnotes: function () {
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]646 // Delete existing footnote entries in case we're reloading the footnodes.
647 var i;
Junio C Hamanoe0238c22012-02-23 22:45:50[diff] [blame]648 var noteholder = document.getElementById("footnotes");
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]649 if (!noteholder) {
650 return;
651 }
652 var entriesToRemove = [];
653 for (i = 0; i < noteholder.childNodes.length; i++) {
654 var entry = noteholder.childNodes[i];
655 if (entry.nodeName.toLowerCase() == 'div' && entry.getAttribute("class") == "footnote")
656 entriesToRemove.push(entry);
657 }
658 for (i = 0; i < entriesToRemove.length; i++) {
659 noteholder.removeChild(entriesToRemove[i]);
660 }
661
662 // Rebuild footnote entries.
663 var cont = document.getElementById("content");
Junio C Hamanoe0238c22012-02-23 22:45:50[diff] [blame]664 var spans = cont.getElementsByTagName("span");
665 var refs = {};
666 var n = 0;
667 for (i=0; i<spans.length; i++) {
668 if (spans[i].className == "footnote") {
669 n++;
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]670 var note = spans[i].getAttribute("data-note");
671 if (!note) {
672 // Use [\s\S] in place of . so multi-line matches work.
673 // Because JavaScript has no s (dotall) regex flag.
674 note = spans[i].innerHTML.match(/\s*\[([\s\S]*)]\s*/)[1];
675 spans[i].innerHTML =
676 "[<a id='_footnoteref_" + n + "' href='#_footnote_" + n +
677 "' title='View footnote' class='footnote'>" + n + "</a>]";
678 spans[i].setAttribute("data-note", note);
679 }
Junio C Hamanoe0238c22012-02-23 22:45:50[diff] [blame]680 noteholder.innerHTML +=
681 "<div class='footnote' id='_footnote_" + n + "'>" +
682 "<a href='#_footnoteref_" + n + "' title='Return to text'>" +
683 n + "</a>. " + note + "</div>";
Junio C Hamanoe0238c22012-02-23 22:45:50[diff] [blame]684 var id =spans[i].getAttribute("id");
685 if (id != null) refs["#"+id] = n;
686 }
687 }
688 if (n == 0)
689 noteholder.parentNode.removeChild(noteholder);
690 else {
691 // Process footnoterefs.
692 for (i=0; i<spans.length; i++) {
693 if (spans[i].className == "footnoteref") {
694 var href = spans[i].getElementsByTagName("a")[0].getAttribute("href");
695 href = href.match(/#.*/)[0]; // Because IE return full URL.
696 n = refs[href];
697 spans[i].innerHTML =
698 "[<a href='#_footnote_" + n +
699 "' title='View footnote' class='footnote'>" + n + "</a>]";
700 }
701 }
702 }
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]703},
704
705install: function(toclevels) {
706 var timerId;
707
708 function reinstall() {
709 asciidoc.footnotes();
710 if (toclevels) {
711 asciidoc.toc(toclevels);
712 }
713 }
714
715 function reinstallAndRemoveTimer() {
716 clearInterval(timerId);
717 reinstall();
718 }
719
720 timerId = setInterval(reinstall, 500);
721 if (document.addEventListener)
722 document.addEventListener("DOMContentLoaded", reinstallAndRemoveTimer, false);
723 else
724 window.onload = reinstallAndRemoveTimer;
Junio C Hamanoe0238c22012-02-23 22:45:50[diff] [blame]725}
726
727}
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]728asciidoc.install();
Junio C Hamanoe0238c22012-02-23 22:45:50[diff] [blame]729/*]]>*/
730</script>
731</head>
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]732<body class="article">
Junio C Hamanoe0238c22012-02-23 22:45:50[diff] [blame]733<div id="header">
734<h1>config API</h1>
735</div>
736<div id="content">
737<div id="preamble">
738<div class="sectionbody">
Junio C Hamano076ffcc2013-02-06 05:13:21[diff] [blame^]739<div class="paragraph"><p>The config API gives callers a way to access Git configuration files
Junio C Hamano719b8a32012-06-08 18:40:53[diff] [blame]740(and files which have the same syntax). See <a href="../git-config.html">git-config(1)</a> for a
Junio C Hamanoe0238c22012-02-23 22:45:50[diff] [blame]741discussion of the config file syntax.</p></div>
742</div>
743</div>
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]744<div class="sect1">
Junio C Hamanoe0238c22012-02-23 22:45:50[diff] [blame]745<h2 id="_general_usage">General Usage</h2>
746<div class="sectionbody">
747<div class="paragraph"><p>Config files are parsed linearly, and each variable found is passed to a
748caller-provided callback function. The callback function is responsible
749for any actions to be taken on the config option, and is free to ignore
750some options. It is not uncommon for the configuration to be parsed
Junio C Hamano076ffcc2013-02-06 05:13:21[diff] [blame^]751several times during the run of a Git program, with different callbacks
Junio C Hamanoe0238c22012-02-23 22:45:50[diff] [blame]752picking out different variables useful to themselves.</p></div>
753<div class="paragraph"><p>A config callback function takes three parameters:</p></div>
754<div class="ulist"><ul>
755<li>
756<p>
757the name of the parsed variable. This is in canonical "flat" form: the
758 section, subsection, and variable segments will be separated by dots,
759 and the section and variable segments will be all lowercase. E.g.,
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]760 <code>core.ignorecase</code>, <code>diff.SomeType.textconv</code>.
Junio C Hamanoe0238c22012-02-23 22:45:50[diff] [blame]761</p>
762</li>
763<li>
764<p>
765the value of the found variable, as a string. If the variable had no
766 value specified, the value will be NULL (typically this means it
767 should be interpreted as boolean true).
768</p>
769</li>
770<li>
771<p>
772a void pointer passed in by the caller of the config API; this can
773 contain callback-specific data
774</p>
775</li>
776</ul></div>
777<div class="paragraph"><p>A config callback should return 0 for success, or -1 if the variable
778could not be parsed properly.</p></div>
779</div>
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]780</div>
781<div class="sect1">
Junio C Hamanoe0238c22012-02-23 22:45:50[diff] [blame]782<h2 id="_basic_config_querying">Basic Config Querying</h2>
783<div class="sectionbody">
784<div class="paragraph"><p>Most programs will simply want to look up variables in all config files
Junio C Hamano076ffcc2013-02-06 05:13:21[diff] [blame^]785that Git knows about, using the normal precedence rules. To do this,
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]786call <code>git_config</code> with a callback function and void data pointer.</p></div>
787<div class="paragraph"><p><code>git_config</code> will read all config sources in order of increasing
Junio C Hamanoe0238c22012-02-23 22:45:50[diff] [blame]788priority. Thus a callback should typically overwrite previously-seen
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]789entries with new ones (e.g., if both the user-wide <code>~/.gitconfig</code> and
790repo-specific <code>.git/config</code> contain <code>color.ui</code>, the config machinery
Junio C Hamanoe0238c22012-02-23 22:45:50[diff] [blame]791will first feed the user-wide one to the callback, and then the
792repo-specific one; by overwriting, the higher-priority repo-specific
793value is left at the end).</p></div>
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]794<div class="paragraph"><p>The <code>git_config_with_options</code> function lets the caller examine config
795while adjusting some of the default behavior of <code>git_config</code>. It should
Junio C Hamano076ffcc2013-02-06 05:13:21[diff] [blame^]796almost never be used by "regular" Git code that is looking up
Junio C Hamanoe0238c22012-02-23 22:45:50[diff] [blame]797configuration variables. It is intended for advanced callers like
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]798<code>git-config</code>, which are intentionally tweaking the normal config-lookup
Junio C Hamanoe0238c22012-02-23 22:45:50[diff] [blame]799process. It takes two extra parameters:</p></div>
800<div class="dlist"><dl>
801<dt class="hdlist1">
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]802<code>filename</code>
Junio C Hamanoe0238c22012-02-23 22:45:50[diff] [blame]803</dt>
804<dd>
805<p>
806If this parameter is non-NULL, it specifies the name of a file to
807parse for configuration, rather than looking in the usual files. Regular
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]808<code>git_config</code> defaults to <code>NULL</code>.
Junio C Hamanoe0238c22012-02-23 22:45:50[diff] [blame]809</p>
810</dd>
811<dt class="hdlist1">
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]812<code>respect_includes</code>
Junio C Hamanoe0238c22012-02-23 22:45:50[diff] [blame]813</dt>
814<dd>
815<p>
816Specify whether include directives should be followed in parsed files.
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]817Regular <code>git_config</code> defaults to <code>1</code>.
Junio C Hamanoe0238c22012-02-23 22:45:50[diff] [blame]818</p>
819</dd>
820</dl></div>
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]821<div class="paragraph"><p>There is a special version of <code>git_config</code> called <code>git_config_early</code>.
Junio C Hamanoe0238c22012-02-23 22:45:50[diff] [blame]822This version takes an additional parameter to specify the repository
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]823config, instead of having it looked up via <code>git_path</code>. This is useful
Junio C Hamano076ffcc2013-02-06 05:13:21[diff] [blame^]824early in a Git program before the repository has been found. Unless
Junio C Hamanoe0238c22012-02-23 22:45:50[diff] [blame]825you&#8217;re working with early setup code, you probably don&#8217;t want to use
826this.</p></div>
827</div>
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]828</div>
829<div class="sect1">
Junio C Hamanoe0238c22012-02-23 22:45:50[diff] [blame]830<h2 id="_reading_specific_files">Reading Specific Files</h2>
831<div class="sectionbody">
832<div class="paragraph"><p>To read a specific file in git-config format, use
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]833<code>git_config_from_file</code>. This takes the same callback and data parameters
834as <code>git_config</code>.</p></div>
Junio C Hamanoe0238c22012-02-23 22:45:50[diff] [blame]835</div>
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]836</div>
837<div class="sect1">
Junio C Hamanoe0238c22012-02-23 22:45:50[diff] [blame]838<h2 id="_value_parsing_helpers">Value Parsing Helpers</h2>
839<div class="sectionbody">
840<div class="paragraph"><p>To aid in parsing string values, the config API provides callbacks with
841a number of helper functions, including:</p></div>
842<div class="dlist"><dl>
843<dt class="hdlist1">
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]844<code>git_config_int</code>
Junio C Hamanoe0238c22012-02-23 22:45:50[diff] [blame]845</dt>
846<dd>
847<p>
848Parse the string to an integer, including unit factors. Dies on error;
849otherwise, returns the parsed result.
850</p>
851</dd>
852<dt class="hdlist1">
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]853<code>git_config_ulong</code>
Junio C Hamanoe0238c22012-02-23 22:45:50[diff] [blame]854</dt>
855<dd>
856<p>
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]857Identical to <code>git_config_int</code>, but for unsigned longs.
Junio C Hamanoe0238c22012-02-23 22:45:50[diff] [blame]858</p>
859</dd>
860<dt class="hdlist1">
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]861<code>git_config_bool</code>
Junio C Hamanoe0238c22012-02-23 22:45:50[diff] [blame]862</dt>
863<dd>
864<p>
865Parse a string into a boolean value, respecting keywords like "true" and
866"false". Integer values are converted into true/false values (when they
867are non-zero or zero, respectively). Other values cause a die(). If
868parsing is successful, the return value is the result.
869</p>
870</dd>
871<dt class="hdlist1">
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]872<code>git_config_bool_or_int</code>
Junio C Hamanoe0238c22012-02-23 22:45:50[diff] [blame]873</dt>
874<dd>
875<p>
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]876Same as <code>git_config_bool</code>, except that integers are returned as-is, and
877an <code>is_bool</code> flag is unset.
Junio C Hamanoe0238c22012-02-23 22:45:50[diff] [blame]878</p>
879</dd>
880<dt class="hdlist1">
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]881<code>git_config_maybe_bool</code>
Junio C Hamanoe0238c22012-02-23 22:45:50[diff] [blame]882</dt>
883<dd>
884<p>
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]885Same as <code>git_config_bool</code>, except that it returns -1 on error rather
Junio C Hamanoe0238c22012-02-23 22:45:50[diff] [blame]886than dying.
887</p>
888</dd>
889<dt class="hdlist1">
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]890<code>git_config_string</code>
Junio C Hamanoe0238c22012-02-23 22:45:50[diff] [blame]891</dt>
892<dd>
893<p>
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]894Allocates and copies the value string into the <code>dest</code> parameter; if no
Junio C Hamanoe0238c22012-02-23 22:45:50[diff] [blame]895string is given, prints an error message and returns -1.
896</p>
897</dd>
898<dt class="hdlist1">
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]899<code>git_config_pathname</code>
Junio C Hamanoe0238c22012-02-23 22:45:50[diff] [blame]900</dt>
901<dd>
902<p>
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]903Similar to <code>git_config_string</code>, but expands <code>~</code> or <code>~user</code> into the
Junio C Hamanoe0238c22012-02-23 22:45:50[diff] [blame]904user&#8217;s home directory when found at the beginning of the path.
905</p>
906</dd>
907</dl></div>
908</div>
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]909</div>
910<div class="sect1">
Junio C Hamanoe0238c22012-02-23 22:45:50[diff] [blame]911<h2 id="_include_directives">Include Directives</h2>
912<div class="sectionbody">
913<div class="paragraph"><p>By default, the config parser does not respect include directives.
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]914However, a caller can use the special <code>git_config_include</code> wrapper
Junio C Hamanoe0238c22012-02-23 22:45:50[diff] [blame]915callback to support them. To do so, you simply wrap your "real" callback
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]916function and data pointer in a <code>struct config_include_data</code>, and pass
Junio C Hamanoe0238c22012-02-23 22:45:50[diff] [blame]917the wrapper to the regular config-reading functions. For example:</p></div>
918<div class="listingblock">
919<div class="content">
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]920<pre><code>int read_file_with_include(const char *file, config_fn_t fn, void *data)
Junio C Hamanoe0238c22012-02-23 22:45:50[diff] [blame]921{
922 struct config_include_data inc = CONFIG_INCLUDE_INIT;
923 inc.fn = fn;
924 inc.data = data;
925 return git_config_from_file(git_config_include, file, &amp;inc);
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]926}</code></pre>
Junio C Hamanoe0238c22012-02-23 22:45:50[diff] [blame]927</div></div>
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]928<div class="paragraph"><p><code>git_config</code> respects includes automatically. The lower-level
929<code>git_config_from_file</code> does not.</p></div>
Junio C Hamanoe0238c22012-02-23 22:45:50[diff] [blame]930</div>
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]931</div>
932<div class="sect1">
Junio C Hamanoe0238c22012-02-23 22:45:50[diff] [blame]933<h2 id="_writing_config_files">Writing Config Files</h2>
934<div class="sectionbody">
935<div class="paragraph"><p>TODO</p></div>
936</div>
937</div>
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]938</div>
Junio C Hamanoe0238c22012-02-23 22:45:50[diff] [blame]939<div id="footnotes"><hr /></div>
940<div id="footer">
941<div id="footer-text">
Junio C Hamano076ffcc2013-02-06 05:13:21[diff] [blame^]942Last updated 2013-02-05 21:07:26 PST
Junio C Hamanoe0238c22012-02-23 22:45:50[diff] [blame]943</div>
944</div>
945</body>
946</html>