Autogenerated HTML docs for v1.7.7-rc2-4-g5ec82
[git/jnareb-git.git] / technical / api-history-graph.html
blob28ff08ec4f276da1feb08530f6657f191160092d
1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
2 "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
3 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
4 <head>
5 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
6 <meta name="generator" content="AsciiDoc 8.5.2" />
7 <title>history graph API</title>
8 <style type="text/css">
9 /* Debug borders */
10 p, li, dt, dd, div, pre, h1, h2, h3, h4, h5, h6 {
12 border: 1px solid red;
16 body {
17 margin: 1em 5% 1em 5%;
20 a {
21 color: blue;
22 text-decoration: underline;
24 a:visited {
25 color: fuchsia;
28 em {
29 font-style: italic;
30 color: navy;
33 strong {
34 font-weight: bold;
35 color: #083194;
38 tt {
39 color: navy;
42 h1, h2, h3, h4, h5, h6 {
43 color: #527bbd;
44 font-family: sans-serif;
45 margin-top: 1.2em;
46 margin-bottom: 0.5em;
47 line-height: 1.3;
50 h1, h2, h3 {
51 border-bottom: 2px solid silver;
53 h2 {
54 padding-top: 0.5em;
56 h3 {
57 float: left;
59 h3 + * {
60 clear: left;
63 div.sectionbody {
64 font-family: serif;
65 margin-left: 0;
68 hr {
69 border: 1px solid silver;
72 p {
73 margin-top: 0.5em;
74 margin-bottom: 0.5em;
77 ul, ol, li > p {
78 margin-top: 0;
81 pre {
82 padding: 0;
83 margin: 0;
86 span#author {
87 color: #527bbd;
88 font-family: sans-serif;
89 font-weight: bold;
90 font-size: 1.1em;
92 span#email {
94 span#revnumber, span#revdate, span#revremark {
95 font-family: sans-serif;
98 div#footer {
99 font-family: sans-serif;
100 font-size: small;
101 border-top: 2px solid silver;
102 padding-top: 0.5em;
103 margin-top: 4.0em;
105 div#footer-text {
106 float: left;
107 padding-bottom: 0.5em;
109 div#footer-badges {
110 float: right;
111 padding-bottom: 0.5em;
114 div#preamble {
115 margin-top: 1.5em;
116 margin-bottom: 1.5em;
118 div.tableblock, div.imageblock, div.exampleblock, div.verseblock,
119 div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
120 div.admonitionblock {
121 margin-top: 1.0em;
122 margin-bottom: 1.5em;
124 div.admonitionblock {
125 margin-top: 2.0em;
126 margin-bottom: 2.0em;
127 margin-right: 10%;
128 color: #606060;
131 div.content { /* Block element content. */
132 padding: 0;
135 /* Block element titles. */
136 div.title, caption.title {
137 color: #527bbd;
138 font-family: sans-serif;
139 font-weight: bold;
140 text-align: left;
141 margin-top: 1.0em;
142 margin-bottom: 0.5em;
144 div.title + * {
145 margin-top: 0;
148 td div.title:first-child {
149 margin-top: 0.0em;
151 div.content div.title:first-child {
152 margin-top: 0.0em;
154 div.content + div.title {
155 margin-top: 0.0em;
158 div.sidebarblock > div.content {
159 background: #ffffee;
160 border: 1px solid silver;
161 padding: 0.5em;
164 div.listingblock > div.content {
165 border: 1px solid silver;
166 background: #f4f4f4;
167 padding: 0.5em;
170 div.quoteblock, div.verseblock {
171 padding-left: 1.0em;
172 margin-left: 1.0em;
173 margin-right: 10%;
174 border-left: 5px solid #dddddd;
175 color: #777777;
178 div.quoteblock > div.attribution {
179 padding-top: 0.5em;
180 text-align: right;
183 div.verseblock > div.content {
184 white-space: pre;
186 div.verseblock > div.attribution {
187 padding-top: 0.75em;
188 text-align: left;
190 /* DEPRECATED: Pre version 8.2.7 verse style literal block. */
191 div.verseblock + div.attribution {
192 text-align: left;
195 div.admonitionblock .icon {
196 vertical-align: top;
197 font-size: 1.1em;
198 font-weight: bold;
199 text-decoration: underline;
200 color: #527bbd;
201 padding-right: 0.5em;
203 div.admonitionblock td.content {
204 padding-left: 0.5em;
205 border-left: 3px solid #dddddd;
208 div.exampleblock > div.content {
209 border-left: 3px solid #dddddd;
210 padding-left: 0.5em;
213 div.imageblock div.content { padding-left: 0; }
214 span.image img { border-style: none; }
215 a.image:visited { color: white; }
217 dl {
218 margin-top: 0.8em;
219 margin-bottom: 0.8em;
221 dt {
222 margin-top: 0.5em;
223 margin-bottom: 0;
224 font-style: normal;
225 color: navy;
227 dd > *:first-child {
228 margin-top: 0.1em;
231 ul, ol {
232 list-style-position: outside;
234 ol.arabic {
235 list-style-type: decimal;
237 ol.loweralpha {
238 list-style-type: lower-alpha;
240 ol.upperalpha {
241 list-style-type: upper-alpha;
243 ol.lowerroman {
244 list-style-type: lower-roman;
246 ol.upperroman {
247 list-style-type: upper-roman;
250 div.compact ul, div.compact ol,
251 div.compact p, div.compact p,
252 div.compact div, div.compact div {
253 margin-top: 0.1em;
254 margin-bottom: 0.1em;
257 div.tableblock > table {
258 border: 3px solid #527bbd;
260 thead, p.table.header {
261 font-family: sans-serif;
262 font-weight: bold;
264 tfoot {
265 font-weight: bold;
267 td > div.verse {
268 white-space: pre;
270 p.table {
271 margin-top: 0;
273 /* Because the table frame attribute is overriden by CSS in most browsers. */
274 div.tableblock > table[frame="void"] {
275 border-style: none;
277 div.tableblock > table[frame="hsides"] {
278 border-left-style: none;
279 border-right-style: none;
281 div.tableblock > table[frame="vsides"] {
282 border-top-style: none;
283 border-bottom-style: none;
287 div.hdlist {
288 margin-top: 0.8em;
289 margin-bottom: 0.8em;
291 div.hdlist tr {
292 padding-bottom: 15px;
294 dt.hdlist1.strong, td.hdlist1.strong {
295 font-weight: bold;
297 td.hdlist1 {
298 vertical-align: top;
299 font-style: normal;
300 padding-right: 0.8em;
301 color: navy;
303 td.hdlist2 {
304 vertical-align: top;
306 div.hdlist.compact tr {
307 margin: 0;
308 padding-bottom: 0;
311 .comment {
312 background: yellow;
315 .footnote, .footnoteref {
316 font-size: 0.8em;
319 span.footnote, span.footnoteref {
320 vertical-align: super;
323 #footnotes {
324 margin: 20px 0 20px 0;
325 padding: 7px 0 0 0;
328 #footnotes div.footnote {
329 margin: 0 0 5px 0;
332 #footnotes hr {
333 border: none;
334 border-top: 1px solid silver;
335 height: 1px;
336 text-align: left;
337 margin-left: 0;
338 width: 20%;
339 min-width: 100px;
343 @media print {
344 div#footer-badges { display: none; }
347 div#toc {
348 margin-bottom: 2.5em;
351 div#toctitle {
352 color: #527bbd;
353 font-family: sans-serif;
354 font-size: 1.1em;
355 font-weight: bold;
356 margin-top: 1.0em;
357 margin-bottom: 0.1em;
360 div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
361 margin-top: 0;
362 margin-bottom: 0;
364 div.toclevel2 {
365 margin-left: 2em;
366 font-size: 0.9em;
368 div.toclevel3 {
369 margin-left: 4em;
370 font-size: 0.9em;
372 div.toclevel4 {
373 margin-left: 6em;
374 font-size: 0.9em;
376 /* Workarounds for IE6's broken and incomplete CSS2. */
378 div.sidebar-content {
379 background: #ffffee;
380 border: 1px solid silver;
381 padding: 0.5em;
383 div.sidebar-title, div.image-title {
384 color: #527bbd;
385 font-family: sans-serif;
386 font-weight: bold;
387 margin-top: 0.0em;
388 margin-bottom: 0.5em;
391 div.listingblock div.content {
392 border: 1px solid silver;
393 background: #f4f4f4;
394 padding: 0.5em;
397 div.quoteblock-attribution {
398 padding-top: 0.5em;
399 text-align: right;
402 div.verseblock-content {
403 white-space: pre;
405 div.verseblock-attribution {
406 padding-top: 0.75em;
407 text-align: left;
410 div.exampleblock-content {
411 border-left: 3px solid #dddddd;
412 padding-left: 0.5em;
415 /* IE6 sets dynamically generated links as visited. */
416 div#toc a:visited { color: blue; }
417 </style>
418 <script type="text/javascript">
419 /*<![CDATA[*/
420 window.onload = function(){asciidoc.footnotes();}
421 var asciidoc = { // Namespace.
423 /////////////////////////////////////////////////////////////////////
424 // Table Of Contents generator
425 /////////////////////////////////////////////////////////////////////
427 /* Author: Mihai Bazon, September 2002
428 * http://students.infoiasi.ro/~mishoo
430 * Table Of Content generator
431 * Version: 0.4
433 * Feel free to use this script under the terms of the GNU General Public
434 * License, as long as you do not remove or alter this notice.
437 /* modified by Troy D. Hanson, September 2006. License: GPL */
438 /* modified by Stuart Rackham, 2006, 2009. License: GPL */
440 // toclevels = 1..4.
441 toc: function (toclevels) {
443 function getText(el) {
444 var text = "";
445 for (var i = el.firstChild; i != null; i = i.nextSibling) {
446 if (i.nodeType == 3 /* Node.TEXT_NODE */) // IE doesn't speak constants.
447 text += i.data;
448 else if (i.firstChild != null)
449 text += getText(i);
451 return text;
454 function TocEntry(el, text, toclevel) {
455 this.element = el;
456 this.text = text;
457 this.toclevel = toclevel;
460 function tocEntries(el, toclevels) {
461 var result = new Array;
462 var re = new RegExp('[hH]([2-'+(toclevels+1)+'])');
463 // Function that scans the DOM tree for header elements (the DOM2
464 // nodeIterator API would be a better technique but not supported by all
465 // browsers).
466 var iterate = function (el) {
467 for (var i = el.firstChild; i != null; i = i.nextSibling) {
468 if (i.nodeType == 1 /* Node.ELEMENT_NODE */) {
469 var mo = re.exec(i.tagName);
470 if (mo && (i.getAttribute("class") || i.getAttribute("className")) != "float") {
471 result[result.length] = new TocEntry(i, getText(i), mo[1]-1);
473 iterate(i);
477 iterate(el);
478 return result;
481 var toc = document.getElementById("toc");
482 var entries = tocEntries(document.getElementById("content"), toclevels);
483 for (var i = 0; i < entries.length; ++i) {
484 var entry = entries[i];
485 if (entry.element.id == "")
486 entry.element.id = "_toc_" + i;
487 var a = document.createElement("a");
488 a.href = "#" + entry.element.id;
489 a.appendChild(document.createTextNode(entry.text));
490 var div = document.createElement("div");
491 div.appendChild(a);
492 div.className = "toclevel" + entry.toclevel;
493 toc.appendChild(div);
495 if (entries.length == 0)
496 toc.parentNode.removeChild(toc);
500 /////////////////////////////////////////////////////////////////////
501 // Footnotes generator
502 /////////////////////////////////////////////////////////////////////
504 /* Based on footnote generation code from:
505 * http://www.brandspankingnew.net/archive/2005/07/format_footnote.html
508 footnotes: function () {
509 var cont = document.getElementById("content");
510 var noteholder = document.getElementById("footnotes");
511 var spans = cont.getElementsByTagName("span");
512 var refs = {};
513 var n = 0;
514 for (i=0; i<spans.length; i++) {
515 if (spans[i].className == "footnote") {
516 n++;
517 // Use [\s\S] in place of . so multi-line matches work.
518 // Because JavaScript has no s (dotall) regex flag.
519 note = spans[i].innerHTML.match(/\s*\[([\s\S]*)]\s*/)[1];
520 noteholder.innerHTML +=
521 "<div class='footnote' id='_footnote_" + n + "'>" +
522 "<a href='#_footnoteref_" + n + "' title='Return to text'>" +
523 n + "</a>. " + note + "</div>";
524 spans[i].innerHTML =
525 "[<a id='_footnoteref_" + n + "' href='#_footnote_" + n +
526 "' title='View footnote' class='footnote'>" + n + "</a>]";
527 var id =spans[i].getAttribute("id");
528 if (id != null) refs["#"+id] = n;
531 if (n == 0)
532 noteholder.parentNode.removeChild(noteholder);
533 else {
534 // Process footnoterefs.
535 for (i=0; i<spans.length; i++) {
536 if (spans[i].className == "footnoteref") {
537 var href = spans[i].getElementsByTagName("a")[0].getAttribute("href");
538 href = href.match(/#.*/)[0]; // Because IE return full URL.
539 n = refs[href];
540 spans[i].innerHTML =
541 "[<a href='#_footnote_" + n +
542 "' title='View footnote' class='footnote'>" + n + "</a>]";
549 /*]]>*/
550 </script>
551 </head>
552 <body>
553 <div id="header">
554 <h1>history graph API</h1>
555 </div>
556 <div id="content">
557 <div id="preamble">
558 <div class="sectionbody">
559 <div class="paragraph"><p>The graph API is used to draw a text-based representation of the commit
560 history. The API generates the graph in a line-by-line fashion.</p></div>
561 </div>
562 </div>
563 <h2 id="_functions">Functions</h2>
564 <div class="sectionbody">
565 <div class="paragraph"><p>Core functions:</p></div>
566 <div class="ulist"><ul>
567 <li>
569 <tt>graph_init()</tt> creates a new <tt>struct git_graph</tt>
570 </p>
571 </li>
572 <li>
574 <tt>graph_update()</tt> moves the graph to a new commit.
575 </p>
576 </li>
577 <li>
579 <tt>graph_next_line()</tt> outputs the next line of the graph into a strbuf. It
580 does not add a terminating newline.
581 </p>
582 </li>
583 <li>
585 <tt>graph_padding_line()</tt> outputs a line of vertical padding in the graph. It
586 is similar to <tt>graph_next_line()</tt>, but is guaranteed to never print the line
587 containing the current commit. Where <tt>graph_next_line()</tt> would print the
588 commit line next, <tt>graph_padding_line()</tt> prints a line that simply extends
589 all branch lines downwards one row, leaving their positions unchanged.
590 </p>
591 </li>
592 <li>
594 <tt>graph_is_commit_finished()</tt> determines if the graph has output all lines
595 necessary for the current commit. If <tt>graph_update()</tt> is called before all
596 lines for the current commit have been printed, the next call to
597 <tt>graph_next_line()</tt> will output an ellipsis, to indicate that a portion of
598 the graph was omitted.
599 </p>
600 </li>
601 </ul></div>
602 <div class="paragraph"><p>The following utility functions are wrappers around <tt>graph_next_line()</tt> and
603 <tt>graph_is_commit_finished()</tt>. They always print the output to stdout.
604 They can all be called with a NULL graph argument, in which case no graph
605 output will be printed.</p></div>
606 <div class="ulist"><ul>
607 <li>
609 <tt>graph_show_commit()</tt> calls <tt>graph_next_line()</tt> until it returns non-zero.
610 This prints all graph lines up to, and including, the line containing this
611 commit. Output is printed to stdout. The last line printed does not contain
612 a terminating newline. This should not be called if the commit line has
613 already been printed, or it will loop forever.
614 </p>
615 </li>
616 <li>
618 <tt>graph_show_oneline()</tt> calls <tt>graph_next_line()</tt> and prints the result to
619 stdout. The line printed does not contain a terminating newline.
620 </p>
621 </li>
622 <li>
624 <tt>graph_show_padding()</tt> calls <tt>graph_padding_line()</tt> and prints the result to
625 stdout. The line printed does not contain a terminating newline.
626 </p>
627 </li>
628 <li>
630 <tt>graph_show_remainder()</tt> calls <tt>graph_next_line()</tt> until
631 <tt>graph_is_commit_finished()</tt> returns non-zero. Output is printed to stdout.
632 The last line printed does not contain a terminating newline. Returns 1 if
633 output was printed, and 0 if no output was necessary.
634 </p>
635 </li>
636 <li>
638 <tt>graph_show_strbuf()</tt> prints the specified strbuf to stdout, prefixing all
639 lines but the first with a graph line. The caller is responsible for
640 ensuring graph output for the first line has already been printed to stdout.
641 (This can be done with <tt>graph_show_commit()</tt> or <tt>graph_show_oneline()</tt>.) If
642 a NULL graph is supplied, the strbuf is printed as-is.
643 </p>
644 </li>
645 <li>
647 <tt>graph_show_commit_msg()</tt> is similar to <tt>graph_show_strbuf()</tt>, but it also
648 prints the remainder of the graph, if more lines are needed after the strbuf
649 ends. It is better than directly calling <tt>graph_show_strbuf()</tt> followed by
650 <tt>graph_show_remainder()</tt> since it properly handles buffers that do not end in
651 a terminating newline. The output printed by <tt>graph_show_commit_msg()</tt> will
652 end in a newline if and only if the strbuf ends in a newline.
653 </p>
654 </li>
655 </ul></div>
656 </div>
657 <h2 id="_data_structure">Data structure</h2>
658 <div class="sectionbody">
659 <div class="paragraph"><p><tt>struct git_graph</tt> is an opaque data type used to store the current graph
660 state.</p></div>
661 </div>
662 <h2 id="_calling_sequence">Calling sequence</h2>
663 <div class="sectionbody">
664 <div class="ulist"><ul>
665 <li>
667 Create a <tt>struct git_graph</tt> by calling <tt>graph_init()</tt>. When using the
668 revision walking API, this is done automatically by <tt>setup_revisions()</tt> if
669 the <em>--graph</em> option is supplied.
670 </p>
671 </li>
672 <li>
674 Use the revision walking API to walk through a group of contiguous commits.
675 The <tt>get_revision()</tt> function automatically calls <tt>graph_update()</tt> each time
676 it is invoked.
677 </p>
678 </li>
679 <li>
681 For each commit, call <tt>graph_next_line()</tt> repeatedly, until
682 <tt>graph_is_commit_finished()</tt> returns non-zero. Each call go
683 <tt>graph_next_line()</tt> will output a single line of the graph. The resulting
684 lines will not contain any newlines. <tt>graph_next_line()</tt> returns 1 if the
685 resulting line contains the current commit, or 0 if this is merely a line
686 needed to adjust the graph before or after the current commit. This return
687 value can be used to determine where to print the commit summary information
688 alongside the graph output.
689 </p>
690 </li>
691 </ul></div>
692 </div>
693 <h2 id="_limitations">Limitations</h2>
694 <div class="sectionbody">
695 <div class="ulist"><ul>
696 <li>
698 <tt>graph_update()</tt> must be called with commits in topological order. It should
699 not be called on a commit if it has already been invoked with an ancestor of
700 that commit, or the graph output will be incorrect.
701 </p>
702 </li>
703 <li>
705 <tt>graph_update()</tt> must be called on a contiguous group of commits. If
706 <tt>graph_update()</tt> is called on a particular commit, it should later be called
707 on all parents of that commit. Parents must not be skipped, or the graph
708 output will appear incorrect.
709 </p>
710 <div class="paragraph"><p><tt>graph_update()</tt> may be used on a pruned set of commits only if the parent list
711 has been rewritten so as to include only ancestors from the pruned set.</p></div>
712 </li>
713 <li>
715 The graph API does not currently support reverse commit ordering. In
716 order to implement reverse ordering, the graphing API needs an
717 (efficient) mechanism to find the children of a commit.
718 </p>
719 </li>
720 </ul></div>
721 </div>
722 <h2 id="_sample_usage">Sample usage</h2>
723 <div class="sectionbody">
724 <div class="listingblock">
725 <div class="content">
726 <pre><tt>struct commit *commit;
727 struct git_graph *graph = graph_init(opts);
729 while ((commit = get_revision(opts)) != NULL) {
730 graph_update(graph, commit);
731 while (!graph_is_commit_finished(graph))
733 struct strbuf sb;
734 int is_commit_line;
736 strbuf_init(&amp;sb, 0);
737 is_commit_line = graph_next_line(graph, &amp;sb);
738 fputs(sb.buf, stdout);
740 if (is_commit_line)
741 log_tree_commit(opts, commit);
742 else
743 putchar(opts-&gt;diffopt.line_termination);
745 }</tt></pre>
746 </div></div>
747 </div>
748 <h2 id="_sample_output">Sample output</h2>
749 <div class="sectionbody">
750 <div class="paragraph"><p>The following is an example of the output from the graph API. This output does
751 not include any commit summary information&#8212;callers are responsible for
752 outputting that information, if desired.</p></div>
753 <div class="listingblock">
754 <div class="content">
755 <pre><tt>*
760 | | *
761 | \ \
762 | \ \
763 *-. \ \
764 |\ \ \ \
765 | | * | |
766 | | | | | *
767 | | | | | *
768 | | | | | *
769 | | | | | |\
770 | | | | | | *
771 | * | | | | |
772 | | | | | * \
773 | | | | | |\ |
774 | | | | * | | |
775 | | | | * | | |
776 * | | | | | | |
777 | |/ / / / / /
778 |/| / / / / /
779 * | | | | | |
780 |/ / / / / /
781 * | | | | |
782 | | | | | *
783 | | | | |/
784 | | | | *</tt></pre>
785 </div></div>
786 </div>
787 </div>
788 <div id="footnotes"><hr /></div>
789 <div id="footer">
790 <div id="footer-text">
791 Last updated 2011-09-21 23:01:14 PDT
792 </div>
793 </div>
794 </body>
795 </html>