blob: 4e01d667a69fe907cab7074b531038c9e04fb515 [file] [log] [blame]
Junio C Hamanobccb0db2012-11-29 22:51:201<!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:115<meta http-equiv="Content-Type" content="application/xhtml+xml; charset=UTF-8" />
Junio C Hamanoc14e6ad2014-10-31 20:25:536<meta name="generator" content="AsciiDoc 8.6.9" />
Junio C Hamanodb81b992012-12-21 23:49:127<title>How to integrate new subcommands</title>
Junio C Hamanobccb0db2012-11-29 22:51:208<style type="text/css">
Junio C Hamano9d971152012-12-19 00:43:119/* 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 Hamanobccb0db2012-11-29 22:51:2024}
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 Hamanobccb0db2012-11-29 22:51:2048h1, h2, h3, h4, h5, h6 {
49 color: #527bbd;
Junio C Hamanobccb0db2012-11-29 22:51:2050 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:1167h5 {
68 font-size: 1.0em;
69}
Junio C Hamanobccb0db2012-11-29 22:51:2070
71div.sectionbody {
Junio C Hamanobccb0db2012-11-29 22:51:2072 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:1187ul > li { color: #aaa; }
88ul > li > * { color: black; }
Junio C Hamanobccb0db2012-11-29 22:51:2089
Junio C Hamanoc14e6ad2014-10-31 20:25:5390.monospaced, code, pre {
91 font-family: "Courier New", Courier, monospace;
92 font-size: inherit;
93 color: navy;
Junio C Hamanobccb0db2012-11-29 22:51:2094 padding: 0;
95 margin: 0;
96}
Junio C Hamanoc14e6ad2014-10-31 20:25:5397pre {
98 white-space: pre-wrap;
99}
Junio C Hamanobccb0db2012-11-29 22:51:20100
Junio C Hamano9d971152012-12-19 00:43:11101#author {
Junio C Hamanobccb0db2012-11-29 22:51:20102 color: #527bbd;
Junio C Hamanobccb0db2012-11-29 22:51:20103 font-weight: bold;
104 font-size: 1.1em;
105}
Junio C Hamano9d971152012-12-19 00:43:11106#email {
Junio C Hamanobccb0db2012-11-29 22:51:20107}
Junio C Hamano9d971152012-12-19 00:43:11108#revnumber, #revdate, #revremark {
Junio C Hamanobccb0db2012-11-29 22:51:20109}
110
Junio C Hamano9d971152012-12-19 00:43:11111#footer {
Junio C Hamanobccb0db2012-11-29 22:51:20112 font-size: small;
113 border-top: 2px solid silver;
114 padding-top: 0.5em;
115 margin-top: 4.0em;
116}
Junio C Hamano9d971152012-12-19 00:43:11117#footer-text {
Junio C Hamanobccb0db2012-11-29 22:51:20118 float: left;
119 padding-bottom: 0.5em;
120}
Junio C Hamano9d971152012-12-19 00:43:11121#footer-badges {
Junio C Hamanobccb0db2012-11-29 22:51:20122 float: right;
123 padding-bottom: 0.5em;
124}
125
Junio C Hamano9d971152012-12-19 00:43:11126#preamble {
Junio C Hamanobccb0db2012-11-29 22:51:20127 margin-top: 1.5em;
128 margin-bottom: 1.5em;
129}
Junio C Hamano9d971152012-12-19 00:43:11130div.imageblock, div.exampleblock, div.verseblock,
Junio C Hamanobccb0db2012-11-29 22:51:20131div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
132div.admonitionblock {
133 margin-top: 1.0em;
134 margin-bottom: 1.5em;
135}
136div.admonitionblock {
137 margin-top: 2.0em;
138 margin-bottom: 2.0em;
139 margin-right: 10%;
140 color: #606060;
141}
142
143div.content { /* Block element content. */
144 padding: 0;
145}
146
147/* Block element titles. */
148div.title, caption.title {
149 color: #527bbd;
Junio C Hamanobccb0db2012-11-29 22:51:20150 font-weight: bold;
151 text-align: left;
152 margin-top: 1.0em;
153 margin-bottom: 0.5em;
154}
155div.title + * {
156 margin-top: 0;
157}
158
159td div.title:first-child {
160 margin-top: 0.0em;
161}
162div.content div.title:first-child {
163 margin-top: 0.0em;
164}
165div.content + div.title {
166 margin-top: 0.0em;
167}
168
169div.sidebarblock > div.content {
170 background: #ffffee;
Junio C Hamano9d971152012-12-19 00:43:11171 border: 1px solid #dddddd;
172 border-left: 4px solid #f0f0f0;
Junio C Hamanobccb0db2012-11-29 22:51:20173 padding: 0.5em;
174}
175
176div.listingblock > div.content {
Junio C Hamano9d971152012-12-19 00:43:11177 border: 1px solid #dddddd;
178 border-left: 5px solid #f0f0f0;
179 background: #f8f8f8;
Junio C Hamanobccb0db2012-11-29 22:51:20180 padding: 0.5em;
181}
182
183div.quoteblock, div.verseblock {
184 padding-left: 1.0em;
185 margin-left: 1.0em;
186 margin-right: 10%;
Junio C Hamano9d971152012-12-19 00:43:11187 border-left: 5px solid #f0f0f0;
188 color: #888;
Junio C Hamanobccb0db2012-11-29 22:51:20189}
190
191div.quoteblock > div.attribution {
192 padding-top: 0.5em;
193 text-align: right;
194}
195
Junio C Hamano9d971152012-12-19 00:43:11196div.verseblock > pre.content {
197 font-family: inherit;
198 font-size: inherit;
Junio C Hamanobccb0db2012-11-29 22:51:20199}
200div.verseblock > div.attribution {
201 padding-top: 0.75em;
202 text-align: left;
203}
204/* DEPRECATED: Pre version 8.2.7 verse style literal block. */
205div.verseblock + div.attribution {
206 text-align: left;
207}
208
209div.admonitionblock .icon {
210 vertical-align: top;
211 font-size: 1.1em;
212 font-weight: bold;
213 text-decoration: underline;
214 color: #527bbd;
215 padding-right: 0.5em;
216}
217div.admonitionblock td.content {
218 padding-left: 0.5em;
219 border-left: 3px solid #dddddd;
220}
221
222div.exampleblock > div.content {
223 border-left: 3px solid #dddddd;
224 padding-left: 0.5em;
225}
226
227div.imageblock div.content { padding-left: 0; }
Junio C Hamanoc14e6ad2014-10-31 20:25:53228span.image img { border-style: none; vertical-align: text-bottom; }
Junio C Hamanobccb0db2012-11-29 22:51:20229a.image:visited { color: white; }
230
231dl {
232 margin-top: 0.8em;
233 margin-bottom: 0.8em;
234}
235dt {
236 margin-top: 0.5em;
237 margin-bottom: 0;
238 font-style: normal;
239 color: navy;
240}
241dd > *:first-child {
242 margin-top: 0.1em;
243}
244
245ul, ol {
246 list-style-position: outside;
247}
248ol.arabic {
249 list-style-type: decimal;
250}
251ol.loweralpha {
252 list-style-type: lower-alpha;
253}
254ol.upperalpha {
255 list-style-type: upper-alpha;
256}
257ol.lowerroman {
258 list-style-type: lower-roman;
259}
260ol.upperroman {
261 list-style-type: upper-roman;
262}
263
264div.compact ul, div.compact ol,
265div.compact p, div.compact p,
266div.compact div, div.compact div {
267 margin-top: 0.1em;
268 margin-bottom: 0.1em;
269}
270
Junio C Hamanobccb0db2012-11-29 22:51:20271tfoot {
272 font-weight: bold;
273}
274td > div.verse {
275 white-space: pre;
276}
Junio C Hamanobccb0db2012-11-29 22:51:20277
278div.hdlist {
279 margin-top: 0.8em;
280 margin-bottom: 0.8em;
281}
282div.hdlist tr {
283 padding-bottom: 15px;
284}
285dt.hdlist1.strong, td.hdlist1.strong {
286 font-weight: bold;
287}
288td.hdlist1 {
289 vertical-align: top;
290 font-style: normal;
291 padding-right: 0.8em;
292 color: navy;
293}
294td.hdlist2 {
295 vertical-align: top;
296}
297div.hdlist.compact tr {
298 margin: 0;
299 padding-bottom: 0;
300}
301
302.comment {
303 background: yellow;
304}
305
306.footnote, .footnoteref {
307 font-size: 0.8em;
308}
309
310span.footnote, span.footnoteref {
311 vertical-align: super;
312}
313
314#footnotes {
315 margin: 20px 0 20px 0;
316 padding: 7px 0 0 0;
317}
318
319#footnotes div.footnote {
320 margin: 0 0 5px 0;
321}
322
323#footnotes hr {
324 border: none;
325 border-top: 1px solid silver;
326 height: 1px;
327 text-align: left;
328 margin-left: 0;
329 width: 20%;
330 min-width: 100px;
331}
332
Junio C Hamano9d971152012-12-19 00:43:11333div.colist td {
334 padding-right: 0.5em;
335 padding-bottom: 0.3em;
336 vertical-align: top;
337}
338div.colist td img {
339 margin-top: 0.3em;
Junio C Hamanobccb0db2012-11-29 22:51:20340}
341
Junio C Hamano9d971152012-12-19 00:43:11342@media print {
343 #footer-badges { display: none; }
344}
345
346#toc {
Junio C Hamanobccb0db2012-11-29 22:51:20347 margin-bottom: 2.5em;
348}
349
Junio C Hamano9d971152012-12-19 00:43:11350#toctitle {
Junio C Hamanobccb0db2012-11-29 22:51:20351 color: #527bbd;
Junio C Hamanobccb0db2012-11-29 22:51:20352 font-size: 1.1em;
353 font-weight: bold;
354 margin-top: 1.0em;
355 margin-bottom: 0.1em;
356}
357
Junio C Hamanoc14e6ad2014-10-31 20:25:53358div.toclevel0, div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
Junio C Hamanobccb0db2012-11-29 22:51:20359 margin-top: 0;
360 margin-bottom: 0;
361}
362div.toclevel2 {
363 margin-left: 2em;
364 font-size: 0.9em;
365}
366div.toclevel3 {
367 margin-left: 4em;
368 font-size: 0.9em;
369}
370div.toclevel4 {
371 margin-left: 6em;
372 font-size: 0.9em;
373}
Junio C Hamanobccb0db2012-11-29 22:51:20374
Junio C Hamano9d971152012-12-19 00:43:11375span.aqua { color: aqua; }
376span.black { color: black; }
377span.blue { color: blue; }
378span.fuchsia { color: fuchsia; }
379span.gray { color: gray; }
380span.green { color: green; }
381span.lime { color: lime; }
382span.maroon { color: maroon; }
383span.navy { color: navy; }
384span.olive { color: olive; }
385span.purple { color: purple; }
386span.red { color: red; }
387span.silver { color: silver; }
388span.teal { color: teal; }
389span.white { color: white; }
390span.yellow { color: yellow; }
391
392span.aqua-background { background: aqua; }
393span.black-background { background: black; }
394span.blue-background { background: blue; }
395span.fuchsia-background { background: fuchsia; }
396span.gray-background { background: gray; }
397span.green-background { background: green; }
398span.lime-background { background: lime; }
399span.maroon-background { background: maroon; }
400span.navy-background { background: navy; }
401span.olive-background { background: olive; }
402span.purple-background { background: purple; }
403span.red-background { background: red; }
404span.silver-background { background: silver; }
405span.teal-background { background: teal; }
406span.white-background { background: white; }
407span.yellow-background { background: yellow; }
408
409span.big { font-size: 2em; }
410span.small { font-size: 0.6em; }
411
412span.underline { text-decoration: underline; }
413span.overline { text-decoration: overline; }
414span.line-through { text-decoration: line-through; }
415
Junio C Hamanoc14e6ad2014-10-31 20:25:53416div.unbreakable { page-break-inside: avoid; }
417
Junio C Hamano9d971152012-12-19 00:43:11418
419/*
420 * xhtml11 specific
421 *
422 * */
423
424div.tableblock {
425 margin-top: 1.0em;
426 margin-bottom: 1.5em;
Junio C Hamanobccb0db2012-11-29 22:51:20427}
Junio C Hamano9d971152012-12-19 00:43:11428div.tableblock > table {
429 border: 3px solid #527bbd;
430}
431thead, p.table.header {
Junio C Hamanobccb0db2012-11-29 22:51:20432 font-weight: bold;
Junio C Hamano9d971152012-12-19 00:43:11433 color: #527bbd;
434}
435p.table {
436 margin-top: 0;
437}
438/* Because the table frame attribute is overriden by CSS in most browsers. */
439div.tableblock > table[frame="void"] {
440 border-style: none;
441}
442div.tableblock > table[frame="hsides"] {
443 border-left-style: none;
444 border-right-style: none;
445}
446div.tableblock > table[frame="vsides"] {
447 border-top-style: none;
448 border-bottom-style: none;
Junio C Hamanobccb0db2012-11-29 22:51:20449}
450
Junio C Hamano9d971152012-12-19 00:43:11451
452/*
453 * html5 specific
454 *
455 * */
456
457table.tableblock {
458 margin-top: 1.0em;
459 margin-bottom: 1.5em;
460}
461thead, p.tableblock.header {
462 font-weight: bold;
463 color: #527bbd;
464}
465p.tableblock {
466 margin-top: 0;
467}
468table.tableblock {
469 border-width: 3px;
470 border-spacing: 0px;
471 border-style: solid;
472 border-color: #527bbd;
473 border-collapse: collapse;
474}
475th.tableblock, td.tableblock {
476 border-width: 1px;
477 padding: 4px;
478 border-style: solid;
479 border-color: #527bbd;
Junio C Hamanobccb0db2012-11-29 22:51:20480}
481
Junio C Hamano9d971152012-12-19 00:43:11482table.tableblock.frame-topbot {
483 border-left-style: hidden;
484 border-right-style: hidden;
485}
486table.tableblock.frame-sides {
487 border-top-style: hidden;
488 border-bottom-style: hidden;
489}
490table.tableblock.frame-none {
491 border-style: hidden;
492}
493
494th.tableblock.halign-left, td.tableblock.halign-left {
495 text-align: left;
496}
497th.tableblock.halign-center, td.tableblock.halign-center {
498 text-align: center;
499}
500th.tableblock.halign-right, td.tableblock.halign-right {
Junio C Hamanobccb0db2012-11-29 22:51:20501 text-align: right;
502}
503
Junio C Hamano9d971152012-12-19 00:43:11504th.tableblock.valign-top, td.tableblock.valign-top {
505 vertical-align: top;
Junio C Hamanobccb0db2012-11-29 22:51:20506}
Junio C Hamano9d971152012-12-19 00:43:11507th.tableblock.valign-middle, td.tableblock.valign-middle {
508 vertical-align: middle;
509}
510th.tableblock.valign-bottom, td.tableblock.valign-bottom {
511 vertical-align: bottom;
Junio C Hamanobccb0db2012-11-29 22:51:20512}
513
Junio C Hamano9d971152012-12-19 00:43:11514
515/*
516 * manpage specific
517 *
518 * */
519
520body.manpage h1 {
521 padding-top: 0.5em;
522 padding-bottom: 0.5em;
523 border-top: 2px solid silver;
524 border-bottom: 2px solid silver;
525}
526body.manpage h2 {
527 border-style: none;
528}
529body.manpage div.sectionbody {
530 margin-left: 3em;
Junio C Hamanobccb0db2012-11-29 22:51:20531}
532
Junio C Hamano9d971152012-12-19 00:43:11533@media print {
534 body.manpage div#toc { display: none; }
535}
Junio C Hamanoc14e6ad2014-10-31 20:25:53536
537
Junio C Hamanobccb0db2012-11-29 22:51:20538</style>
539<script type="text/javascript">
540/*<![CDATA[*/
Junio C Hamanobccb0db2012-11-29 22:51:20541var asciidoc = { // Namespace.
542
543/////////////////////////////////////////////////////////////////////
544// Table Of Contents generator
545/////////////////////////////////////////////////////////////////////
546
547/* Author: Mihai Bazon, September 2002
548 * http://students.infoiasi.ro/~mishoo
549 *
550 * Table Of Content generator
551 * Version: 0.4
552 *
553 * Feel free to use this script under the terms of the GNU General Public
554 * License, as long as you do not remove or alter this notice.
555 */
556
557 /* modified by Troy D. Hanson, September 2006. License: GPL */
558 /* modified by Stuart Rackham, 2006, 2009. License: GPL */
559
560// toclevels = 1..4.
561toc: function (toclevels) {
562
563 function getText(el) {
564 var text = "";
565 for (var i = el.firstChild; i != null; i = i.nextSibling) {
566 if (i.nodeType == 3 /* Node.TEXT_NODE */) // IE doesn't speak constants.
567 text += i.data;
568 else if (i.firstChild != null)
569 text += getText(i);
570 }
571 return text;
572 }
573
574 function TocEntry(el, text, toclevel) {
575 this.element = el;
576 this.text = text;
577 this.toclevel = toclevel;
578 }
579
580 function tocEntries(el, toclevels) {
581 var result = new Array;
Junio C Hamanoc14e6ad2014-10-31 20:25:53582 var re = new RegExp('[hH]([1-'+(toclevels+1)+'])');
Junio C Hamanobccb0db2012-11-29 22:51:20583 // Function that scans the DOM tree for header elements (the DOM2
584 // nodeIterator API would be a better technique but not supported by all
585 // browsers).
586 var iterate = function (el) {
587 for (var i = el.firstChild; i != null; i = i.nextSibling) {
588 if (i.nodeType == 1 /* Node.ELEMENT_NODE */) {
589 var mo = re.exec(i.tagName);
590 if (mo && (i.getAttribute("class") || i.getAttribute("className")) != "float") {
591 result[result.length] = new TocEntry(i, getText(i), mo[1]-1);
592 }
593 iterate(i);
594 }
595 }
596 }
597 iterate(el);
598 return result;
599 }
600
601 var toc = document.getElementById("toc");
Junio C Hamano9d971152012-12-19 00:43:11602 if (!toc) {
603 return;
604 }
605
606 // Delete existing TOC entries in case we're reloading the TOC.
607 var tocEntriesToRemove = [];
608 var i;
609 for (i = 0; i < toc.childNodes.length; i++) {
610 var entry = toc.childNodes[i];
Junio C Hamanoc14e6ad2014-10-31 20:25:53611 if (entry.nodeName.toLowerCase() == 'div'
Junio C Hamano9d971152012-12-19 00:43:11612 && entry.getAttribute("class")
613 && entry.getAttribute("class").match(/^toclevel/))
614 tocEntriesToRemove.push(entry);
615 }
616 for (i = 0; i < tocEntriesToRemove.length; i++) {
617 toc.removeChild(tocEntriesToRemove[i]);
618 }
619
620 // Rebuild TOC entries.
Junio C Hamanobccb0db2012-11-29 22:51:20621 var entries = tocEntries(document.getElementById("content"), toclevels);
622 for (var i = 0; i < entries.length; ++i) {
623 var entry = entries[i];
624 if (entry.element.id == "")
625 entry.element.id = "_toc_" + i;
626 var a = document.createElement("a");
627 a.href = "#" + entry.element.id;
628 a.appendChild(document.createTextNode(entry.text));
629 var div = document.createElement("div");
630 div.appendChild(a);
631 div.className = "toclevel" + entry.toclevel;
632 toc.appendChild(div);
633 }
634 if (entries.length == 0)
635 toc.parentNode.removeChild(toc);
636},
637
638
639/////////////////////////////////////////////////////////////////////
640// Footnotes generator
641/////////////////////////////////////////////////////////////////////
642
643/* Based on footnote generation code from:
644 * http://www.brandspankingnew.net/archive/2005/07/format_footnote.html
645 */
646
647footnotes: function () {
Junio C Hamano9d971152012-12-19 00:43:11648 // Delete existing footnote entries in case we're reloading the footnodes.
649 var i;
Junio C Hamanobccb0db2012-11-29 22:51:20650 var noteholder = document.getElementById("footnotes");
Junio C Hamano9d971152012-12-19 00:43:11651 if (!noteholder) {
652 return;
653 }
654 var entriesToRemove = [];
655 for (i = 0; i < noteholder.childNodes.length; i++) {
656 var entry = noteholder.childNodes[i];
Junio C Hamanoc14e6ad2014-10-31 20:25:53657 if (entry.nodeName.toLowerCase() == 'div' && entry.getAttribute("class") == "footnote")
Junio C Hamano9d971152012-12-19 00:43:11658 entriesToRemove.push(entry);
659 }
660 for (i = 0; i < entriesToRemove.length; i++) {
661 noteholder.removeChild(entriesToRemove[i]);
662 }
663
664 // Rebuild footnote entries.
665 var cont = document.getElementById("content");
Junio C Hamanobccb0db2012-11-29 22:51:20666 var spans = cont.getElementsByTagName("span");
667 var refs = {};
668 var n = 0;
669 for (i=0; i<spans.length; i++) {
670 if (spans[i].className == "footnote") {
671 n++;
Junio C Hamano9d971152012-12-19 00:43:11672 var note = spans[i].getAttribute("data-note");
673 if (!note) {
674 // Use [\s\S] in place of . so multi-line matches work.
675 // Because JavaScript has no s (dotall) regex flag.
676 note = spans[i].innerHTML.match(/\s*\[([\s\S]*)]\s*/)[1];
677 spans[i].innerHTML =
678 "[<a id='_footnoteref_" + n + "' href='#_footnote_" + n +
679 "' title='View footnote' class='footnote'>" + n + "</a>]";
680 spans[i].setAttribute("data-note", note);
681 }
Junio C Hamanobccb0db2012-11-29 22:51:20682 noteholder.innerHTML +=
683 "<div class='footnote' id='_footnote_" + n + "'>" +
684 "<a href='#_footnoteref_" + n + "' title='Return to text'>" +
685 n + "</a>. " + note + "</div>";
Junio C Hamanobccb0db2012-11-29 22:51:20686 var id =spans[i].getAttribute("id");
687 if (id != null) refs["#"+id] = n;
688 }
689 }
690 if (n == 0)
691 noteholder.parentNode.removeChild(noteholder);
692 else {
693 // Process footnoterefs.
694 for (i=0; i<spans.length; i++) {
695 if (spans[i].className == "footnoteref") {
696 var href = spans[i].getElementsByTagName("a")[0].getAttribute("href");
697 href = href.match(/#.*/)[0]; // Because IE return full URL.
698 n = refs[href];
699 spans[i].innerHTML =
700 "[<a href='#_footnote_" + n +
701 "' title='View footnote' class='footnote'>" + n + "</a>]";
702 }
703 }
704 }
Junio C Hamano9d971152012-12-19 00:43:11705},
706
707install: function(toclevels) {
708 var timerId;
709
710 function reinstall() {
711 asciidoc.footnotes();
712 if (toclevels) {
713 asciidoc.toc(toclevels);
714 }
715 }
716
717 function reinstallAndRemoveTimer() {
718 clearInterval(timerId);
719 reinstall();
720 }
721
722 timerId = setInterval(reinstall, 500);
723 if (document.addEventListener)
724 document.addEventListener("DOMContentLoaded", reinstallAndRemoveTimer, false);
725 else
726 window.onload = reinstallAndRemoveTimer;
Junio C Hamanobccb0db2012-11-29 22:51:20727}
728
729}
Junio C Hamano9d971152012-12-19 00:43:11730asciidoc.install();
Junio C Hamanobccb0db2012-11-29 22:51:20731/*]]>*/
732</script>
733</head>
Junio C Hamano9d971152012-12-19 00:43:11734<body class="article">
Junio C Hamanobccb0db2012-11-29 22:51:20735<div id="header">
Junio C Hamanodb81b992012-12-21 23:49:12736<h1>How to integrate new subcommands</h1>
Junio C Hamanobccb0db2012-11-29 22:51:20737</div>
738<div id="content">
739<div id="preamble">
740<div class="sectionbody">
741<div class="paragraph"><p>This is how-to documentation for people who want to add extension
Junio C Hamano076ffcc2013-02-06 05:13:21742commands to Git. It should be read alongside api-builtin.txt.</p></div>
Junio C Hamanobccb0db2012-11-29 22:51:20743</div>
744</div>
Junio C Hamano9d971152012-12-19 00:43:11745<div class="sect1">
Junio C Hamanobccb0db2012-11-29 22:51:20746<h2 id="_runtime_environment">Runtime environment</h2>
747<div class="sectionbody">
Junio C Hamano076ffcc2013-02-06 05:13:21748<div class="paragraph"><p>Git subcommands are standalone executables that live in the Git exec
Junio C Hamanobccb0db2012-11-29 22:51:20749path, normally /usr/lib/git-core. The git executable itself is a
750thin wrapper that knows where the subcommands live, and runs them by
751passing command-line arguments to them.</p></div>
Junio C Hamano076ffcc2013-02-06 05:13:21752<div class="paragraph"><p>(If "git foo" is not found in the Git exec path, the wrapper
Junio C Hamanobccb0db2012-11-29 22:51:20753will look in the rest of your $PATH for it. Thus, it&#8217;s possible
Junio C Hamano076ffcc2013-02-06 05:13:21754to write local Git extensions that don&#8217;t live in system space.)</p></div>
Junio C Hamanobccb0db2012-11-29 22:51:20755</div>
Junio C Hamano9d971152012-12-19 00:43:11756</div>
757<div class="sect1">
Junio C Hamanobccb0db2012-11-29 22:51:20758<h2 id="_implementation_languages">Implementation languages</h2>
759<div class="sectionbody">
760<div class="paragraph"><p>Most subcommands are written in C or shell. A few are written in
761Perl.</p></div>
762<div class="paragraph"><p>While we strongly encourage coding in portable C for portability,
763these specific scripting languages are also acceptable. We won&#8217;t
764accept more without a very strong technical case, as we don&#8217;t want
Junio C Hamano076ffcc2013-02-06 05:13:21765to broaden the Git suite&#8217;s required dependencies. Import utilities,
Junio C Hamanobccb0db2012-11-29 22:51:20766surgical tools, remote helpers and other code at the edges of the
Junio C Hamano076ffcc2013-02-06 05:13:21767Git suite are more lenient and we allow Python (and even Tcl/tk),
Junio C Hamanobccb0db2012-11-29 22:51:20768but they should not be used for core functions.</p></div>
769<div class="paragraph"><p>This may change in the future. Especially Python is not allowed in
Junio C Hamano076ffcc2013-02-06 05:13:21770core because we need better Python integration in the Git Windows
Junio C Hamanobccb0db2012-11-29 22:51:20771installer before we can be confident people in that environment
772won&#8217;t experience an unacceptably large loss of capability.</p></div>
773<div class="paragraph"><p>C commands are normally written as single modules, named after the
774command, that link a collection of functions called libgit. Thus,
775your command <em>git-foo</em> would normally be implemented as a single
776"git-foo.c" (or "builtin/foo.c" if it is to be linked to the main
777binary); this organization makes it easy for people reading the code
778to find things.</p></div>
779<div class="paragraph"><p>See the CodingGuidelines document for other guidance on what we consider
780good practice in C and shell, and api-builtin.txt for the support
781functions available to built-in commands written in C.</p></div>
782</div>
Junio C Hamano9d971152012-12-19 00:43:11783</div>
784<div class="sect1">
Junio C Hamanobccb0db2012-11-29 22:51:20785<h2 id="_what_every_extension_command_needs">What every extension command needs</h2>
786<div class="sectionbody">
Junio C Hamano076ffcc2013-02-06 05:13:21787<div class="paragraph"><p>You must have a man page, written in asciidoc (this is what Git help
Junio C Hamanobccb0db2012-11-29 22:51:20788followed by your subcommand name will display). Be aware that there is
789a local asciidoc configuration and macros which you should use. It&#8217;s
790often helpful to start by cloning an existing page and replacing the
791text content.</p></div>
792<div class="paragraph"><p>You must have a test, written to report in TAP (Test Anything Protocol).
793Tests are executables (usually shell scripts) that live in the <em>t</em>
794subdirectory of the tree. Each test name begins with <em>t</em> and a sequence
795number that controls where in the test sequence it will be executed;
796conventionally the rest of the name stem is that of the command
797being tested.</p></div>
798<div class="paragraph"><p>Read the file t/README to learn more about the conventions to be used
799in writing tests, and the test support library.</p></div>
800</div>
Junio C Hamano9d971152012-12-19 00:43:11801</div>
802<div class="sect1">
Junio C Hamanobccb0db2012-11-29 22:51:20803<h2 id="_integrating_a_command">Integrating a command</h2>
804<div class="sectionbody">
805<div class="paragraph"><p>Here are the things you need to do when you want to merge a new
Junio C Hamano076ffcc2013-02-06 05:13:21806subcommand into the Git tree.</p></div>
Junio C Hamanobccb0db2012-11-29 22:51:20807<div class="olist arabic"><ol class="arabic">
808<li>
809<p>
810Don&#8217;t forget to sign off your patch!
811</p>
812</li>
813<li>
814<p>
815Append your command name to one of the variables BUILTIN_OBJS,
816EXTRA_PROGRAMS, SCRIPT_SH, SCRIPT_PERL or SCRIPT_PYTHON.
817</p>
818</li>
819<li>
820<p>
821Drop its test in the t directory.
822</p>
823</li>
824<li>
825<p>
826If your command is implemented in an interpreted language with a
827p-code intermediate form, make sure .gitignore in the main directory
828includes a pattern entry that ignores such files. Python .pyc and
829.pyo files will already be covered.
830</p>
831</li>
832<li>
833<p>
834If your command has any dependency on a particular version of
835your language, document it in the INSTALL file.
836</p>
837</li>
838<li>
839<p>
840There is a file command-list.txt in the distribution main directory
841that categorizes commands by type, so they can be listed in appropriate
842subsections in the documentation&#8217;s summary command list. Add an entry
Junio C Hamanoce806e32013-08-01 20:28:10843for yours. To understand the categories, look at git-commands.txt
Junio C Hamano85f1fde2015-06-01 20:37:32844in the main directory. If the new command is part of the typical Git
845workflow and you believe it common enough to be mentioned in <em>git help</em>,
846map this command to a common group in the column [common].
Junio C Hamanobccb0db2012-11-29 22:51:20847</p>
848</li>
849<li>
850<p>
851Give the maintainer one paragraph to include in the RelNotes file
852to describe the new feature; a good place to do so is in the cover
853letter [PATCH 0/n].
854</p>
855</li>
856</ol></div>
857<div class="paragraph"><p>That&#8217;s all there is to it.</p></div>
858</div>
859</div>
Junio C Hamano9d971152012-12-19 00:43:11860</div>
Junio C Hamanobccb0db2012-11-29 22:51:20861<div id="footnotes"><hr /></div>
862<div id="footer">
863<div id="footer-text">
Junio C Hamano754b2b62015-09-14 21:11:40864Last updated 2015-09-14 14:09:12 PDT
Junio C Hamanobccb0db2012-11-29 22:51:20865</div>
866</div>
867</body>
868</html>