summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorKent Fredric <kentfredric@gmail.com>2010-09-29 10:24:35 +1300
committerKent Fredric <kentfredric@gmail.com>2010-09-29 10:25:25 +1300
commitae9017f9a80027561cd35ecaf14981d6320db0a2 (patch)
treecbcc83abd3dc02cbf3efd92b20292b4737bf41ae
parent[doc] bundled config, smarter/saner/more valid output (diff)
downloadperl-overlay-ae9017f9a80027561cd35ecaf14981d6320db0a2.tar.gz
perl-overlay-ae9017f9a80027561cd35ecaf14981d6320db0a2.tar.bz2
perl-overlay-ae9017f9a80027561cd35ecaf14981d6320db0a2.zip
[doc] Simple simple references to linerizing commits
-rwxr-xr-xREADME/gendocs.sh4
-rw-r--r--README/git-tips.html44
-rw-r--r--README/git-tips.txt1
-rw-r--r--README/git-tips/linearize-commits.html624
-rw-r--r--README/git-tips/linearize-commits.txt32
5 files changed, 702 insertions, 3 deletions
diff --git a/README/gendocs.sh b/README/gendocs.sh
index 90a60e052..c15055891 100755
--- a/README/gendocs.sh
+++ b/README/gendocs.sh
@@ -3,6 +3,8 @@ DOCCMD="asciidoc -f config "
LINTCMD="xmllint --xmlout"
for i in git-tips.txt git-tips/*.txt ; do
base=${i%.txt}
+ html="${base}.html"
+ echo " $base -> $html "
$DOCCMD $i;
- $LINTCMD ${base}.html --output ${base}.html;
+ $LINTCMD ${html} --output ${html}
done
diff --git a/README/git-tips.html b/README/git-tips.html
index 55e2d11a7..af1042559 100644
--- a/README/git-tips.html
+++ b/README/git-tips.html
@@ -690,12 +690,54 @@ are doing.</td>
linearize commits. See <a href="linearize_commits.txt">Linearizing Commits</a></td>
</tr></table>
</div>
+<h3 id="linearizecommits">2.3. Linearize Commmits</h3><div style="clear:left"/>
+<div class="paragraph"><p>Messy commit histories with lots of needless merge branches just get confusing
+when trying to work backwards and work out what happened.</p></div>
+<div class="paragraph"><p>To resolve this issue, it is strongly recommended to utilize <tt>git rebase</tt> to
+simplify merge histories in a way as such it produces the illusion the merge
+never happened, and was never needed, as all the commits simply happend after
+all the other commits they were going to be merged into.</p></div>
+<div class="paragraph"><p>But the subject of <tt>git rebase</tt> is far too complex to summarise in this one
+document, at least for now, so you should use other online sources to learn
+this.</p></div>
+<h4 id="_advocates_of_git_rebase_theory">2.3.1. Advocates of Git Rebase/Theory</h4>
+<div class="dlist"><dl>
+<dt class="hdlist1">
+Tate Johnson
+</dt>
+<dd>
+<p>
+ <a href="http://tatey.com/2009/04/23/git-rebase-for-linear-history/">Git Rebase
+ For Linear History</a>
+</p>
+</dd>
+<dt class="hdlist1">
+Kent Fredric
+</dt>
+<dd>
+<p>
+ <a href="http://blog.fox.geek.nz/2010/08/git-rebase-part-1-why-you-should-use-it.html">Git
+ Rebase Part 1: Why you should use it, Theory.</a>
+</p>
+</dd>
+</dl></div>
+<h4 id="_rebase_guides">2.3.2. Rebase Guides</h4>
+<div class="dlist"><dl>
+<dt class="hdlist1">
+ProGit.org
+</dt>
+<dd>
+<p>
+ <a href="http://progit.org/book/ch3-6.html"> Rebase </a>
+</p>
+</dd>
+</dl></div>
</div>
</div>
<div id="footnotes"><hr/></div>
<div id="footer">
<div id="footer-text">
-Last updated 2010-09-29 09:22:59 NZDT
+Last updated 2010-09-29 10:11:56 NZDT
</div>
<div id="footer-badges">
Valid <a href="http://validator.w3.org/check?uri=referer">XHTML</a>
diff --git a/README/git-tips.txt b/README/git-tips.txt
index d4d9d5ca2..9fb69f9f9 100644
--- a/README/git-tips.txt
+++ b/README/git-tips.txt
@@ -12,4 +12,3 @@ Git
include::git-tips/repositories.txt[]
include::git-tips/contribution-order.txt[]
include::git-tips/linearize-commits.txt[]
-
diff --git a/README/git-tips/linearize-commits.html b/README/git-tips/linearize-commits.html
new file mode 100644
index 000000000..d896fc48a
--- /dev/null
+++ b/README/git-tips/linearize-commits.html
@@ -0,0 +1,624 @@
+<?xml version="1.0"?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
+<meta name="generator" content="AsciiDoc 8.5.3"/>
+<title>Linearize Commmits</title>
+<style type="text/css">
+/*<![CDATA[*/
+/* Debug borders */
+p, li, dt, dd, div, pre, h1, h2, h3, h4, h5, h6 {
+/*
+ border: 1px solid red;
+*/
+}
+
+body {
+ margin: 1em 5% 1em 5%;
+}
+
+a {
+ color: blue;
+ text-decoration: underline;
+}
+a:visited {
+ color: fuchsia;
+}
+
+em {
+ font-style: italic;
+ color: navy;
+}
+
+strong {
+ font-weight: bold;
+ color: #083194;
+}
+
+tt {
+ color: navy;
+}
+
+h1, h2, h3, h4, h5, h6 {
+ color: #527bbd;
+ font-family: sans-serif;
+ margin-top: 1.2em;
+ margin-bottom: 0.5em;
+ line-height: 1.3;
+}
+
+h1, h2, h3 {
+ border-bottom: 2px solid silver;
+}
+h2 {
+ padding-top: 0.5em;
+}
+h3 {
+ float: left;
+}
+h3 + * {
+ clear: left;
+}
+
+div.sectionbody {
+ font-family: serif;
+ margin-left: 0;
+}
+
+hr {
+ border: 1px solid silver;
+}
+
+p {
+ margin-top: 0.5em;
+ margin-bottom: 0.5em;
+}
+
+ul, ol, li > p {
+ margin-top: 0;
+}
+
+pre {
+ padding: 0;
+ margin: 0;
+}
+
+span#author {
+ color: #527bbd;
+ font-family: sans-serif;
+ font-weight: bold;
+ font-size: 1.1em;
+}
+span#email {
+}
+span#revnumber, span#revdate, span#revremark {
+ font-family: sans-serif;
+}
+
+div#footer {
+ font-family: sans-serif;
+ font-size: small;
+ border-top: 2px solid silver;
+ padding-top: 0.5em;
+ margin-top: 4.0em;
+}
+div#footer-text {
+ float: left;
+ padding-bottom: 0.5em;
+}
+div#footer-badges {
+ float: right;
+ padding-bottom: 0.5em;
+}
+
+div#preamble {
+ margin-top: 1.5em;
+ margin-bottom: 1.5em;
+}
+div.tableblock, div.imageblock, div.exampleblock, div.verseblock,
+div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
+div.admonitionblock {
+ margin-top: 1.0em;
+ margin-bottom: 1.5em;
+}
+div.admonitionblock {
+ margin-top: 2.0em;
+ margin-bottom: 2.0em;
+ margin-right: 10%;
+ color: #606060;
+}
+
+div.content { /* Block element content. */
+ padding: 0;
+}
+
+/* Block element titles. */
+div.title, caption.title {
+ color: #527bbd;
+ font-family: sans-serif;
+ font-weight: bold;
+ text-align: left;
+ margin-top: 1.0em;
+ margin-bottom: 0.5em;
+}
+div.title + * {
+ margin-top: 0;
+}
+
+td div.title:first-child {
+ margin-top: 0.0em;
+}
+div.content div.title:first-child {
+ margin-top: 0.0em;
+}
+div.content + div.title {
+ margin-top: 0.0em;
+}
+
+div.sidebarblock > div.content {
+ background: #ffffee;
+ border: 1px solid silver;
+ padding: 0.5em;
+}
+
+div.listingblock > div.content {
+ border: 1px solid silver;
+ background: #f4f4f4;
+ padding: 0.5em;
+}
+
+div.quoteblock, div.verseblock {
+ padding-left: 1.0em;
+ margin-left: 1.0em;
+ margin-right: 10%;
+ border-left: 5px solid #dddddd;
+ color: #777777;
+}
+
+div.quoteblock > div.attribution {
+ padding-top: 0.5em;
+ text-align: right;
+}
+
+div.verseblock > pre.content {
+ font-family: inherit;
+}
+div.verseblock > div.attribution {
+ padding-top: 0.75em;
+ text-align: left;
+}
+/* DEPRECATED: Pre version 8.2.7 verse style literal block. */
+div.verseblock + div.attribution {
+ text-align: left;
+}
+
+div.admonitionblock .icon {
+ vertical-align: top;
+ font-size: 1.1em;
+ font-weight: bold;
+ text-decoration: underline;
+ color: #527bbd;
+ padding-right: 0.5em;
+}
+div.admonitionblock td.content {
+ padding-left: 0.5em;
+ border-left: 3px solid #dddddd;
+}
+
+div.exampleblock > div.content {
+ border-left: 3px solid #dddddd;
+ padding-left: 0.5em;
+}
+
+div.imageblock div.content { padding-left: 0; }
+span.image img { border-style: none; }
+a.image:visited { color: white; }
+
+dl {
+ margin-top: 0.8em;
+ margin-bottom: 0.8em;
+}
+dt {
+ margin-top: 0.5em;
+ margin-bottom: 0;
+ font-style: normal;
+ color: navy;
+}
+dd > *:first-child {
+ margin-top: 0.1em;
+}
+
+ul, ol {
+ list-style-position: outside;
+}
+ol.arabic {
+ list-style-type: decimal;
+}
+ol.loweralpha {
+ list-style-type: lower-alpha;
+}
+ol.upperalpha {
+ list-style-type: upper-alpha;
+}
+ol.lowerroman {
+ list-style-type: lower-roman;
+}
+ol.upperroman {
+ list-style-type: upper-roman;
+}
+
+div.compact ul, div.compact ol,
+div.compact p, div.compact p,
+div.compact div, div.compact div {
+ margin-top: 0.1em;
+ margin-bottom: 0.1em;
+}
+
+div.tableblock > table {
+ border: 3px solid #527bbd;
+}
+thead, p.table.header {
+ font-family: sans-serif;
+ font-weight: bold;
+}
+tfoot {
+ font-weight: bold;
+}
+td > div.verse {
+ white-space: pre;
+}
+p.table {
+ margin-top: 0;
+}
+/* Because the table frame attribute is overriden by CSS in most browsers. */
+div.tableblock > table[frame="void"] {
+ border-style: none;
+}
+div.tableblock > table[frame="hsides"] {
+ border-left-style: none;
+ border-right-style: none;
+}
+div.tableblock > table[frame="vsides"] {
+ border-top-style: none;
+ border-bottom-style: none;
+}
+
+
+div.hdlist {
+ margin-top: 0.8em;
+ margin-bottom: 0.8em;
+}
+div.hdlist tr {
+ padding-bottom: 15px;
+}
+dt.hdlist1.strong, td.hdlist1.strong {
+ font-weight: bold;
+}
+td.hdlist1 {
+ vertical-align: top;
+ font-style: normal;
+ padding-right: 0.8em;
+ color: navy;
+}
+td.hdlist2 {
+ vertical-align: top;
+}
+div.hdlist.compact tr {
+ margin: 0;
+ padding-bottom: 0;
+}
+
+.comment {
+ background: yellow;
+}
+
+.footnote, .footnoteref {
+ font-size: 0.8em;
+}
+
+span.footnote, span.footnoteref {
+ vertical-align: super;
+}
+
+#footnotes {
+ margin: 20px 0 20px 0;
+ padding: 7px 0 0 0;
+}
+
+#footnotes div.footnote {
+ margin: 0 0 5px 0;
+}
+
+#footnotes hr {
+ border: none;
+ border-top: 1px solid silver;
+ height: 1px;
+ text-align: left;
+ margin-left: 0;
+ width: 20%;
+ min-width: 100px;
+}
+
+
+@media print {
+ div#footer-badges { display: none; }
+}
+
+div#toc {
+ margin-bottom: 2.5em;
+}
+
+div#toctitle {
+ color: #527bbd;
+ font-family: sans-serif;
+ font-size: 1.1em;
+ font-weight: bold;
+ margin-top: 1.0em;
+ margin-bottom: 0.1em;
+}
+
+div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
+ margin-top: 0;
+ margin-bottom: 0;
+}
+div.toclevel2 {
+ margin-left: 2em;
+ font-size: 0.9em;
+}
+div.toclevel3 {
+ margin-left: 4em;
+ font-size: 0.9em;
+}
+div.toclevel4 {
+ margin-left: 6em;
+ font-size: 0.9em;
+}
+/* Workarounds for IE6's broken and incomplete CSS2. */
+
+div.sidebar-content {
+ background: #ffffee;
+ border: 1px solid silver;
+ padding: 0.5em;
+}
+div.sidebar-title, div.image-title {
+ color: #527bbd;
+ font-family: sans-serif;
+ font-weight: bold;
+ margin-top: 0.0em;
+ margin-bottom: 0.5em;
+}
+
+div.listingblock div.content {
+ border: 1px solid silver;
+ background: #f4f4f4;
+ padding: 0.5em;
+}
+
+div.quoteblock-attribution {
+ padding-top: 0.5em;
+ text-align: right;
+}
+
+pre.verseblock-content {
+ font-family: inherit;
+}
+div.verseblock-attribution {
+ padding-top: 0.75em;
+ text-align: left;
+}
+
+div.exampleblock-content {
+ border-left: 3px solid #dddddd;
+ padding-left: 0.5em;
+}
+
+/* IE6 sets dynamically generated links as visited. */
+div#toc a:visited { color: blue; }
+/*]]>*/
+</style>
+<script type="text/javascript">
+/*<![CDATA[*/
+window.onload = function(){asciidoc.footnotes(); asciidoc.toc(4);}
+var asciidoc = { // Namespace.
+
+/////////////////////////////////////////////////////////////////////
+// Table Of Contents generator
+/////////////////////////////////////////////////////////////////////
+
+/* Author: Mihai Bazon, September 2002
+ * http://students.infoiasi.ro/~mishoo
+ *
+ * Table Of Content generator
+ * Version: 0.4
+ *
+ * Feel free to use this script under the terms of the GNU General Public
+ * License, as long as you do not remove or alter this notice.
+ */
+
+ /* modified by Troy D. Hanson, September 2006. License: GPL */
+ /* modified by Stuart Rackham, 2006, 2009. License: GPL */
+
+// toclevels = 1..4.
+toc: function (toclevels) {
+
+ function getText(el) {
+ var text = "";
+ for (var i = el.firstChild; i != null; i = i.nextSibling) {
+ if (i.nodeType == 3 /* Node.TEXT_NODE */) // IE doesn't speak constants.
+ text += i.data;
+ else if (i.firstChild != null)
+ text += getText(i);
+ }
+ return text;
+ }
+
+ function TocEntry(el, text, toclevel) {
+ this.element = el;
+ this.text = text;
+ this.toclevel = toclevel;
+ }
+
+ function tocEntries(el, toclevels) {
+ var result = new Array;
+ var re = new RegExp('[hH]([2-'+(toclevels+1)+'])');
+ // Function that scans the DOM tree for header elements (the DOM2
+ // nodeIterator API would be a better technique but not supported by all
+ // browsers).
+ var iterate = function (el) {
+ for (var i = el.firstChild; i != null; i = i.nextSibling) {
+ if (i.nodeType == 1 /* Node.ELEMENT_NODE */) {
+ var mo = re.exec(i.tagName);
+ if (mo && (i.getAttribute("class") || i.getAttribute("className")) != "float") {
+ result[result.length] = new TocEntry(i, getText(i), mo[1]-1);
+ }
+ iterate(i);
+ }
+ }
+ }
+ iterate(el);
+ return result;
+ }
+
+ var toc = document.getElementById("toc");
+ var entries = tocEntries(document.getElementById("content"), toclevels);
+ for (var i = 0; i < entries.length; ++i) {
+ var entry = entries[i];
+ if (entry.element.id == "")
+ entry.element.id = "_toc_" + i;
+ var a = document.createElement("a");
+ a.href = "#" + entry.element.id;
+ a.appendChild(document.createTextNode(entry.text));
+ var div = document.createElement("div");
+ div.appendChild(a);
+ div.className = "toclevel" + entry.toclevel;
+ toc.appendChild(div);
+ }
+ if (entries.length == 0)
+ toc.parentNode.removeChild(toc);
+},
+
+
+/////////////////////////////////////////////////////////////////////
+// Footnotes generator
+/////////////////////////////////////////////////////////////////////
+
+/* Based on footnote generation code from:
+ * http://www.brandspankingnew.net/archive/2005/07/format_footnote.html
+ */
+
+footnotes: function () {
+ var cont = document.getElementById("content");
+ var noteholder = document.getElementById("footnotes");
+ var spans = cont.getElementsByTagName("span");
+ var refs = {};
+ var n = 0;
+ for (i=0; i<spans.length; i++) {
+ if (spans[i].className == "footnote") {
+ n++;
+ // Use [\s\S] in place of . so multi-line matches work.
+ // Because JavaScript has no s (dotall) regex flag.
+ note = spans[i].innerHTML.match(/\s*\[([\s\S]*)]\s*/)[1];
+ noteholder.innerHTML +=
+ "<div class='footnote' id='_footnote_" + n + "'>" +
+ "<a href='#_footnoteref_" + n + "' title='Return to text'>" +
+ n + "</a>. " + note + "</div>";
+ spans[i].innerHTML =
+ "[<a id='_footnoteref_" + n + "' href='#_footnote_" + n +
+ "' title='View footnote' class='footnote'>" + n + "</a>]";
+ var id =spans[i].getAttribute("id");
+ if (id != null) refs["#"+id] = n;
+ }
+ }
+ if (n == 0)
+ noteholder.parentNode.removeChild(noteholder);
+ else {
+ // Process footnoterefs.
+ for (i=0; i<spans.length; i++) {
+ if (spans[i].className == "footnoteref") {
+ var href = spans[i].getElementsByTagName("a")[0].getAttribute("href");
+ href = href.match(/#.*/)[0]; // Because IE return full URL.
+ n = refs[href];
+ spans[i].innerHTML =
+ "[<a href='#_footnote_" + n +
+ "' title='View footnote' class='footnote'>" + n + "</a>]";
+ }
+ }
+ }
+}
+
+}
+/*]]>*/
+</script>
+</head>
+<body>
+<div id="header">
+<h1>Linearize Commmits</h1>
+<div id="toc">
+ <div id="toctitle">Table of Contents</div>
+ <noscript><p><b>JavaScript must be enabled in your browser to display the table of contents.</b></p></noscript>
+</div>
+</div>
+<div id="content">
+<div id="preamble">
+<div class="sectionbody">
+<div class="paragraph" id="linearizecommits"><p>Messy commit histories with lots of needless merge branches just get confusing
+when trying to work backwards and work out what happened.</p></div>
+<div class="paragraph"><p>To resolve this issue, it is strongly recommended to utilize <tt>git rebase</tt> to
+simplify merge histories in a way as such it produces the illusion the merge
+never happened, and was never needed, as all the commits simply happend after
+all the other commits they were going to be merged into.</p></div>
+<div class="paragraph"><p>But the subject of <tt>git rebase</tt> is far too complex to summarise in this one
+document, at least for now, so you should use other online sources to learn
+this.</p></div>
+</div>
+</div>
+<h2 id="_advocates_of_git_rebase_theory">1. Advocates of Git Rebase/Theory</h2>
+<div class="sectionbody">
+<div class="dlist"><dl>
+<dt class="hdlist1">
+Tate Johnson
+</dt>
+<dd>
+<p>
+ <a href="http://tatey.com/2009/04/23/git-rebase-for-linear-history/">Git Rebase
+ For Linear History</a>
+</p>
+</dd>
+<dt class="hdlist1">
+Kent Fredric
+</dt>
+<dd>
+<p>
+ <a href="http://blog.fox.geek.nz/2010/08/git-rebase-part-1-why-you-should-use-it.html">Git
+ Rebase Part 1: Why you should use it, Theory.</a>
+</p>
+</dd>
+</dl></div>
+</div>
+<h2 id="_rebase_guides">2. Rebase Guides</h2>
+<div class="sectionbody">
+<div class="dlist"><dl>
+<dt class="hdlist1">
+ProGit.org
+</dt>
+<dd>
+<p>
+ <a href="http://progit.org/book/ch3-6.html"> Rebase </a>
+</p>
+</dd>
+</dl></div>
+</div>
+</div>
+<div id="footnotes"><hr/></div>
+<div id="footer">
+<div id="footer-text">
+Last updated 2010-09-29 10:23:14 NZDT
+</div>
+<div id="footer-badges">
+Valid <a href="http://validator.w3.org/check?uri=referer">XHTML</a>
+and <a href="http://jigsaw.w3.org/css-validator/check/referer">CSS</a>.
+</div>
+</div>
+</body>
+</html>
diff --git a/README/git-tips/linearize-commits.txt b/README/git-tips/linearize-commits.txt
new file mode 100644
index 000000000..e0eb84be4
--- /dev/null
+++ b/README/git-tips/linearize-commits.txt
@@ -0,0 +1,32 @@
+[[linearizecommits]]
+Linearize Commmits
+==================
+
+Messy commit histories with lots of needless merge branches just get confusing
+when trying to work backwards and work out what happened.
+
+To resolve this issue, it is strongly recommended to utilize `git rebase` to
+simplify merge histories in a way as such it produces the illusion the merge
+never happened, and was never needed, as all the commits simply happend after
+all the other commits they were going to be merged into.
+
+But the subject of `git rebase` is far too complex to summarise in this one
+document, at least for now, so you should use other online sources to learn
+this.
+
+Advocates of Git Rebase/Theory
+------------------------------
+
+Tate Johnson::
+ link:http://tatey.com/2009/04/23/git-rebase-for-linear-history/[Git Rebase
+ For Linear History]
+
+Kent Fredric::
+ link:http://blog.fox.geek.nz/2010/08/git-rebase-part-1-why-you-should-use-it.html[Git
+ Rebase Part 1: Why you should use it, Theory.]
+
+Rebase Guides
+-------------
+
+ProGit.org::
+ link:http://progit.org/book/ch3-6.html[ Rebase ]