1 <!DOCTYPE html PUBLIC
"-//W3C//DTD XHTML 1.1//EN"
2 "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
3 <html xmlns=
"http://www.w3.org/1999/xhtml" xml:
lang=
"en">
5 <meta http-equiv=
"Content-Type" content=
"text/html; charset=UTF-8" />
6 <meta name=
"generator" content=
"AsciiDoc 8.5.2" />
7 <title>history graph API
</title>
8 <style type=
"text/css">
10 p
, li
, dt
, dd
, div
, pre
, h1
, h2
, h3
, h4
, h5
, h6
{
12 border: 1px solid red;
17 margin: 1em 5% 1em 5%;
22 text-decoration: underline
;
42 h1
, h2
, h3
, h4
, h5
, h6
{
44 font-family: sans-serif
;
51 border-bottom: 2px solid silver
;
69 border: 1px solid silver
;
88 font-family: sans-serif
;
94 span#revnumber
, span#revdate
, span#revremark
{
95 font-family: sans-serif
;
99 font-family: sans-serif
;
101 border-top: 2px solid silver
;
107 padding-bottom: 0.5em;
111 padding-bottom: 0.5em;
116 margin-bottom: 1.5em;
118 div
.tableblock
, div
.imageblock
, div
.exampleblock
, div
.verseblock
,
119 div
.quoteblock
, div
.literalblock
, div
.listingblock
, div
.sidebarblock
,
120 div
.admonitionblock
{
122 margin-bottom: 1.5em;
124 div
.admonitionblock
{
126 margin-bottom: 2.0em;
131 div
.content
{ /* Block element content. */
135 /* Block element titles. */
136 div
.title
, caption
.title
{
138 font-family: sans-serif
;
142 margin-bottom: 0.5em;
148 td div
.title:first-child
{
151 div
.content div
.title:first-child
{
154 div
.content
+ div
.title
{
158 div
.sidebarblock
> div
.content
{
160 border: 1px solid silver
;
164 div
.listingblock
> div
.content
{
165 border: 1px solid silver
;
170 div
.quoteblock
, div
.verseblock
{
174 border-left: 5px solid
#dddddd;
178 div
.quoteblock
> div
.attribution
{
183 div
.verseblock
> div
.content
{
186 div
.verseblock
> div
.attribution
{
190 /* DEPRECATED: Pre version 8.2.7 verse style literal block. */
191 div
.verseblock
+ div
.attribution
{
195 div
.admonitionblock
.icon
{
199 text-decoration: underline
;
201 padding-right: 0.5em;
203 div
.admonitionblock td
.content
{
205 border-left: 3px solid
#dddddd;
208 div
.exampleblock
> div
.content
{
209 border-left: 3px solid
#dddddd;
213 div
.imageblock div
.content
{ padding-left: 0; }
214 span
.image img
{ border-style: none
; }
215 a
.image:visited
{ color: white
; }
219 margin-bottom: 0.8em;
232 list-style-position: outside
;
235 list-style-type: decimal
;
238 list-style-type: lower-alpha
;
241 list-style-type: upper-alpha
;
244 list-style-type: lower-roman
;
247 list-style-type: upper-roman
;
250 div
.compact ul
, div
.compact ol
,
251 div
.compact p
, div
.compact p
,
252 div
.compact div
, div
.compact div
{
254 margin-bottom: 0.1em;
257 div
.tableblock
> table
{
258 border: 3px solid
#527bbd;
260 thead
, p
.table
.header
{
261 font-family: sans-serif
;
273 /* Because the table frame attribute is overriden by CSS in most browsers. */
274 div
.tableblock
> table
[frame
="void"] {
277 div
.tableblock
> table
[frame
="hsides"] {
278 border-left-style: none
;
279 border-right-style: none
;
281 div
.tableblock
> table
[frame
="vsides"] {
282 border-top-style: none
;
283 border-bottom-style: none
;
289 margin-bottom: 0.8em;
292 padding-bottom: 15px;
294 dt
.hdlist1
.strong
, td
.hdlist1
.strong
{
300 padding-right: 0.8em;
306 div
.hdlist
.compact tr
{
315 .footnote, .footnoteref {
319 span
.footnote
, span
.footnoteref
{
320 vertical-align: super
;
324 margin: 20px 0 20px 0;
328 #footnotes div
.footnote
{
334 border-top: 1px solid silver
;
344 div#footer-badges
{ display: none
; }
348 margin-bottom: 2.5em;
353 font-family: sans-serif
;
357 margin-bottom: 0.1em;
360 div
.toclevel1
, div
.toclevel2
, div
.toclevel3
, div
.toclevel4
{
376 /* Workarounds for IE6's broken and incomplete CSS2. */
378 div
.sidebar-content
{
380 border: 1px solid silver
;
383 div
.sidebar-title
, div
.image-title
{
385 font-family: sans-serif
;
388 margin-bottom: 0.5em;
391 div
.listingblock div
.content
{
392 border: 1px solid silver
;
397 div
.quoteblock-attribution
{
402 div
.verseblock-content
{
405 div
.verseblock-attribution
{
410 div
.exampleblock-content
{
411 border-left: 3px solid
#dddddd;
415 /* IE6 sets dynamically generated links as visited. */
416 div#toc
a:visited
{ color: blue
; }
418 <script type=
"text/javascript">
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
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 */
441 toc: function (toclevels
) {
443 function getText(el
) {
445 for (var i
= el
.firstChild
; i
!= null; i
= i
.nextSibling
) {
446 if (i
.nodeType
== 3 /* Node.TEXT_NODE */) // IE doesn't speak constants.
448 else if (i
.firstChild
!= null)
454 function TocEntry(el
, text
, toclevel
) {
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
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);
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");
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");
514 for (i
=0; i
<spans
.length
; i
++) {
515 if (spans
[i
].className
== "footnote") {
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>";
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
;
532 noteholder
.parentNode
.removeChild(noteholder
);
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.
541 "[<a href='#_footnote_" + n
+
542 "' title='View footnote' class='footnote'>" + n
+ "</a>]";
554 <h1>history graph API
</h1>
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>
563 <h2 id=
"_functions">Functions
</h2>
564 <div class=
"sectionbody">
565 <div class=
"paragraph"><p>Core functions:
</p></div>
566 <div class=
"ulist"><ul>
569 <tt>graph_init()
</tt> creates a new
<tt>struct git_graph
</tt>
574 <tt>graph_update()
</tt> moves the graph to a new commit.
579 <tt>graph_next_line()
</tt> outputs the next line of the graph into a strbuf. It
580 does not add a terminating newline.
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.
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.
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>
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.
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.
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.
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.
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.
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.
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
662 <h2 id=
"_calling_sequence">Calling sequence
</h2>
663 <div class=
"sectionbody">
664 <div class=
"ulist"><ul>
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.
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
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.
693 <h2 id=
"_limitations">Limitations
</h2>
694 <div class=
"sectionbody">
695 <div class=
"ulist"><ul>
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.
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.
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>
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.
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))
736 strbuf_init(
&sb,
0);
737 is_commit_line = graph_next_line(graph,
&sb);
738 fputs(sb.buf, stdout);
741 log_tree_commit(opts, commit);
743 putchar(opts-
>diffopt.line_termination);
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
—callers are responsible for
752 outputting that information, if desired.
</p></div>
753 <div class=
"listingblock">
754 <div class=
"content">
788 <div id=
"footnotes"><hr /></div>
790 <div id=
"footer-text">
791 Last updated
2011-
09-
21 23:
01:
14 PDT