Autogenerated HTML docs for v2.44.0-270-g2953d
[git-htmldocs.git] / howto / maintain-git.html
blob30f70a850ba32b0b2a2ac0023b14202700dfcbfd
1 <?xml version="1.0" encoding="UTF-8"?>
2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
3 "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
4 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
5 <head>
6 <meta http-equiv="Content-Type" content="application/xhtml+xml; charset=UTF-8" />
7 <meta name="generator" content="AsciiDoc 10.2.0" />
8 <title>How to maintain Git</title>
9 <style type="text/css">
10 /* Shared CSS for AsciiDoc xhtml11 and html5 backends */
12 /* Default font. */
13 body {
14 font-family: Georgia,serif;
17 /* Title font. */
18 h1, h2, h3, h4, h5, h6,
19 div.title, caption.title,
20 thead, p.table.header,
21 #toctitle,
22 #author, #revnumber, #revdate, #revremark,
23 #footer {
24 font-family: Arial,Helvetica,sans-serif;
27 body {
28 margin: 1em 5% 1em 5%;
31 a {
32 color: blue;
33 text-decoration: underline;
35 a:visited {
36 color: fuchsia;
39 em {
40 font-style: italic;
41 color: navy;
44 strong {
45 font-weight: bold;
46 color: #083194;
49 h1, h2, h3, h4, h5, h6 {
50 color: #527bbd;
51 margin-top: 1.2em;
52 margin-bottom: 0.5em;
53 line-height: 1.3;
56 h1, h2, h3 {
57 border-bottom: 2px solid silver;
59 h2 {
60 padding-top: 0.5em;
62 h3 {
63 float: left;
65 h3 + * {
66 clear: left;
68 h5 {
69 font-size: 1.0em;
72 div.sectionbody {
73 margin-left: 0;
76 hr {
77 border: 1px solid silver;
80 p {
81 margin-top: 0.5em;
82 margin-bottom: 0.5em;
85 ul, ol, li > p {
86 margin-top: 0;
88 ul > li { color: #aaa; }
89 ul > li > * { color: black; }
91 .monospaced, code, pre {
92 font-family: "Courier New", Courier, monospace;
93 font-size: inherit;
94 color: navy;
95 padding: 0;
96 margin: 0;
98 pre {
99 white-space: pre-wrap;
102 #author {
103 color: #527bbd;
104 font-weight: bold;
105 font-size: 1.1em;
107 #email {
109 #revnumber, #revdate, #revremark {
112 #footer {
113 font-size: small;
114 border-top: 2px solid silver;
115 padding-top: 0.5em;
116 margin-top: 4.0em;
118 #footer-text {
119 float: left;
120 padding-bottom: 0.5em;
122 #footer-badges {
123 float: right;
124 padding-bottom: 0.5em;
127 #preamble {
128 margin-top: 1.5em;
129 margin-bottom: 1.5em;
131 div.imageblock, div.exampleblock, div.verseblock,
132 div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
133 div.admonitionblock {
134 margin-top: 1.0em;
135 margin-bottom: 1.5em;
137 div.admonitionblock {
138 margin-top: 2.0em;
139 margin-bottom: 2.0em;
140 margin-right: 10%;
141 color: #606060;
144 div.content { /* Block element content. */
145 padding: 0;
148 /* Block element titles. */
149 div.title, caption.title {
150 color: #527bbd;
151 font-weight: bold;
152 text-align: left;
153 margin-top: 1.0em;
154 margin-bottom: 0.5em;
156 div.title + * {
157 margin-top: 0;
160 td div.title:first-child {
161 margin-top: 0.0em;
163 div.content div.title:first-child {
164 margin-top: 0.0em;
166 div.content + div.title {
167 margin-top: 0.0em;
170 div.sidebarblock > div.content {
171 background: #ffffee;
172 border: 1px solid #dddddd;
173 border-left: 4px solid #f0f0f0;
174 padding: 0.5em;
177 div.listingblock > div.content {
178 border: 1px solid #dddddd;
179 border-left: 5px solid #f0f0f0;
180 background: #f8f8f8;
181 padding: 0.5em;
184 div.quoteblock, div.verseblock {
185 padding-left: 1.0em;
186 margin-left: 1.0em;
187 margin-right: 10%;
188 border-left: 5px solid #f0f0f0;
189 color: #888;
192 div.quoteblock > div.attribution {
193 padding-top: 0.5em;
194 text-align: right;
197 div.verseblock > pre.content {
198 font-family: inherit;
199 font-size: inherit;
201 div.verseblock > div.attribution {
202 padding-top: 0.75em;
203 text-align: left;
205 /* DEPRECATED: Pre version 8.2.7 verse style literal block. */
206 div.verseblock + div.attribution {
207 text-align: left;
210 div.admonitionblock .icon {
211 vertical-align: top;
212 font-size: 1.1em;
213 font-weight: bold;
214 text-decoration: underline;
215 color: #527bbd;
216 padding-right: 0.5em;
218 div.admonitionblock td.content {
219 padding-left: 0.5em;
220 border-left: 3px solid #dddddd;
223 div.exampleblock > div.content {
224 border-left: 3px solid #dddddd;
225 padding-left: 0.5em;
228 div.imageblock div.content { padding-left: 0; }
229 span.image img { border-style: none; vertical-align: text-bottom; }
230 a.image:visited { color: white; }
232 dl {
233 margin-top: 0.8em;
234 margin-bottom: 0.8em;
236 dt {
237 margin-top: 0.5em;
238 margin-bottom: 0;
239 font-style: normal;
240 color: navy;
242 dd > *:first-child {
243 margin-top: 0.1em;
246 ul, ol {
247 list-style-position: outside;
249 ol.arabic {
250 list-style-type: decimal;
252 ol.loweralpha {
253 list-style-type: lower-alpha;
255 ol.upperalpha {
256 list-style-type: upper-alpha;
258 ol.lowerroman {
259 list-style-type: lower-roman;
261 ol.upperroman {
262 list-style-type: upper-roman;
265 div.compact ul, div.compact ol,
266 div.compact p, div.compact p,
267 div.compact div, div.compact div {
268 margin-top: 0.1em;
269 margin-bottom: 0.1em;
272 tfoot {
273 font-weight: bold;
275 td > div.verse {
276 white-space: pre;
279 div.hdlist {
280 margin-top: 0.8em;
281 margin-bottom: 0.8em;
283 div.hdlist tr {
284 padding-bottom: 15px;
286 dt.hdlist1.strong, td.hdlist1.strong {
287 font-weight: bold;
289 td.hdlist1 {
290 vertical-align: top;
291 font-style: normal;
292 padding-right: 0.8em;
293 color: navy;
295 td.hdlist2 {
296 vertical-align: top;
298 div.hdlist.compact tr {
299 margin: 0;
300 padding-bottom: 0;
303 .comment {
304 background: yellow;
307 .footnote, .footnoteref {
308 font-size: 0.8em;
311 span.footnote, span.footnoteref {
312 vertical-align: super;
315 #footnotes {
316 margin: 20px 0 20px 0;
317 padding: 7px 0 0 0;
320 #footnotes div.footnote {
321 margin: 0 0 5px 0;
324 #footnotes hr {
325 border: none;
326 border-top: 1px solid silver;
327 height: 1px;
328 text-align: left;
329 margin-left: 0;
330 width: 20%;
331 min-width: 100px;
334 div.colist td {
335 padding-right: 0.5em;
336 padding-bottom: 0.3em;
337 vertical-align: top;
339 div.colist td img {
340 margin-top: 0.3em;
343 @media print {
344 #footer-badges { display: none; }
347 #toc {
348 margin-bottom: 2.5em;
351 #toctitle {
352 color: #527bbd;
353 font-size: 1.1em;
354 font-weight: bold;
355 margin-top: 1.0em;
356 margin-bottom: 0.1em;
359 div.toclevel0, div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
360 margin-top: 0;
361 margin-bottom: 0;
363 div.toclevel2 {
364 margin-left: 2em;
365 font-size: 0.9em;
367 div.toclevel3 {
368 margin-left: 4em;
369 font-size: 0.9em;
371 div.toclevel4 {
372 margin-left: 6em;
373 font-size: 0.9em;
376 span.aqua { color: aqua; }
377 span.black { color: black; }
378 span.blue { color: blue; }
379 span.fuchsia { color: fuchsia; }
380 span.gray { color: gray; }
381 span.green { color: green; }
382 span.lime { color: lime; }
383 span.maroon { color: maroon; }
384 span.navy { color: navy; }
385 span.olive { color: olive; }
386 span.purple { color: purple; }
387 span.red { color: red; }
388 span.silver { color: silver; }
389 span.teal { color: teal; }
390 span.white { color: white; }
391 span.yellow { color: yellow; }
393 span.aqua-background { background: aqua; }
394 span.black-background { background: black; }
395 span.blue-background { background: blue; }
396 span.fuchsia-background { background: fuchsia; }
397 span.gray-background { background: gray; }
398 span.green-background { background: green; }
399 span.lime-background { background: lime; }
400 span.maroon-background { background: maroon; }
401 span.navy-background { background: navy; }
402 span.olive-background { background: olive; }
403 span.purple-background { background: purple; }
404 span.red-background { background: red; }
405 span.silver-background { background: silver; }
406 span.teal-background { background: teal; }
407 span.white-background { background: white; }
408 span.yellow-background { background: yellow; }
410 span.big { font-size: 2em; }
411 span.small { font-size: 0.6em; }
413 span.underline { text-decoration: underline; }
414 span.overline { text-decoration: overline; }
415 span.line-through { text-decoration: line-through; }
417 div.unbreakable { page-break-inside: avoid; }
421 * xhtml11 specific
423 * */
425 div.tableblock {
426 margin-top: 1.0em;
427 margin-bottom: 1.5em;
429 div.tableblock > table {
430 border: 3px solid #527bbd;
432 thead, p.table.header {
433 font-weight: bold;
434 color: #527bbd;
436 p.table {
437 margin-top: 0;
439 /* Because the table frame attribute is overridden by CSS in most browsers. */
440 div.tableblock > table[frame="void"] {
441 border-style: none;
443 div.tableblock > table[frame="hsides"] {
444 border-left-style: none;
445 border-right-style: none;
447 div.tableblock > table[frame="vsides"] {
448 border-top-style: none;
449 border-bottom-style: none;
454 * html5 specific
456 * */
458 table.tableblock {
459 margin-top: 1.0em;
460 margin-bottom: 1.5em;
462 thead, p.tableblock.header {
463 font-weight: bold;
464 color: #527bbd;
466 p.tableblock {
467 margin-top: 0;
469 table.tableblock {
470 border-width: 3px;
471 border-spacing: 0px;
472 border-style: solid;
473 border-color: #527bbd;
474 border-collapse: collapse;
476 th.tableblock, td.tableblock {
477 border-width: 1px;
478 padding: 4px;
479 border-style: solid;
480 border-color: #527bbd;
483 table.tableblock.frame-topbot {
484 border-left-style: hidden;
485 border-right-style: hidden;
487 table.tableblock.frame-sides {
488 border-top-style: hidden;
489 border-bottom-style: hidden;
491 table.tableblock.frame-none {
492 border-style: hidden;
495 th.tableblock.halign-left, td.tableblock.halign-left {
496 text-align: left;
498 th.tableblock.halign-center, td.tableblock.halign-center {
499 text-align: center;
501 th.tableblock.halign-right, td.tableblock.halign-right {
502 text-align: right;
505 th.tableblock.valign-top, td.tableblock.valign-top {
506 vertical-align: top;
508 th.tableblock.valign-middle, td.tableblock.valign-middle {
509 vertical-align: middle;
511 th.tableblock.valign-bottom, td.tableblock.valign-bottom {
512 vertical-align: bottom;
517 * manpage specific
519 * */
521 body.manpage h1 {
522 padding-top: 0.5em;
523 padding-bottom: 0.5em;
524 border-top: 2px solid silver;
525 border-bottom: 2px solid silver;
527 body.manpage h2 {
528 border-style: none;
530 body.manpage div.sectionbody {
531 margin-left: 3em;
534 @media print {
535 body.manpage div#toc { display: none; }
539 </style>
540 <script type="text/javascript">
541 /*<![CDATA[*/
542 var asciidoc = { // Namespace.
544 /////////////////////////////////////////////////////////////////////
545 // Table Of Contents generator
546 /////////////////////////////////////////////////////////////////////
548 /* Author: Mihai Bazon, September 2002
549 * http://students.infoiasi.ro/~mishoo
551 * Table Of Content generator
552 * Version: 0.4
554 * Feel free to use this script under the terms of the GNU General Public
555 * License, as long as you do not remove or alter this notice.
558 /* modified by Troy D. Hanson, September 2006. License: GPL */
559 /* modified by Stuart Rackham, 2006, 2009. License: GPL */
561 // toclevels = 1..4.
562 toc: function (toclevels) {
564 function getText(el) {
565 var text = "";
566 for (var i = el.firstChild; i != null; i = i.nextSibling) {
567 if (i.nodeType == 3 /* Node.TEXT_NODE */) // IE doesn't speak constants.
568 text += i.data;
569 else if (i.firstChild != null)
570 text += getText(i);
572 return text;
575 function TocEntry(el, text, toclevel) {
576 this.element = el;
577 this.text = text;
578 this.toclevel = toclevel;
581 function tocEntries(el, toclevels) {
582 var result = new Array;
583 var re = new RegExp('[hH]([1-'+(toclevels+1)+'])');
584 // Function that scans the DOM tree for header elements (the DOM2
585 // nodeIterator API would be a better technique but not supported by all
586 // browsers).
587 var iterate = function (el) {
588 for (var i = el.firstChild; i != null; i = i.nextSibling) {
589 if (i.nodeType == 1 /* Node.ELEMENT_NODE */) {
590 var mo = re.exec(i.tagName);
591 if (mo && (i.getAttribute("class") || i.getAttribute("className")) != "float") {
592 result[result.length] = new TocEntry(i, getText(i), mo[1]-1);
594 iterate(i);
598 iterate(el);
599 return result;
602 var toc = document.getElementById("toc");
603 if (!toc) {
604 return;
607 // Delete existing TOC entries in case we're reloading the TOC.
608 var tocEntriesToRemove = [];
609 var i;
610 for (i = 0; i < toc.childNodes.length; i++) {
611 var entry = toc.childNodes[i];
612 if (entry.nodeName.toLowerCase() == 'div'
613 && entry.getAttribute("class")
614 && entry.getAttribute("class").match(/^toclevel/))
615 tocEntriesToRemove.push(entry);
617 for (i = 0; i < tocEntriesToRemove.length; i++) {
618 toc.removeChild(tocEntriesToRemove[i]);
621 // Rebuild TOC entries.
622 var entries = tocEntries(document.getElementById("content"), toclevels);
623 for (var i = 0; i < entries.length; ++i) {
624 var entry = entries[i];
625 if (entry.element.id == "")
626 entry.element.id = "_toc_" + i;
627 var a = document.createElement("a");
628 a.href = "#" + entry.element.id;
629 a.appendChild(document.createTextNode(entry.text));
630 var div = document.createElement("div");
631 div.appendChild(a);
632 div.className = "toclevel" + entry.toclevel;
633 toc.appendChild(div);
635 if (entries.length == 0)
636 toc.parentNode.removeChild(toc);
640 /////////////////////////////////////////////////////////////////////
641 // Footnotes generator
642 /////////////////////////////////////////////////////////////////////
644 /* Based on footnote generation code from:
645 * http://www.brandspankingnew.net/archive/2005/07/format_footnote.html
648 footnotes: function () {
649 // Delete existing footnote entries in case we're reloading the footnodes.
650 var i;
651 var noteholder = document.getElementById("footnotes");
652 if (!noteholder) {
653 return;
655 var entriesToRemove = [];
656 for (i = 0; i < noteholder.childNodes.length; i++) {
657 var entry = noteholder.childNodes[i];
658 if (entry.nodeName.toLowerCase() == 'div' && entry.getAttribute("class") == "footnote")
659 entriesToRemove.push(entry);
661 for (i = 0; i < entriesToRemove.length; i++) {
662 noteholder.removeChild(entriesToRemove[i]);
665 // Rebuild footnote entries.
666 var cont = document.getElementById("content");
667 var spans = cont.getElementsByTagName("span");
668 var refs = {};
669 var n = 0;
670 for (i=0; i<spans.length; i++) {
671 if (spans[i].className == "footnote") {
672 n++;
673 var note = spans[i].getAttribute("data-note");
674 if (!note) {
675 // Use [\s\S] in place of . so multi-line matches work.
676 // Because JavaScript has no s (dotall) regex flag.
677 note = spans[i].innerHTML.match(/\s*\[([\s\S]*)]\s*/)[1];
678 spans[i].innerHTML =
679 "[<a id='_footnoteref_" + n + "' href='#_footnote_" + n +
680 "' title='View footnote' class='footnote'>" + n + "</a>]";
681 spans[i].setAttribute("data-note", note);
683 noteholder.innerHTML +=
684 "<div class='footnote' id='_footnote_" + n + "'>" +
685 "<a href='#_footnoteref_" + n + "' title='Return to text'>" +
686 n + "</a>. " + note + "</div>";
687 var id =spans[i].getAttribute("id");
688 if (id != null) refs["#"+id] = n;
691 if (n == 0)
692 noteholder.parentNode.removeChild(noteholder);
693 else {
694 // Process footnoterefs.
695 for (i=0; i<spans.length; i++) {
696 if (spans[i].className == "footnoteref") {
697 var href = spans[i].getElementsByTagName("a")[0].getAttribute("href");
698 href = href.match(/#.*/)[0]; // Because IE return full URL.
699 n = refs[href];
700 spans[i].innerHTML =
701 "[<a href='#_footnote_" + n +
702 "' title='View footnote' class='footnote'>" + n + "</a>]";
708 install: function(toclevels) {
709 var timerId;
711 function reinstall() {
712 asciidoc.footnotes();
713 if (toclevels) {
714 asciidoc.toc(toclevels);
718 function reinstallAndRemoveTimer() {
719 clearInterval(timerId);
720 reinstall();
723 timerId = setInterval(reinstall, 500);
724 if (document.addEventListener)
725 document.addEventListener("DOMContentLoaded", reinstallAndRemoveTimer, false);
726 else
727 window.onload = reinstallAndRemoveTimer;
731 asciidoc.install();
732 /*]]>*/
733 </script>
734 </head>
735 <body class="article">
736 <div id="header">
737 <h1>How to maintain Git</h1>
738 <span id="revdate">2024-03-15</span>
739 </div>
740 <div id="content">
741 <div class="sect1">
742 <h2 id="_activities">Activities</h2>
743 <div class="sectionbody">
744 <div class="paragraph"><p>The maintainer&#8217;s Git time is spent on three activities.</p></div>
745 <div class="ulist"><ul>
746 <li>
748 Communication (45%)
749 </p>
750 <div class="literalblock">
751 <div class="content">
752 <pre><code>Mailing list discussions on general design, fielding user
753 questions, diagnosing bug reports; reviewing, commenting on,
754 suggesting alternatives to, and rejecting patches.</code></pre>
755 </div></div>
756 </li>
757 <li>
759 Integration (50%)
760 </p>
761 <div class="literalblock">
762 <div class="content">
763 <pre><code>Applying new patches from the contributors while spotting and
764 correcting minor mistakes, shuffling the integration and
765 testing branches, pushing the results out, cutting the
766 releases, and making announcements.</code></pre>
767 </div></div>
768 </li>
769 <li>
771 Own development (5%)
772 </p>
773 <div class="literalblock">
774 <div class="content">
775 <pre><code>Scratching my own itch and sending proposed patch series out.</code></pre>
776 </div></div>
777 </li>
778 </ul></div>
779 </div>
780 </div>
781 <div class="sect1">
782 <h2 id="_the_policy">The Policy</h2>
783 <div class="sectionbody">
784 <div class="paragraph"><p>The policy on Integration is informally mentioned in "A Note
785 from the maintainer" message, which is periodically posted to
786 this mailing list after each feature release is made.</p></div>
787 <div class="ulist"><ul>
788 <li>
790 Feature releases are numbered as vX.Y.0 and are meant to
791 contain bugfixes and enhancements in any area, including
792 functionality, performance and usability, without regression.
793 </p>
794 </li>
795 <li>
797 One release cycle for a feature release is expected to last for
798 eight to ten weeks.
799 </p>
800 </li>
801 <li>
803 Maintenance releases are numbered as vX.Y.Z and are meant
804 to contain only bugfixes for the corresponding vX.Y.0 feature
805 release and earlier maintenance releases vX.Y.W (W &lt; Z).
806 </p>
807 </li>
808 <li>
810 <em>master</em> branch is used to prepare for the next feature
811 release. In other words, at some point, the tip of <em>master</em>
812 branch is tagged with vX.Y.0.
813 </p>
814 </li>
815 <li>
817 <em>maint</em> branch is used to prepare for the next maintenance
818 release. After the feature release vX.Y.0 is made, the tip
819 of <em>maint</em> branch is set to that release, and bugfixes will
820 accumulate on the branch, and at some point, the tip of the
821 branch is tagged with vX.Y.1, vX.Y.2, and so on.
822 </p>
823 </li>
824 <li>
826 <em>next</em> branch is used to publish changes (both enhancements
827 and fixes) that (1) have worthwhile goal, (2) are in a fairly
828 good shape suitable for everyday use, (3) but have not yet
829 demonstrated to be regression free. New changes are tested
830 in <em>next</em> before merged to <em>master</em>.
831 </p>
832 </li>
833 <li>
835 <em>seen</em> branch is used to publish other proposed changes that do
836 not yet pass the criteria set for <em>next</em>.
837 </p>
838 </li>
839 <li>
841 The tips of <em>master</em> and <em>maint</em> branches will not be rewound to
842 allow people to build their own customization on top of them.
843 Early in a new development cycle, <em>next</em> is rewound to the tip of
844 <em>master</em> once, but otherwise it will not be rewound until the end
845 of the cycle.
846 </p>
847 </li>
848 <li>
850 Usually <em>master</em> contains all of <em>maint</em> and <em>next</em> contains all
851 of <em>master</em>. <em>seen</em> contains all the topics merged to <em>next</em>, but
852 is rebuilt directly on <em>master</em>.
853 </p>
854 </li>
855 <li>
857 The tip of <em>master</em> is meant to be more stable than any
858 tagged releases, and the users are encouraged to follow it.
859 </p>
860 </li>
861 <li>
863 The <em>next</em> branch is where new action takes place, and the
864 users are encouraged to test it so that regressions and bugs
865 are found before new topics are merged to <em>master</em>.
866 </p>
867 </li>
868 </ul></div>
869 <div class="paragraph"><p>Note that before v1.9.0 release, the version numbers used to be
870 structured slightly differently. vX.Y.Z were feature releases while
871 vX.Y.Z.W were maintenance releases for vX.Y.Z.</p></div>
872 </div>
873 </div>
874 <div class="sect1">
875 <h2 id="_a_typical_git_day">A Typical Git Day</h2>
876 <div class="sectionbody">
877 <div class="paragraph"><p>A typical Git day for the maintainer implements the above policy
878 by doing the following:</p></div>
879 <div class="ulist"><ul>
880 <li>
882 Scan mailing list. Respond with review comments, suggestions
883 etc. Kibitz. Collect potentially usable patches from the
884 mailing list. Patches about a single topic go to one mailbox (I
885 read my mail in Gnus, and type \C-o to save/append messages in
886 files in mbox format).
887 </p>
888 </li>
889 <li>
891 Write his own patches to address issues raised on the list but
892 nobody has stepped up to solve. Send it out just like other
893 contributors do, and pick them up just like patches from other
894 contributors (see above).
895 </p>
896 </li>
897 <li>
899 Review the patches in the saved mailboxes. Edit proposed log
900 message for typofixes and clarifications, and add Acks
901 collected from the list. Edit patch to incorporate "Oops,
902 that should have been like this" fixes from the discussion.
903 </p>
904 </li>
905 <li>
907 Classify the collected patches and handle <em>master</em> and
908 <em>maint</em> updates:
909 </p>
910 </li>
911 <li>
913 Obviously correct fixes that pertain to the tip of <em>maint</em>
914 are directly applied to <em>maint</em>.
915 </p>
916 </li>
917 <li>
919 Obviously correct fixes that pertain to the tip of <em>master</em>
920 are directly applied to <em>master</em>.
921 </p>
922 </li>
923 <li>
925 Other topics are not handled in this step.
926 </p>
927 <div class="literalblock">
928 <div class="content">
929 <pre><code>This step is done with "git am".</code></pre>
930 </div></div>
931 <div class="literalblock">
932 <div class="content">
933 <pre><code>$ git checkout master ;# or "git checkout maint"
934 $ git am -sc3 mailbox
935 $ make test</code></pre>
936 </div></div>
937 <div class="literalblock">
938 <div class="content">
939 <pre><code>In practice, almost no patch directly goes to 'master' or
940 'maint'.</code></pre>
941 </div></div>
942 </li>
943 <li>
945 Review the last issue of "What&#8217;s cooking" message, review the
946 topics ready for merging (topic&#8594;master and topic&#8594;maint). Use
947 "Meta/cook -w" script (where Meta/ contains a checkout of the
948 <em>todo</em> branch) to aid this step.
949 </p>
950 <div class="literalblock">
951 <div class="content">
952 <pre><code>And perform the merge. Use "Meta/Reintegrate -e" script (see
953 later) to aid this step.</code></pre>
954 </div></div>
955 <div class="literalblock">
956 <div class="content">
957 <pre><code>$ Meta/cook -w last-issue-of-whats-cooking.mbox</code></pre>
958 </div></div>
959 <div class="literalblock">
960 <div class="content">
961 <pre><code>$ git checkout master ;# or "git checkout maint"
962 $ echo ai/topic | Meta/Reintegrate -e ;# "git merge ai/topic"
963 $ git log -p ORIG_HEAD.. ;# final review
964 $ git diff ORIG_HEAD.. ;# final review
965 $ make test ;# final review</code></pre>
966 </div></div>
967 </li>
968 <li>
970 Handle the remaining patches:
971 </p>
972 </li>
973 <li>
975 Anything unobvious that is applicable to <em>master</em> (in other
976 words, does not depend on anything that is still in <em>next</em>
977 and not in <em>master</em>) is applied to a new topic branch that
978 is forked from the tip of <em>master</em> (or the last feature release,
979 which is a bit older than <em>master</em>). This includes both
980 enhancements and unobvious fixes to <em>master</em>. A topic
981 branch is named as ai/topic where "ai" is two-letter string
982 named after author&#8217;s initial and "topic" is a descriptive name
983 of the topic (in other words, "what&#8217;s the series is about").
984 </p>
985 </li>
986 <li>
988 An unobvious fix meant for <em>maint</em> is applied to a new
989 topic branch that is forked from the tip of <em>maint</em> (or the
990 oldest and still relevant maintenance branch). The
991 topic may be named as ai/maint-topic.
992 </p>
993 </li>
994 <li>
996 Changes that pertain to an existing topic are applied to
997 the branch, but:
998 </p>
999 </li>
1000 <li>
1002 obviously correct ones are applied first;
1003 </p>
1004 </li>
1005 <li>
1007 questionable ones are discarded or applied to near the tip;
1008 </p>
1009 </li>
1010 <li>
1012 Replacement patches to an existing topic are accepted only
1013 for commits not in <em>next</em>.
1014 </p>
1015 <div class="literalblock">
1016 <div class="content">
1017 <pre><code>The initial round is done with:</code></pre>
1018 </div></div>
1019 <div class="literalblock">
1020 <div class="content">
1021 <pre><code>$ git checkout ai/topic ;# or "git checkout -b ai/topic master"
1022 $ git am -sc3 mailbox</code></pre>
1023 </div></div>
1024 <div class="literalblock">
1025 <div class="content">
1026 <pre><code>and replacing an existing topic with subsequent round is done with:</code></pre>
1027 </div></div>
1028 <div class="literalblock">
1029 <div class="content">
1030 <pre><code>$ git checkout master...ai/topic ;# try to reapply to the same base
1031 $ git am -sc3 mailbox</code></pre>
1032 </div></div>
1033 <div class="literalblock">
1034 <div class="content">
1035 <pre><code>to prepare the new round on a detached HEAD, and then</code></pre>
1036 </div></div>
1037 <div class="literalblock">
1038 <div class="content">
1039 <pre><code>$ git range-diff @{-1}...
1040 $ git diff @{-1}</code></pre>
1041 </div></div>
1042 <div class="literalblock">
1043 <div class="content">
1044 <pre><code>to double check what changed since the last round, and finally</code></pre>
1045 </div></div>
1046 <div class="literalblock">
1047 <div class="content">
1048 <pre><code>$ git checkout -B @{-1}</code></pre>
1049 </div></div>
1050 <div class="literalblock">
1051 <div class="content">
1052 <pre><code>to conclude (the last step is why a topic already in 'next' is
1053 not replaced but updated incrementally).</code></pre>
1054 </div></div>
1055 <div class="literalblock">
1056 <div class="content">
1057 <pre><code>Whether it is the initial round or a subsequent round, the topic
1058 may not build even in isolation, or may break the build when
1059 merged to integration branches due to bugs. There may already
1060 be obvious and trivial improvements suggested on the list. The
1061 maintainer often adds an extra commit, with "SQUASH???" in its
1062 title, to fix things up, before publishing the integration
1063 branches to make it usable by other developers for testing.
1064 These changes are what the maintainer is not 100% committed to
1065 (trivial typofixes etc. are often squashed directly into the
1066 patches that need fixing, without being applied as a separate
1067 "SQUASH???" commit), so that they can be removed easily as needed.</code></pre>
1068 </div></div>
1069 </li>
1070 <li>
1072 Merge maint to master as needed:
1073 </p>
1074 <div class="literalblock">
1075 <div class="content">
1076 <pre><code>$ git checkout master
1077 $ git merge maint
1078 $ make test</code></pre>
1079 </div></div>
1080 </li>
1081 <li>
1083 Merge master to next as needed:
1084 </p>
1085 <div class="literalblock">
1086 <div class="content">
1087 <pre><code>$ git checkout next
1088 $ git merge master
1089 $ make test</code></pre>
1090 </div></div>
1091 </li>
1092 <li>
1094 Review the last issue of "What&#8217;s cooking" again and see if topics
1095 that are ready to be merged to <em>next</em> are still in good shape
1096 (e.g. has there any new issue identified on the list with the
1097 series?)
1098 </p>
1099 </li>
1100 <li>
1102 Prepare <em>jch</em> branch, which is used to represent somewhere
1103 between <em>master</em> and <em>seen</em> and often is slightly ahead of <em>next</em>.
1104 </p>
1105 <div class="literalblock">
1106 <div class="content">
1107 <pre><code>$ Meta/Reintegrate master..jch &gt;Meta/redo-jch.sh</code></pre>
1108 </div></div>
1109 <div class="literalblock">
1110 <div class="content">
1111 <pre><code>The result is a script that lists topics to be merged in order to
1112 rebuild 'seen' as the input to Meta/Reintegrate script. Remove
1113 later topics that should not be in 'jch' yet. Add a line that
1114 consists of '### match next' before the name of the first topic
1115 in the output that should be in 'jch' but not in 'next' yet.</code></pre>
1116 </div></div>
1117 </li>
1118 <li>
1120 Now we are ready to start merging topics to <em>next</em>. For each
1121 branch whose tip is not merged to <em>next</em>, one of three things can
1122 happen:
1123 </p>
1124 </li>
1125 <li>
1127 The commits are all next-worthy; merge the topic to next;
1128 </p>
1129 </li>
1130 <li>
1132 The new parts are of mixed quality, but earlier ones are
1133 next-worthy; merge the early parts to next;
1134 </p>
1135 </li>
1136 <li>
1138 Nothing is next-worthy; do not do anything.
1139 </p>
1140 <div class="literalblock">
1141 <div class="content">
1142 <pre><code>This step is aided with Meta/redo-jch.sh script created earlier.
1143 If a topic that was already in 'next' gained a patch, the script
1144 would list it as "ai/topic~1". To include the new patch to the
1145 updated 'next', drop the "~1" part; to keep it excluded, do not
1146 touch the line. If a topic that was not in 'next' should be
1147 merged to 'next', add it at the end of the list. Then:</code></pre>
1148 </div></div>
1149 <div class="literalblock">
1150 <div class="content">
1151 <pre><code>$ git checkout -B jch master
1152 $ sh Meta/redo-jch.sh -c1</code></pre>
1153 </div></div>
1154 <div class="literalblock">
1155 <div class="content">
1156 <pre><code>to rebuild the 'jch' branch from scratch. "-c1" tells the script
1157 to stop merging at the first line that begins with '###'
1158 (i.e. the "### match next" line you added earlier).</code></pre>
1159 </div></div>
1160 <div class="literalblock">
1161 <div class="content">
1162 <pre><code>At this point, build-test the result. It may reveal semantic
1163 conflicts (e.g. a topic renamed a variable, another added a new
1164 reference to the variable under its old name), in which case
1165 prepare an appropriate merge-fix first (see appendix), and
1166 rebuild the 'jch' branch from scratch, starting at the tip of
1167 'master'.</code></pre>
1168 </div></div>
1169 <div class="literalblock">
1170 <div class="content">
1171 <pre><code>Then do the same to 'next'</code></pre>
1172 </div></div>
1173 <div class="literalblock">
1174 <div class="content">
1175 <pre><code>$ git checkout next
1176 $ sh Meta/redo-jch.sh -c1 -e</code></pre>
1177 </div></div>
1178 <div class="literalblock">
1179 <div class="content">
1180 <pre><code>The "-e" option allows the merge message that comes from the
1181 history of the topic and the comments in the "What's cooking" to
1182 be edited. The resulting tree should match 'jch' as the same set
1183 of topics are merged on 'master'; otherwise there is a mismerge.
1184 Investigate why and do not proceed until the mismerge is found
1185 and rectified.</code></pre>
1186 </div></div>
1187 <div class="literalblock">
1188 <div class="content">
1189 <pre><code>$ git diff jch next</code></pre>
1190 </div></div>
1191 <div class="literalblock">
1192 <div class="content">
1193 <pre><code>Then build the rest of 'jch':</code></pre>
1194 </div></div>
1195 <div class="literalblock">
1196 <div class="content">
1197 <pre><code>$ git checkout jch
1198 $ sh Meta/redo-jch.sh</code></pre>
1199 </div></div>
1200 <div class="literalblock">
1201 <div class="content">
1202 <pre><code>When all is well, clean up the redo-jch.sh script with</code></pre>
1203 </div></div>
1204 <div class="literalblock">
1205 <div class="content">
1206 <pre><code>$ sh Meta/redo-jch.sh -u</code></pre>
1207 </div></div>
1208 <div class="literalblock">
1209 <div class="content">
1210 <pre><code>This removes topics listed in the script that have already been
1211 merged to 'master'. This may lose '### match next' marker;
1212 add it again to the appropriate place when it happens.</code></pre>
1213 </div></div>
1214 </li>
1215 <li>
1217 Rebuild <em>seen</em>.
1218 </p>
1219 <div class="literalblock">
1220 <div class="content">
1221 <pre><code>$ Meta/Reintegrate jch..seen &gt;Meta/redo-seen.sh</code></pre>
1222 </div></div>
1223 <div class="literalblock">
1224 <div class="content">
1225 <pre><code>Edit the result by adding new topics that are not still in 'seen'
1226 in the script. Then</code></pre>
1227 </div></div>
1228 <div class="literalblock">
1229 <div class="content">
1230 <pre><code>$ git checkout -B seen jch
1231 $ sh Meta/redo-seen.sh</code></pre>
1232 </div></div>
1233 <div class="literalblock">
1234 <div class="content">
1235 <pre><code>When all is well, clean up the redo-seen.sh script with</code></pre>
1236 </div></div>
1237 <div class="literalblock">
1238 <div class="content">
1239 <pre><code>$ sh Meta/redo-seen.sh -u</code></pre>
1240 </div></div>
1241 <div class="literalblock">
1242 <div class="content">
1243 <pre><code>Double check by running</code></pre>
1244 </div></div>
1245 <div class="literalblock">
1246 <div class="content">
1247 <pre><code>$ git branch --no-merged seen</code></pre>
1248 </div></div>
1249 <div class="literalblock">
1250 <div class="content">
1251 <pre><code>to see there is no unexpected leftover topics.</code></pre>
1252 </div></div>
1253 <div class="literalblock">
1254 <div class="content">
1255 <pre><code>At this point, build-test the result for semantic conflicts, and
1256 if there are, prepare an appropriate merge-fix first (see
1257 appendix), and rebuild the 'seen' branch from scratch, starting at
1258 the tip of 'jch'.</code></pre>
1259 </div></div>
1260 </li>
1261 <li>
1263 Update "What&#8217;s cooking" message to review the updates to
1264 existing topics, newly added topics and graduated topics.
1265 </p>
1266 <div class="literalblock">
1267 <div class="content">
1268 <pre><code>This step is helped with Meta/cook script.</code></pre>
1269 </div></div>
1270 <div class="literalblock">
1271 <div class="content">
1272 <pre><code>$ Meta/cook</code></pre>
1273 </div></div>
1274 <div class="literalblock">
1275 <div class="content">
1276 <pre><code>This script inspects the history between master..seen, finds tips
1277 of topic branches, compares what it found with the current
1278 contents in Meta/whats-cooking.txt, and updates that file.
1279 Topics not listed in the file but are found in master..seen are
1280 added to the "New topics" section, topics listed in the file that
1281 are no longer found in master..seen are moved to the "Graduated to
1282 master" section, and topics whose commits changed their states
1283 (e.g. used to be only in 'seen', now merged to 'next') are updated
1284 with change markers "&lt;&lt;" and "&gt;&gt;".</code></pre>
1285 </div></div>
1286 <div class="literalblock">
1287 <div class="content">
1288 <pre><code>Look for lines enclosed in "&lt;&lt;" and "&gt;&gt;"; they hold contents from
1289 old file that are replaced by this integration round. After
1290 verifying them, remove the old part. Review the description for
1291 each topic and update its doneness and plan as needed. To review
1292 the updated plan, run</code></pre>
1293 </div></div>
1294 <div class="literalblock">
1295 <div class="content">
1296 <pre><code>$ Meta/cook -w</code></pre>
1297 </div></div>
1298 <div class="literalblock">
1299 <div class="content">
1300 <pre><code>which will pick up comments given to the topics, such as "Will
1301 merge to 'next'", etc. (see Meta/cook script to learn what kind
1302 of phrases are supported).</code></pre>
1303 </div></div>
1304 </li>
1305 <li>
1307 Compile, test and install all four (five) integration branches;
1308 Meta/Dothem script may aid this step.
1309 </p>
1310 </li>
1311 <li>
1313 Format documentation if the <em>master</em> branch was updated;
1314 Meta/dodoc.sh script may aid this step.
1315 </p>
1316 </li>
1317 <li>
1319 Push the integration branches out to public places; Meta/pushall
1320 script may aid this step.
1321 </p>
1322 </li>
1323 </ul></div>
1324 </div>
1325 </div>
1326 <div class="sect1">
1327 <h2 id="_observations">Observations</h2>
1328 <div class="sectionbody">
1329 <div class="paragraph"><p>Some observations to be made.</p></div>
1330 <div class="ulist"><ul>
1331 <li>
1333 Each topic is tested individually, and also together with other
1334 topics cooking first in <em>seen</em>, then in <em>jch</em> and then in <em>next</em>.
1335 Until it matures, no part of it is merged to <em>master</em>.
1336 </p>
1337 </li>
1338 <li>
1340 A topic already in <em>next</em> can get fixes while still in
1341 <em>next</em>. Such a topic will have many merges to <em>next</em> (in
1342 other words, "git log --first-parent next" will show many
1343 "Merge branch <em>ai/topic</em> to next" for the same topic.
1344 </p>
1345 </li>
1346 <li>
1348 An unobvious fix for <em>maint</em> is cooked in <em>next</em> and then
1349 merged to <em>master</em> to make extra sure it is Ok and then
1350 merged to <em>maint</em>.
1351 </p>
1352 </li>
1353 <li>
1355 Even when <em>next</em> becomes empty (in other words, all topics
1356 prove stable and are merged to <em>master</em> and "git diff master
1357 next" shows empty), it has tons of merge commits that will
1358 never be in <em>master</em>.
1359 </p>
1360 </li>
1361 <li>
1363 In principle, "git log --first-parent master..next" should
1364 show nothing but merges (in practice, there are fixup commits
1365 and reverts that are not merges).
1366 </p>
1367 </li>
1368 <li>
1370 Commits near the tip of a topic branch that are not in <em>next</em>
1371 are fair game to be discarded, replaced or rewritten.
1372 Commits already merged to <em>next</em> will not be.
1373 </p>
1374 </li>
1375 <li>
1377 Being in the <em>next</em> branch is not a guarantee for a topic to
1378 be included in the next feature release. Being in the
1379 <em>master</em> branch typically is.
1380 </p>
1381 </li>
1382 <li>
1384 Due to the nature of "SQUASH???" fix-ups, if the original author
1385 agrees with the suggested changes, it is OK to squash them to
1386 appropriate patches in the next round (when the suggested change
1387 is small enough, the author should not even bother with
1388 "Helped-by"). It is also OK to drop them from the next round
1389 when the original author does not agree with the suggestion, but
1390 the author is expected to say why somewhere in the discussion.
1391 </p>
1392 </li>
1393 </ul></div>
1394 </div>
1395 </div>
1396 <div class="sect1">
1397 <h2 id="_appendix">Appendix</h2>
1398 <div class="sectionbody">
1399 <div class="sect2">
1400 <h3 id="_preparing_a_merge_fix">Preparing a "merge-fix"</h3>
1401 <div class="paragraph"><p>A merge of two topics may not textually conflict but still have
1402 conflict at the semantic level. A classic example is for one topic
1403 to rename a variable and all its uses, while another topic adds a
1404 new use of the variable under its old name. When these two topics
1405 are merged together, the reference to the variable newly added by
1406 the latter topic will still use the old name in the result.</p></div>
1407 <div class="paragraph"><p>The Meta/Reintegrate script that is used by redo-jch and redo-seen
1408 scripts implements a crude but usable way to work around this issue.
1409 When the script merges branch $X, it checks if "refs/merge-fix/$X"
1410 exists, and if so, the effect of it is squashed into the result of
1411 the mechanical merge. In other words,</p></div>
1412 <div class="literalblock">
1413 <div class="content">
1414 <pre><code>$ echo $X | Meta/Reintegrate</code></pre>
1415 </div></div>
1416 <div class="paragraph"><p>is roughly equivalent to this sequence:</p></div>
1417 <div class="literalblock">
1418 <div class="content">
1419 <pre><code>$ git merge --rerere-autoupdate $X
1420 $ git commit
1421 $ git cherry-pick -n refs/merge-fix/$X
1422 $ git commit --amend</code></pre>
1423 </div></div>
1424 <div class="paragraph"><p>The goal of this "prepare a merge-fix" step is to come up with a
1425 commit that can be squashed into a result of mechanical merge to
1426 correct semantic conflicts.</p></div>
1427 <div class="paragraph"><p>After finding that the result of merging branch "ai/topic" to an
1428 integration branch had such a semantic conflict, say seen~4, check the
1429 problematic merge out on a detached HEAD, edit the working tree to
1430 fix the semantic conflict, and make a separate commit to record the
1431 fix-up:</p></div>
1432 <div class="literalblock">
1433 <div class="content">
1434 <pre><code>$ git checkout seen~4
1435 $ git show -s --pretty=%s ;# double check
1436 Merge branch 'ai/topic' to seen
1437 $ edit
1438 $ git commit -m 'merge-fix/ai/topic' -a</code></pre>
1439 </div></div>
1440 <div class="paragraph"><p>Then make a reference "refs/merge-fix/ai/topic" to point at this
1441 result:</p></div>
1442 <div class="literalblock">
1443 <div class="content">
1444 <pre><code>$ git update-ref refs/merge-fix/ai/topic HEAD</code></pre>
1445 </div></div>
1446 <div class="paragraph"><p>Then double check the result by asking Meta/Reintegrate to redo the
1447 merge:</p></div>
1448 <div class="literalblock">
1449 <div class="content">
1450 <pre><code>$ git checkout seen~5 ;# the parent of the problem merge
1451 $ echo ai/topic | Meta/Reintegrate
1452 $ git diff seen~4</code></pre>
1453 </div></div>
1454 <div class="paragraph"><p>This time, because you prepared refs/merge-fix/ai/topic, the
1455 resulting merge should have been tweaked to include the fix for the
1456 semantic conflict.</p></div>
1457 <div class="paragraph"><p>Note that this assumes that the order in which conflicting branches
1458 are merged does not change. If the reason why merging ai/topic
1459 branch needs this merge-fix is because another branch merged earlier
1460 to the integration branch changed the underlying assumption ai/topic
1461 branch made (e.g. ai/topic branch added a site to refer to a
1462 variable, while the other branch renamed that variable and adjusted
1463 existing use sites), and if you changed redo-jch (or redo-seen) script
1464 to merge ai/topic branch before the other branch, then the above
1465 merge-fix should not be applied while merging ai/topic, but should
1466 instead be applied while merging the other branch. You would need
1467 to move the fix to apply to the other branch, perhaps like this:</p></div>
1468 <div class="literalblock">
1469 <div class="content">
1470 <pre><code>$ mf=refs/merge-fix
1471 $ git update-ref $mf/$the_other_branch $mf/ai/topic
1472 $ git update-ref -d $mf/ai/topic</code></pre>
1473 </div></div>
1474 </div>
1475 </div>
1476 </div>
1477 </div>
1478 <div id="footnotes"><hr /></div>
1479 <div id="footer">
1480 <div id="footer-text">
1481 Last updated
1482 2024-03-15 16:25:17 PDT
1483 </div>
1484 </div>
1485 </body>
1486 </html>