Autogenerated HTML docs for v1.7.7-237-g34c44
[git/jnareb-git.git] / git-tools.html
blob50bbbb9689a8eb8282b1d67716499ea938dda9a8
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>A short git tools survey</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>A short git tools survey</h1>
555 </div>
556 <div id="content">
557 <h2 id="_introduction">Introduction</h2>
558 <div class="sectionbody">
559 <div class="paragraph"><p>Apart from git contrib/ area there are some others third-party tools
560 you may want to look.</p></div>
561 <div class="paragraph"><p>This document presents a brief summary of each tool and the corresponding
562 link.</p></div>
563 </div>
564 <h2 id="_alternative_augmentative_porcelains">Alternative/Augmentative Porcelains</h2>
565 <div class="sectionbody">
566 <div class="ulist"><ul>
567 <li>
569 <strong>Cogito</strong> (<a href="http://www.kernel.org/pub/software/scm/cogito/">http://www.kernel.org/pub/software/scm/cogito/</a>)
570 </p>
571 <div class="literalblock">
572 <div class="content">
573 <pre><tt>Cogito is a version control system layered on top of the git tree history
574 storage system. It aims at seamless user interface and ease of use,
575 providing generally smoother user experience than the "raw" Core GIT
576 itself and indeed many other version control systems.</tt></pre>
577 </div></div>
578 <div class="literalblock">
579 <div class="content">
580 <pre><tt>Cogito is no longer maintained as most of its functionality
581 is now in core GIT.</tt></pre>
582 </div></div>
583 </li>
584 <li>
586 <strong>pg</strong> (<a href="http://www.spearce.org/category/projects/scm/pg/">http://www.spearce.org/category/projects/scm/pg/</a>)
587 </p>
588 <div class="literalblock">
589 <div class="content">
590 <pre><tt>pg is a shell script wrapper around GIT to help the user manage a set of
591 patches to files. pg is somewhat like quilt or StGIT, but it does have a
592 slightly different feature set.</tt></pre>
593 </div></div>
594 </li>
595 <li>
597 <strong>StGit</strong> (<a href="http://www.procode.org/stgit/">http://www.procode.org/stgit/</a>)
598 </p>
599 <div class="literalblock">
600 <div class="content">
601 <pre><tt>Stacked GIT provides a quilt-like patch management functionality in the
602 GIT environment. You can easily manage your patches in the scope of GIT
603 until they get merged upstream.</tt></pre>
604 </div></div>
605 </li>
606 </ul></div>
607 </div>
608 <h2 id="_history_viewers">History Viewers</h2>
609 <div class="sectionbody">
610 <div class="ulist"><ul>
611 <li>
613 <strong>gitk</strong> (shipped with git-core)
614 </p>
615 <div class="literalblock">
616 <div class="content">
617 <pre><tt>gitk is a simple Tk GUI for browsing history of GIT repositories easily.</tt></pre>
618 </div></div>
619 </li>
620 <li>
622 <strong>gitview</strong> (contrib/)
623 </p>
624 <div class="literalblock">
625 <div class="content">
626 <pre><tt>gitview is a GTK based repository browser for git</tt></pre>
627 </div></div>
628 </li>
629 <li>
631 <strong>gitweb</strong> (shipped with git-core)
632 </p>
633 <div class="literalblock">
634 <div class="content">
635 <pre><tt>GITweb provides full-fledged web interface for GIT repositories.</tt></pre>
636 </div></div>
637 </li>
638 <li>
640 <strong>qgit</strong> (<a href="http://digilander.libero.it/mcostalba/">http://digilander.libero.it/mcostalba/</a>)
641 </p>
642 <div class="literalblock">
643 <div class="content">
644 <pre><tt>QGit is a git/StGIT GUI viewer built on Qt/C++. QGit could be used
645 to browse history and directory tree, view annotated files, commit
646 changes cherry picking single files or applying patches.
647 Currently it is the fastest and most feature rich among the git
648 viewers and commit tools.</tt></pre>
649 </div></div>
650 </li>
651 <li>
653 <strong>tig</strong> (<a href="http://jonas.nitro.dk/tig/">http://jonas.nitro.dk/tig/</a>)
654 </p>
655 <div class="literalblock">
656 <div class="content">
657 <pre><tt>tig by Jonas Fonseca is a simple git repository browser
658 written using ncurses. Basically, it just acts as a front-end
659 for git-log and git-show/git-diff. Additionally, you can also
660 use it as a pager for git commands.</tt></pre>
661 </div></div>
662 </li>
663 </ul></div>
664 </div>
665 <h2 id="_foreign_scm_interface">Foreign SCM interface</h2>
666 <div class="sectionbody">
667 <div class="ulist"><ul>
668 <li>
670 <strong>git-svn</strong> (shipped with git-core)
671 </p>
672 <div class="literalblock">
673 <div class="content">
674 <pre><tt>git-svn is a simple conduit for changesets between a single Subversion
675 branch and git.</tt></pre>
676 </div></div>
677 </li>
678 <li>
680 <strong>quilt2git / git2quilt</strong> (<a href="http://home-tj.org/wiki/index.php/Misc">http://home-tj.org/wiki/index.php/Misc</a>)
681 </p>
682 <div class="literalblock">
683 <div class="content">
684 <pre><tt>These utilities convert patch series in a quilt repository and commit
685 series in git back and forth.</tt></pre>
686 </div></div>
687 </li>
688 <li>
690 <strong>hg-to-git</strong> (contrib/)
691 </p>
692 <div class="literalblock">
693 <div class="content">
694 <pre><tt>hg-to-git converts a Mercurial repository into a git one, and
695 preserves the full branch history in the process. hg-to-git can
696 also be used in an incremental way to keep the git repository
697 in sync with the master Mercurial repository.</tt></pre>
698 </div></div>
699 </li>
700 </ul></div>
701 </div>
702 <h2 id="_others">Others</h2>
703 <div class="sectionbody">
704 <div class="ulist"><ul>
705 <li>
707 <strong>(h)gct</strong> (<a href="http://www.cyd.liu.se/users/~freku045/gct/">http://www.cyd.liu.se/users/~freku045/gct/</a>)
708 </p>
709 <div class="literalblock">
710 <div class="content">
711 <pre><tt>Commit Tool or (h)gct is a GUI enabled commit tool for git and
712 Mercurial (hg). It allows the user to view diffs, select which files
713 to committed (or ignored / reverted) write commit messages and
714 perform the commit itself.</tt></pre>
715 </div></div>
716 </li>
717 <li>
719 <strong>git.el</strong> (contrib/)
720 </p>
721 <div class="literalblock">
722 <div class="content">
723 <pre><tt>This is an Emacs interface for git. The user interface is modeled on
724 pcl-cvs. It has been developed on Emacs 21 and will probably need some
725 tweaking to work on XEmacs.</tt></pre>
726 </div></div>
727 </li>
728 </ul></div>
729 <div class="paragraph"><p><a href="http://git.or.cz/gitwiki/InterfacesFrontendsAndTools">http://git.or.cz/gitwiki/InterfacesFrontendsAndTools</a> has more
730 comprehensive list.</p></div>
731 </div>
732 </div>
733 <div id="footnotes"><hr /></div>
734 <div id="footer">
735 <div id="footer-text">
736 Last updated 2011-09-21 23:01:14 PDT
737 </div>
738 </div>
739 </body>
740 </html>