howto/keep-canonical-history-correct.html

   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>Keep authoritative canonical history correct with git pull</title>
   9 <style type="text/css">
  10 /* Shared CSS for AsciiDoc xhtml11 and html5 backends */
  11
  12 /* Default font. */
  13 body {
  14   font-family: Georgia,serif;
  15 }
  16
  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;
  25 }
  26
  27 body {
  28   margin: 1em 5% 1em 5%;
  29 }
  30
  31 a {
  32   color: blue;
  33   text-decoration: underline;
  34 }
  35 a:visited {
  36   color: fuchsia;
  37 }
  38
  39 em {
  40   font-style: italic;
  41   color: navy;
  42 }
  43
  44 strong {
  45   font-weight: bold;
  46   color: #083194;
  47 }
  48
  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;
  54 }
  55
  56 h1, h2, h3 {
  57   border-bottom: 2px solid silver;
  58 }
  59 h2 {
  60   padding-top: 0.5em;
  61 }
  62 h3 {
  63   float: left;
  64 }
  65 h3 + * {
  66   clear: left;
  67 }
  68 h5 {
  69   font-size: 1.0em;
  70 }
  71
  72 div.sectionbody {
  73   margin-left: 0;
  74 }
  75
  76 hr {
  77   border: 1px solid silver;
  78 }
  79
  80 p {
  81   margin-top: 0.5em;
  82   margin-bottom: 0.5em;
  83 }
  84
  85 ul, ol, li > p {
  86   margin-top: 0;
  87 }
  88 ul > li     { color: #aaa; }
  89 ul > li > * { color: black; }
  90
  91 .monospaced, code, pre {
  92   font-family: "Courier New", Courier, monospace;
  93   font-size: inherit;
  94   color: navy;
  95   padding: 0;
  96   margin: 0;
  97 }
  98 pre {
  99   white-space: pre-wrap;
 100 }
 101
 102 #author {
 103   color: #527bbd;
 104   font-weight: bold;
 105   font-size: 1.1em;
 106 }
 107 #email {
 108 }
 109 #revnumber, #revdate, #revremark {
 110 }
 111
 112 #footer {
 113   font-size: small;
 114   border-top: 2px solid silver;
 115   padding-top: 0.5em;
 116   margin-top: 4.0em;
 117 }
 118 #footer-text {
 119   float: left;
 120   padding-bottom: 0.5em;
 121 }
 122 #footer-badges {
 123   float: right;
 124   padding-bottom: 0.5em;
 125 }
 126
 127 #preamble {
 128   margin-top: 1.5em;
 129   margin-bottom: 1.5em;
 130 }
 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;
 136 }
 137 div.admonitionblock {
 138   margin-top: 2.0em;
 139   margin-bottom: 2.0em;
 140   margin-right: 10%;
 141   color: #606060;
 142 }
 143
 144 div.content { /* Block element content. */
 145   padding: 0;
 146 }
 147
 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;
 155 }
 156 div.title + * {
 157   margin-top: 0;
 158 }
 159
 160 td div.title:first-child {
 161   margin-top: 0.0em;
 162 }
 163 div.content div.title:first-child {
 164   margin-top: 0.0em;
 165 }
 166 div.content + div.title {
 167   margin-top: 0.0em;
 168 }
 169
 170 div.sidebarblock > div.content {
 171   background: #ffffee;
 172   border: 1px solid #dddddd;
 173   border-left: 4px solid #f0f0f0;
 174   padding: 0.5em;
 175 }
 176
 177 div.listingblock > div.content {
 178   border: 1px solid #dddddd;
 179   border-left: 5px solid #f0f0f0;
 180   background: #f8f8f8;
 181   padding: 0.5em;
 182 }
 183
 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;
 190 }
 191
 192 div.quoteblock > div.attribution {
 193   padding-top: 0.5em;
 194   text-align: right;
 195 }
 196
 197 div.verseblock > pre.content {
 198   font-family: inherit;
 199   font-size: inherit;
 200 }
 201 div.verseblock > div.attribution {
 202   padding-top: 0.75em;
 203   text-align: left;
 204 }
 205 /* DEPRECATED: Pre version 8.2.7 verse style literal block. */
 206 div.verseblock + div.attribution {
 207   text-align: left;
 208 }
 209
 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;
 217 }
 218 div.admonitionblock td.content {
 219   padding-left: 0.5em;
 220   border-left: 3px solid #dddddd;
 221 }
 222
 223 div.exampleblock > div.content {
 224   border-left: 3px solid #dddddd;
 225   padding-left: 0.5em;
 226 }
 227
 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; }
 231
 232 dl {
 233   margin-top: 0.8em;
 234   margin-bottom: 0.8em;
 235 }
 236 dt {
 237   margin-top: 0.5em;
 238   margin-bottom: 0;
 239   font-style: normal;
 240   color: navy;
 241 }
 242 dd > *:first-child {
 243   margin-top: 0.1em;
 244 }
 245
 246 ul, ol {
 247     list-style-position: outside;
 248 }
 249 ol.arabic {
 250   list-style-type: decimal;
 251 }
 252 ol.loweralpha {
 253   list-style-type: lower-alpha;
 254 }
 255 ol.upperalpha {
 256   list-style-type: upper-alpha;
 257 }
 258 ol.lowerroman {
 259   list-style-type: lower-roman;
 260 }
 261 ol.upperroman {
 262   list-style-type: upper-roman;
 263 }
 264
 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;
 270 }
 271
 272 tfoot {
 273   font-weight: bold;
 274 }
 275 td > div.verse {
 276   white-space: pre;
 277 }
 278
 279 div.hdlist {
 280   margin-top: 0.8em;
 281   margin-bottom: 0.8em;
 282 }
 283 div.hdlist tr {
 284   padding-bottom: 15px;
 285 }
 286 dt.hdlist1.strong, td.hdlist1.strong {
 287   font-weight: bold;
 288 }
 289 td.hdlist1 {
 290   vertical-align: top;
 291   font-style: normal;
 292   padding-right: 0.8em;
 293   color: navy;
 294 }
 295 td.hdlist2 {
 296   vertical-align: top;
 297 }
 298 div.hdlist.compact tr {
 299   margin: 0;
 300   padding-bottom: 0;
 301 }
 302
 303 .comment {
 304   background: yellow;
 305 }
 306
 307 .footnote, .footnoteref {
 308   font-size: 0.8em;
 309 }
 310
 311 span.footnote, span.footnoteref {
 312   vertical-align: super;
 313 }
 314
 315 #footnotes {
 316   margin: 20px 0 20px 0;
 317   padding: 7px 0 0 0;
 318 }
 319
 320 #footnotes div.footnote {
 321   margin: 0 0 5px 0;
 322 }
 323
 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;
 332 }
 333
 334 div.colist td {
 335   padding-right: 0.5em;
 336   padding-bottom: 0.3em;
 337   vertical-align: top;
 338 }
 339 div.colist td img {
 340   margin-top: 0.3em;
 341 }
 342
 343 @media print {
 344   #footer-badges { display: none; }
 345 }
 346
 347 #toc {
 348   margin-bottom: 2.5em;
 349 }
 350
 351 #toctitle {
 352   color: #527bbd;
 353   font-size: 1.1em;
 354   font-weight: bold;
 355   margin-top: 1.0em;
 356   margin-bottom: 0.1em;
 357 }
 358
 359 div.toclevel0, div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
 360   margin-top: 0;
 361   margin-bottom: 0;
 362 }
 363 div.toclevel2 {
 364   margin-left: 2em;
 365   font-size: 0.9em;
 366 }
 367 div.toclevel3 {
 368   margin-left: 4em;
 369   font-size: 0.9em;
 370 }
 371 div.toclevel4 {
 372   margin-left: 6em;
 373   font-size: 0.9em;
 374 }
 375
 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; }
 392
 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; }
 409
 410 span.big { font-size: 2em; }
 411 span.small { font-size: 0.6em; }
 412
 413 span.underline { text-decoration: underline; }
 414 span.overline { text-decoration: overline; }
 415 span.line-through { text-decoration: line-through; }
 416
 417 div.unbreakable { page-break-inside: avoid; }
 418
 419
 420 /*
 421  * xhtml11 specific
 422  *
 423  * */
 424
 425 div.tableblock {
 426   margin-top: 1.0em;
 427   margin-bottom: 1.5em;
 428 }
 429 div.tableblock > table {
 430   border: 3px solid #527bbd;
 431 }
 432 thead, p.table.header {
 433   font-weight: bold;
 434   color: #527bbd;
 435 }
 436 p.table {
 437   margin-top: 0;
 438 }
 439 /* Because the table frame attribute is overridden by CSS in most browsers. */
 440 div.tableblock > table[frame="void"] {
 441   border-style: none;
 442 }
 443 div.tableblock > table[frame="hsides"] {
 444   border-left-style: none;
 445   border-right-style: none;
 446 }
 447 div.tableblock > table[frame="vsides"] {
 448   border-top-style: none;
 449   border-bottom-style: none;
 450 }
 451
 452
 453 /*
 454  * html5 specific
 455  *
 456  * */
 457
 458 table.tableblock {
 459   margin-top: 1.0em;
 460   margin-bottom: 1.5em;
 461 }
 462 thead, p.tableblock.header {
 463   font-weight: bold;
 464   color: #527bbd;
 465 }
 466 p.tableblock {
 467   margin-top: 0;
 468 }
 469 table.tableblock {
 470   border-width: 3px;
 471   border-spacing: 0px;
 472   border-style: solid;
 473   border-color: #527bbd;
 474   border-collapse: collapse;
 475 }
 476 th.tableblock, td.tableblock {
 477   border-width: 1px;
 478   padding: 4px;
 479   border-style: solid;
 480   border-color: #527bbd;
 481 }
 482
 483 table.tableblock.frame-topbot {
 484   border-left-style: hidden;
 485   border-right-style: hidden;
 486 }
 487 table.tableblock.frame-sides {
 488   border-top-style: hidden;
 489   border-bottom-style: hidden;
 490 }
 491 table.tableblock.frame-none {
 492   border-style: hidden;
 493 }
 494
 495 th.tableblock.halign-left, td.tableblock.halign-left {
 496   text-align: left;
 497 }
 498 th.tableblock.halign-center, td.tableblock.halign-center {
 499   text-align: center;
 500 }
 501 th.tableblock.halign-right, td.tableblock.halign-right {
 502   text-align: right;
 503 }
 504
 505 th.tableblock.valign-top, td.tableblock.valign-top {
 506   vertical-align: top;
 507 }
 508 th.tableblock.valign-middle, td.tableblock.valign-middle {
 509   vertical-align: middle;
 510 }
 511 th.tableblock.valign-bottom, td.tableblock.valign-bottom {
 512   vertical-align: bottom;
 513 }
 514
 515
 516 /*
 517  * manpage specific
 518  *
 519  * */
 520
 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;
 526 }
 527 body.manpage h2 {
 528   border-style: none;
 529 }
 530 body.manpage div.sectionbody {
 531   margin-left: 3em;
 532 }
 533
 534 @media print {
 535   body.manpage div#toc { display: none; }
 536 }
 537
 538
 539 </style>
 540 <script type="text/javascript">
 541 /*<![CDATA[*/
 542 var asciidoc = {  // Namespace.
 543
 544 /////////////////////////////////////////////////////////////////////
 545 // Table Of Contents generator
 546 /////////////////////////////////////////////////////////////////////
 547
 548 /* Author: Mihai Bazon, September 2002
 549  * http://students.infoiasi.ro/~mishoo
 550  *
 551  * Table Of Content generator
 552  * Version: 0.4
 553  *
 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.
 556  */
 557
 558  /* modified by Troy D. Hanson, September 2006. License: GPL */
 559  /* modified by Stuart Rackham, 2006, 2009. License: GPL */
 560
 561 // toclevels = 1..4.
 562 toc: function (toclevels) {
 563
 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);
 571     }
 572     return text;
 573   }
 574
 575   function TocEntry(el, text, toclevel) {
 576     this.element = el;
 577     this.text = text;
 578     this.toclevel = toclevel;
 579   }
 580
 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);
 593           }
 594           iterate(i);
 595         }
 596       }
 597     }
 598     iterate(el);
 599     return result;
 600   }
 601
 602   var toc = document.getElementById("toc");
 603   if (!toc) {
 604     return;
 605   }
 606
 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);
 616   }
 617   for (i = 0; i < tocEntriesToRemove.length; i++) {
 618     toc.removeChild(tocEntriesToRemove[i]);
 619   }
 620
 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);
 634   }
 635   if (entries.length == 0)
 636     toc.parentNode.removeChild(toc);
 637 },
 638
 639
 640 /////////////////////////////////////////////////////////////////////
 641 // Footnotes generator
 642 /////////////////////////////////////////////////////////////////////
 643
 644 /* Based on footnote generation code from:
 645  * http://www.brandspankingnew.net/archive/2005/07/format_footnote.html
 646  */
 647
 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;
 654   }
 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);
 660   }
 661   for (i = 0; i < entriesToRemove.length; i++) {
 662     noteholder.removeChild(entriesToRemove[i]);
 663   }
 664
 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);
 682       }
 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;
 689     }
 690   }
 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>]";
 703       }
 704     }
 705   }
 706 },
 707
 708 install: function(toclevels) {
 709   var timerId;
 710
 711   function reinstall() {
 712     asciidoc.footnotes();
 713     if (toclevels) {
 714       asciidoc.toc(toclevels);
 715     }
 716   }
 717
 718   function reinstallAndRemoveTimer() {
 719     clearInterval(timerId);
 720     reinstall();
 721   }
 722
 723   timerId = setInterval(reinstall, 500);
 724   if (document.addEventListener)
 725     document.addEventListener("DOMContentLoaded", reinstallAndRemoveTimer, false);
 726   else
 727     window.onload = reinstallAndRemoveTimer;
 728 }
 729
 730 }
 731 asciidoc.install();
 732 /*]]>*/
 733 </script>
 734 </head>
 735 <body class="article">
 736 <div id="header">
 737 <h1>Keep authoritative canonical history correct with git pull</h1>
 738 <span id="revdate">2024-03-15</span>
 739 </div>
 740 <div id="content">
 741 <div id="preamble">
 742 <div class="sectionbody">
 743 <div class="paragraph"><p>Sometimes a new project integrator will end up with project history
 744 that appears to be "backwards" from what other project developers
 745 expect. This howto presents a suggested integration workflow for
 746 maintaining a central repository.</p></div>
 747 <div class="paragraph"><p>Suppose that that central repository has this history:</p></div>
 748 <div class="listingblock">
 749 <div class="content">
 750 <pre><code>    ---o---o---A</code></pre>
 751 </div></div>
 752 <div class="paragraph"><p>which ends at commit <code>A</code> (time flows from left to right and each node
 753 in the graph is a commit, lines between them indicating parent-child
 754 relationship).</p></div>
 755 <div class="paragraph"><p>Then you clone it and work on your own commits, which leads you to
 756 have this history in <strong>your</strong> repository:</p></div>
 757 <div class="listingblock">
 758 <div class="content">
 759 <pre><code>    ---o---o---A---B---C</code></pre>
 760 </div></div>
 761 <div class="paragraph"><p>Imagine your coworker did the same and built on top of <code>A</code> in <strong>his</strong>
 762 repository in the meantime, and then pushed it to the
 763 central repository:</p></div>
 764 <div class="listingblock">
 765 <div class="content">
 766 <pre><code>    ---o---o---A---X---Y---Z</code></pre>
 767 </div></div>
 768 <div class="paragraph"><p>Now, if you <code>git push</code> at this point, because your history that leads
 769 to <code>C</code> lacks <code>X</code>, <code>Y</code> and <code>Z</code>, it will fail.  You need to somehow make
 770 the tip of your history a descendant of <code>Z</code>.</p></div>
 771 <div class="paragraph"><p>One suggested way to solve the problem is "fetch and then merge", aka
 772 <code>git pull</code>. When you fetch, your repository will have a history like
 773 this:</p></div>
 774 <div class="listingblock">
 775 <div class="content">
 776 <pre><code>    ---o---o---A---B---C
 777                 \
 778                  X---Y---Z</code></pre>
 779 </div></div>
 780 <div class="paragraph"><p>Once you run merge after that, while still on <strong>your</strong> branch, i.e. <code>C</code>,
 781 you will create a merge <code>M</code> and make the history look like this:</p></div>
 782 <div class="listingblock">
 783 <div class="content">
 784 <pre><code>    ---o---o---A---B---C---M
 785                 \         /
 786                  X---Y---Z</code></pre>
 787 </div></div>
 788 <div class="paragraph"><p><code>M</code> is a descendant of <code>Z</code>, so you can push to update the central
 789 repository.  Such a merge <code>M</code> does not lose any commit in both
 790 histories, so in that sense it may not be wrong, but when people want
 791 to talk about "the authoritative canonical history that is shared
 792 among the project participants", i.e. "the trunk", they often view
 793 it as "commits you see by following the first-parent chain", and use
 794 this command to view it:</p></div>
 795 <div class="listingblock">
 796 <div class="content">
 797 <pre><code>    $ git log --first-parent</code></pre>
 798 </div></div>
 799 <div class="paragraph"><p>For all other people who observed the central repository after your
 800 coworker pushed <code>Z</code> but before you pushed <code>M</code>, the commit on the trunk
 801 used to be <code>o-o-A-X-Y-Z</code>.  But because you made <code>M</code> while you were on
 802 <code>C</code>, <code>M</code>'s first parent is <code>C</code>, so by pushing <code>M</code> to advance the
 803 central repository, you made <code>X-Y-Z</code> a side branch, not on the trunk.</p></div>
 804 <div class="paragraph"><p>You would rather want to have a history of this shape:</p></div>
 805 <div class="listingblock">
 806 <div class="content">
 807 <pre><code>    ---o---o---A---X---Y---Z---M'
 808                 \             /
 809                  B-----------C</code></pre>
 810 </div></div>
 811 <div class="paragraph"><p>so that in the first-parent chain, it is clear that the project first
 812 did <code>X</code> and then <code>Y</code> and then <code>Z</code> and merged a change that consists of
 813 two commits <code>B</code> and <code>C</code> that achieves a single goal.  You may have
 814 worked on fixing the bug #12345 with these two patches, and the merge
 815 <code>M'</code> with swapped parents can say in its log message "Merge
 816 fix-bug-12345". Having a way to tell <code>git pull</code> to create a merge
 817 but record the parents in reverse order may be a way to do so.</p></div>
 818 <div class="paragraph"><p>Note that I said "achieves a single goal" above, because this is
 819 important.  "Swapping the merge order" only covers a special case
 820 where the project does not care too much about having unrelated
 821 things done on a single merge but cares a lot about first-parent
 822 chain.</p></div>
 823 <div class="paragraph"><p>There are multiple schools of thought about the "trunk" management.</p></div>
 824 <div class="olist arabic"><ol class="arabic">
 825 <li>
 826 <p>
 827 Some projects want to keep a completely linear history without any
 828     merges.  Obviously, swapping the merge order would not match their
 829     taste.  You would need to flatten your history on top of the
 830     updated upstream to result in a history of this shape instead:
 831 </p>
 832 <div class="listingblock">
 833 <div class="content">
 834 <pre><code>    ---o---o---A---X---Y---Z---B---C</code></pre>
 835 </div></div>
 836 <div class="paragraph"><p>with <code>git pull --rebase</code> or something.</p></div>
 837 </li>
 838 <li>
 839 <p>
 840 Some projects tolerate merges in their history, but do not worry
 841     too much about the first-parent order, and allow fast-forward
 842     merges.  To them, swapping the merge order does not hurt, but
 843     it is unnecessary.
 844 </p>
 845 </li>
 846 <li>
 847 <p>
 848 Some projects want each commit on the "trunk" to do one single
 849     thing.  The output of <code>git log --first-parent</code> in such a project
 850     would show either a merge of a side branch that completes a single
 851     theme, or a single commit that completes a single theme by itself.
 852     If your two commits <code>B</code> and <code>C</code> (or they may even be two groups of
 853     commits) were solving two independent issues, then the merge <code>M'</code>
 854     we made in the earlier example by swapping the merge order is
 855     still not up to the project standard.  It merges two unrelated
 856     efforts <code>B</code> and <code>C</code> at the same time.
 857 </p>
 858 </li>
 859 </ol></div>
 860 <div class="paragraph"><p>For projects in the last category (Git itself is one of them),
 861 individual developers would want to prepare a history more like
 862 this:</p></div>
 863 <div class="listingblock">
 864 <div class="content">
 865 <pre><code>                 C0--C1--C2     topic-c
 866                 /
 867     ---o---o---A                master
 868                 \
 869                  B0--B1--B2     topic-b</code></pre>
 870 </div></div>
 871 <div class="paragraph"><p>That is, keeping separate topics on separate branches, perhaps like
 872 so:</p></div>
 873 <div class="listingblock">
 874 <div class="content">
 875 <pre><code>    $ git clone $URL work &amp;&amp; cd work
 876     $ git checkout -b topic-b master
 877     $ ... work to create B0, B1 and B2 to complete one theme
 878     $ git checkout -b topic-c master
 879     $ ... same for the theme of topic-c</code></pre>
 880 </div></div>
 881 <div class="paragraph"><p>And then</p></div>
 882 <div class="listingblock">
 883 <div class="content">
 884 <pre><code>    $ git checkout master
 885     $ git pull --ff-only</code></pre>
 886 </div></div>
 887 <div class="paragraph"><p>would grab <code>X</code>, <code>Y</code> and <code>Z</code> from the upstream and advance your master
 888 branch:</p></div>
 889 <div class="listingblock">
 890 <div class="content">
 891 <pre><code>                 C0--C1--C2     topic-c
 892                 /
 893     ---o---o---A---X---Y---Z    master
 894                 \
 895                  B0--B1--B2     topic-b</code></pre>
 896 </div></div>
 897 <div class="paragraph"><p>And then you would merge these two branches separately:</p></div>
 898 <div class="listingblock">
 899 <div class="content">
 900 <pre><code>    $ git merge topic-b
 901     $ git merge topic-c</code></pre>
 902 </div></div>
 903 <div class="paragraph"><p>to result in</p></div>
 904 <div class="listingblock">
 905 <div class="content">
 906 <pre><code>                 C0--C1---------C2
 907                 /                 \
 908     ---o---o---A---X---Y---Z---M---N
 909                 \             /
 910                  B0--B1-----B2</code></pre>
 911 </div></div>
 912 <div class="paragraph"><p>and push it back to the central repository.</p></div>
 913 <div class="paragraph"><p>It is very much possible that while you are merging topic-b and
 914 topic-c, somebody again advanced the history in the central repository
 915 to put <code>W</code> on top of <code>Z</code>, and make your <code>git push</code> fail.</p></div>
 916 <div class="paragraph"><p>In such a case, you would rewind to discard <code>M</code> and <code>N</code>, update the
 917 tip of your <em>master</em> again and redo the two merges:</p></div>
 918 <div class="listingblock">
 919 <div class="content">
 920 <pre><code>    $ git reset --hard origin/master
 921     $ git pull --ff-only
 922     $ git merge topic-b
 923     $ git merge topic-c</code></pre>
 924 </div></div>
 925 <div class="paragraph"><p>The procedure will result in a history that looks like this:</p></div>
 926 <div class="listingblock">
 927 <div class="content">
 928 <pre><code>                 C0--C1--------------C2
 929                 /                     \
 930     ---o---o---A---X---Y---Z---W---M'--N'
 931                 \                 /
 932                  B0--B1---------B2</code></pre>
 933 </div></div>
 934 <div class="paragraph"><p>See also <a href="https://git-blame.blogspot.com/2013/09/fun-with-first-parent-history.html">https://git-blame.blogspot.com/2013/09/fun-with-first-parent-history.html</a></p></div>
 935 </div>
 936 </div>
 937 </div>
 938 <div id="footnotes"><hr /></div>
 939 <div id="footer">
 940 <div id="footer-text">
 941 Last updated
 942  2024-03-15 16:25:17 PDT
 943 </div>
 944 </div>
 945 </body>
 946 </html>