Guilt v0.33 html docs
[guilt.git] / guilt.html
blob2c814825c154ec6789a010218b845f14115748cc
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>guilt(7)</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 /* Overrides for manpage documents */
377 h1 {
378 padding-top: 0.5em;
379 padding-bottom: 0.5em;
380 border-top: 2px solid silver;
381 border-bottom: 2px solid silver;
383 h2 {
384 border-style: none;
386 div.sectionbody {
387 margin-left: 5%;
390 @media print {
391 div#toc { display: none; }
394 /* Workarounds for IE6's broken and incomplete CSS2. */
396 div.sidebar-content {
397 background: #ffffee;
398 border: 1px solid silver;
399 padding: 0.5em;
401 div.sidebar-title, div.image-title {
402 color: #527bbd;
403 font-family: sans-serif;
404 font-weight: bold;
405 margin-top: 0.0em;
406 margin-bottom: 0.5em;
409 div.listingblock div.content {
410 border: 1px solid silver;
411 background: #f4f4f4;
412 padding: 0.5em;
415 div.quoteblock-attribution {
416 padding-top: 0.5em;
417 text-align: right;
420 div.verseblock-content {
421 white-space: pre;
423 div.verseblock-attribution {
424 padding-top: 0.75em;
425 text-align: left;
428 div.exampleblock-content {
429 border-left: 3px solid #dddddd;
430 padding-left: 0.5em;
433 /* IE6 sets dynamically generated links as visited. */
434 div#toc a:visited { color: blue; }
435 </style>
436 <script type="text/javascript">
437 /*<![CDATA[*/
438 window.onload = function(){asciidoc.footnotes();}
439 var asciidoc = { // Namespace.
441 /////////////////////////////////////////////////////////////////////
442 // Table Of Contents generator
443 /////////////////////////////////////////////////////////////////////
445 /* Author: Mihai Bazon, September 2002
446 * http://students.infoiasi.ro/~mishoo
448 * Table Of Content generator
449 * Version: 0.4
451 * Feel free to use this script under the terms of the GNU General Public
452 * License, as long as you do not remove or alter this notice.
455 /* modified by Troy D. Hanson, September 2006. License: GPL */
456 /* modified by Stuart Rackham, 2006, 2009. License: GPL */
458 // toclevels = 1..4.
459 toc: function (toclevels) {
461 function getText(el) {
462 var text = "";
463 for (var i = el.firstChild; i != null; i = i.nextSibling) {
464 if (i.nodeType == 3 /* Node.TEXT_NODE */) // IE doesn't speak constants.
465 text += i.data;
466 else if (i.firstChild != null)
467 text += getText(i);
469 return text;
472 function TocEntry(el, text, toclevel) {
473 this.element = el;
474 this.text = text;
475 this.toclevel = toclevel;
478 function tocEntries(el, toclevels) {
479 var result = new Array;
480 var re = new RegExp('[hH]([2-'+(toclevels+1)+'])');
481 // Function that scans the DOM tree for header elements (the DOM2
482 // nodeIterator API would be a better technique but not supported by all
483 // browsers).
484 var iterate = function (el) {
485 for (var i = el.firstChild; i != null; i = i.nextSibling) {
486 if (i.nodeType == 1 /* Node.ELEMENT_NODE */) {
487 var mo = re.exec(i.tagName);
488 if (mo && (i.getAttribute("class") || i.getAttribute("className")) != "float") {
489 result[result.length] = new TocEntry(i, getText(i), mo[1]-1);
491 iterate(i);
495 iterate(el);
496 return result;
499 var toc = document.getElementById("toc");
500 var entries = tocEntries(document.getElementById("content"), toclevels);
501 for (var i = 0; i < entries.length; ++i) {
502 var entry = entries[i];
503 if (entry.element.id == "")
504 entry.element.id = "_toc_" + i;
505 var a = document.createElement("a");
506 a.href = "#" + entry.element.id;
507 a.appendChild(document.createTextNode(entry.text));
508 var div = document.createElement("div");
509 div.appendChild(a);
510 div.className = "toclevel" + entry.toclevel;
511 toc.appendChild(div);
513 if (entries.length == 0)
514 toc.parentNode.removeChild(toc);
518 /////////////////////////////////////////////////////////////////////
519 // Footnotes generator
520 /////////////////////////////////////////////////////////////////////
522 /* Based on footnote generation code from:
523 * http://www.brandspankingnew.net/archive/2005/07/format_footnote.html
526 footnotes: function () {
527 var cont = document.getElementById("content");
528 var noteholder = document.getElementById("footnotes");
529 var spans = cont.getElementsByTagName("span");
530 var refs = {};
531 var n = 0;
532 for (i=0; i<spans.length; i++) {
533 if (spans[i].className == "footnote") {
534 n++;
535 // Use [\s\S] in place of . so multi-line matches work.
536 // Because JavaScript has no s (dotall) regex flag.
537 note = spans[i].innerHTML.match(/\s*\[([\s\S]*)]\s*/)[1];
538 noteholder.innerHTML +=
539 "<div class='footnote' id='_footnote_" + n + "'>" +
540 "<a href='#_footnoteref_" + n + "' title='Return to text'>" +
541 n + "</a>. " + note + "</div>";
542 spans[i].innerHTML =
543 "[<a id='_footnoteref_" + n + "' href='#_footnote_" + n +
544 "' title='View footnote' class='footnote'>" + n + "</a>]";
545 var id =spans[i].getAttribute("id");
546 if (id != null) refs["#"+id] = n;
549 if (n == 0)
550 noteholder.parentNode.removeChild(noteholder);
551 else {
552 // Process footnoterefs.
553 for (i=0; i<spans.length; i++) {
554 if (spans[i].className == "footnoteref") {
555 var href = spans[i].getElementsByTagName("a")[0].getAttribute("href");
556 href = href.match(/#.*/)[0]; // Because IE return full URL.
557 n = refs[href];
558 spans[i].innerHTML =
559 "[<a href='#_footnote_" + n +
560 "' title='View footnote' class='footnote'>" + n + "</a>]";
567 /*]]>*/
568 </script>
569 </head>
570 <body>
571 <div id="header">
572 <h1>
573 guilt(7) Manual Page
574 </h1>
575 <h2>NAME</h2>
576 <div class="sectionbody">
577 <p>guilt -
578 quilt on top of git
579 </p>
580 </div>
581 </div>
582 <div id="content">
583 <h2 id="_synopsis">SYNOPSIS</h2>
584 <div class="sectionbody">
585 <div class="paragraph"><p><em>guilt</em> COMMAND [ARGS]</p></div>
586 </div>
587 <h2 id="_description">DESCRIPTION</h2>
588 <div class="sectionbody">
589 <div class="paragraph"><p>Andrew Morton originally developed a set of scripts for maintaining kernel
590 patches outside of any SCM tool. Others extended these into a suite called
591 quilt. The basic idea behind quilt is to maintain patches instead of
592 maintaining source files. Patches can be added, removed or reordered, and
593 they can be refreshed as you fix bugs or update to a new base revision.
594 quilt is very powerful, but it is not integrated with the underlying SCM
595 tools. This makes it difficult to visualize your changes.</p></div>
596 <div class="paragraph"><p>Guilt allows one to use quilt functionality on top of a Git repository.
597 Changes are maintained as patches which are committed into Git. Commits can
598 be removed or reordered, and the underlying patch can be refreshed based on
599 changes made in the working directory. The patch directory can also be
600 placed under revision control, so you can have a separate history of changes
601 made to your patches.</p></div>
602 </div>
603 <h2 id="_patches_directory">PATCHES DIRECTORY</h2>
604 <div class="sectionbody">
605 <div class="paragraph"><p>In Guilt, all the patches are stored in .git/patches/$branch/, where $branch
606 is the name of the branch being worked on. This means that one can have a
607 independent series of patches for each branch present in the repository.
608 Each of these per-branch directories contains 3 special files:</p></div>
609 <div class="paragraph"><p>guards: This file contains any guards that should be applied to the
610 series when pushing. It is only present when guards are selected.</p></div>
611 <div class="paragraph"><p>series: This file contains a list of all the patch filenames relative to the
612 per-branch patch directory. Empty and commented out lines are ignored.</p></div>
613 <div class="paragraph"><p>status: This file contains the state of the stack. What patches are applied.</p></div>
614 </div>
615 <h2 id="_hooks">HOOKS</h2>
616 <div class="sectionbody">
617 <div class="paragraph"><p>Any guilt operation may execute zero or more hook scripts which can be used
618 to run any housekeeping commands or even abort the execution of the command.</p></div>
619 </div>
620 <h2 id="_hooks_directory">HOOKS DIRECTORY</h2>
621 <div class="sectionbody">
622 <div class="paragraph"><p>Guilt follows the same basic design of hooks in Git itself. All Guilt hooks
623 are executable files (generally shell scripts, but they can be anything the
624 operating system can execute) in .git/hooks/guilt/.</p></div>
625 <div class="paragraph"><p>The following hooks are supported:</p></div>
626 <div class="dlist"><dl>
627 <dt class="hdlist1">
628 delete &lt;patch name&gt;
629 </dt>
630 <dd>
632 Executed when a patch is deleted from the patch series via
633 linkguilt:guilt-delete[1].
634 </p>
635 </dd>
636 </dl></div>
637 </div>
638 <h2 id="_guilt_commands">GUILT COMMANDS</h2>
639 <div class="sectionbody">
640 <div class="paragraph"><p>All commands can be called with or without a dash. e.g. <em>guilt add</em> or
641 <em>guilt-add</em></p></div>
642 <div class="dlist"><dl>
643 <dt class="hdlist1">
644 linkguilt:guilt-add[1]
645 </dt>
646 <dd>
648 guilt-add - Add a file to git and guilt.
649 </p>
650 </dd>
651 <dt class="hdlist1">
652 linkguilt:guilt-applied[1]
653 </dt>
654 <dd>
656 guilt-applied - List applied patches.
657 </p>
658 </dd>
659 <dt class="hdlist1">
660 linkguilt:guilt-branch[1]
661 </dt>
662 <dd>
664 guilt-branch - Branch the entire patch series.
665 </p>
666 </dd>
667 <dt class="hdlist1">
668 linkguilt:guilt-commit[1]
669 </dt>
670 <dd>
672 guilt-commit - Commit specified number of patches.
673 </p>
674 </dd>
675 <dt class="hdlist1">
676 linkguilt:guilt-delete[1]
677 </dt>
678 <dd>
680 guilt-delete - Delete a patch.
681 </p>
682 </dd>
683 <dt class="hdlist1">
684 linkguilt:guilt-diff[1]
685 </dt>
686 <dd>
688 guilt-diff - Outputs various diffs.
689 </p>
690 </dd>
691 <dt class="hdlist1">
692 linkguilt:guilt-export[1]
693 </dt>
694 <dd>
696 guilt-export - Export a patch series (to be used by quilt).
697 </p>
698 </dd>
699 <dt class="hdlist1">
700 linkguilt:guilt-files[1]
701 </dt>
702 <dd>
704 guilt-files - Print the list of files that the topmost patch changes.
705 </p>
706 </dd>
707 <dt class="hdlist1">
708 linkguilt:guilt-fold[1]
709 </dt>
710 <dd>
712 guilt-fold - Fold a specified patch into the topmost applied patch.
713 </p>
714 </dd>
715 <dt class="hdlist1">
716 linkguilt:guilt-fork[1]
717 </dt>
718 <dd>
720 guilt-fork - Fork the topmost applied patch.
721 </p>
722 </dd>
723 <dt class="hdlist1">
724 linkguilt:guilt-graph[1]
725 </dt>
726 <dd>
728 guilt-graph - Create a patch dependency graph.
729 </p>
730 </dd>
731 <dt class="hdlist1">
732 linkguilt:guilt-guard[1]
733 </dt>
734 <dd>
736 guilt-guard - Assign guards to patches.
737 </p>
738 </dd>
739 <dt class="hdlist1">
740 linkguilt:guilt-header[1]
741 </dt>
742 <dd>
744 guilt-header - Print a patch header.
745 </p>
746 </dd>
747 <dt class="hdlist1">
748 linkguilt:guilt-help[1]
749 </dt>
750 <dd>
752 guilt-help - open man page of a guilt command.
753 </p>
754 </dd>
755 <dt class="hdlist1">
756 linkguilt:guilt-import-commit[1]
757 </dt>
758 <dd>
760 guilt-import-commit - Import one or more commits as patches.
761 </p>
762 </dd>
763 <dt class="hdlist1">
764 linkguilt:guilt-import[1]
765 </dt>
766 <dd>
768 guilt-import - Import specified patch file.
769 </p>
770 </dd>
771 <dt class="hdlist1">
772 linkguilt:guilt-init[1]
773 </dt>
774 <dd>
776 guilt-init - Initialize guilt for use in a git repository.
777 </p>
778 </dd>
779 <dt class="hdlist1">
780 linkguilt:guilt-new[1]
781 </dt>
782 <dd>
784 guilt-new - Create a new patch.
785 </p>
786 </dd>
787 <dt class="hdlist1">
788 linkguilt:guilt-next[1]
789 </dt>
790 <dd>
792 guilt-next - Output the name of next patch to be pushed.
793 </p>
794 </dd>
795 <dt class="hdlist1">
796 linkguilt:guilt-patchbomb[1]
797 </dt>
798 <dd>
800 guilt-patchbomb - Email a series of commits interactively.
801 </p>
802 </dd>
803 <dt class="hdlist1">
804 linkguilt:guilt-pop[1]
805 </dt>
806 <dd>
808 guilt-pop - Pop patches from the tree.
809 </p>
810 </dd>
811 <dt class="hdlist1">
812 linkguilt:guilt-prev[1]
813 </dt>
814 <dd>
816 guilt-prev - Output name of second topmost applied patch.
817 </p>
818 </dd>
819 <dt class="hdlist1">
820 linkguilt:guilt-push[1]
821 </dt>
822 <dd>
824 guilt-push - Push patches onto the tree.
825 </p>
826 </dd>
827 <dt class="hdlist1">
828 linkguilt:guilt-rebase[1]
829 </dt>
830 <dd>
832 guilt-rebase - Rebase pushed patches.
833 </p>
834 </dd>
835 <dt class="hdlist1">
836 linkguilt:guilt-refresh[1]
837 </dt>
838 <dd>
840 guilt-refresh - Refresh topmost applied patch.
841 </p>
842 </dd>
843 <dt class="hdlist1">
844 linkguilt:guilt-repair[1]
845 </dt>
846 <dd>
848 guilt-repair - Repair the repository state.
849 </p>
850 </dd>
851 <dt class="hdlist1">
852 linkguilt:guilt-rm[1]
853 </dt>
854 <dd>
856 guilt-rm - Remove a file from the git tree and guilt.
857 </p>
858 </dd>
859 <dt class="hdlist1">
860 linkguilt:guilt-select[1]
861 </dt>
862 <dd>
864 guilt-select - Select guards to apply when pushing patches.
865 </p>
866 </dd>
867 <dt class="hdlist1">
868 linkguilt:guilt-series[1]
869 </dt>
870 <dd>
872 guilt-series - Print the stack of patches.
873 </p>
874 </dd>
875 <dt class="hdlist1">
876 linkguilt:guilt-status[1]
877 </dt>
878 <dd>
880 guilt-status - Print the status of files since the last refresh.
881 </p>
882 </dd>
883 <dt class="hdlist1">
884 linkguilt:guilt-top[1]
885 </dt>
886 <dd>
888 guilt-top - Output name of topmost applied patch.
889 </p>
890 </dd>
891 <dt class="hdlist1">
892 linkguilt:guilt-unapplied[1]
893 </dt>
894 <dd>
896 guilt-unapplied - List all unapplied patches.
897 </p>
898 </dd>
899 </dl></div>
900 </div>
901 <h2 id="_author">Author</h2>
902 <div class="sectionbody">
903 <div class="paragraph"><p>Written by Josef "Jeff" Sipek &lt;<a href="mailto:jeffpc@josefsipek.net">jeffpc@josefsipek.net</a>&gt;</p></div>
904 </div>
905 <h2 id="_documentation">Documentation</h2>
906 <div class="sectionbody">
907 <div class="paragraph"><p>Documentation by Brandon Philips &lt;<a href="mailto:brandon@ifup.org">brandon@ifup.org</a>&gt; and Josef "Jeff" Sipek
908 &lt;<a href="mailto:jeffpc@josefsipek.net">jeffpc@josefsipek.net</a>&gt;</p></div>
909 </div>
910 <h2 id="_guilt">GUILT</h2>
911 <div class="sectionbody">
912 <div class="paragraph"><p>Part of the linkguilt:guilt[7] suite
913 (Generated for Guilt v0.33)</p></div>
914 </div>
915 </div>
916 <div id="footnotes"><hr /></div>
917 <div id="footer">
918 <div id="footer-text">
919 Last updated 2010-04-15 22:51:05 EDT
920 </div>
921 </div>
922 </body>
923 </html>