diff options
| author | Junio C Hamano <gitster@pobox.com> | 2012-12-18 16:43:11 -0800 |
|---|---|---|
| committer | Junio C Hamano <gitster@pobox.com> | 2012-12-18 16:43:11 -0800 |
| commit | 9d9711544dc3090db6e5c52f9ce9c300bf4f5c14 (patch) | |
| tree | 23257b9801739fd96c9e82ef98a17500dce9f88e /gitworkflows.html | |
| parent | 9629d4f49e5ffcff5c5beb5c40bedcffcabcd905 (diff) | |
| download | git-htmldocs-9d9711544dc3090db6e5c52f9ce9c300bf4f5c14.tar.gz | |
Autogenerated HTML docs for v1.8.1-rc2-5-g252f9
Diffstat (limited to 'gitworkflows.html')
| -rw-r--r-- | gitworkflows.html | 514 |
1 files changed, 354 insertions, 160 deletions
diff --git a/gitworkflows.html b/gitworkflows.html index 16b54116d..86e25ed7a 100644 --- a/gitworkflows.html +++ b/gitworkflows.html @@ -2,15 +2,25 @@ "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.2" />
+<meta http-equiv="Content-Type" content="application/xhtml+xml; charset=UTF-8" />
+<meta name="generator" content="AsciiDoc 8.6.8" />
<title>gitworkflows(7)</title>
<style type="text/css">
-/* Debug borders */
-p, li, dt, dd, div, pre, h1, h2, h3, h4, h5, h6 {
-/*
- border: 1px solid red;
-*/
+/* Shared CSS for AsciiDoc xhtml11 and html5 backends */
+
+/* Default font. */
+body {
+ font-family: Georgia,serif;
+}
+
+/* Title font. */
+h1, h2, h3, h4, h5, h6,
+div.title, caption.title,
+thead, p.table.header,
+#toctitle,
+#author, #revnumber, #revdate, #revremark,
+#footer {
+ font-family: Arial,Helvetica,sans-serif;
}
body {
@@ -35,13 +45,8 @@ strong { 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;
@@ -59,9 +64,11 @@ h3 { h3 + * {
clear: left;
}
+h5 {
+ font-size: 1.0em;
+}
div.sectionbody {
- font-family: serif;
margin-left: 0;
}
@@ -77,45 +84,48 @@ p { ul, ol, li > p {
margin-top: 0;
}
+ul > li { color: #aaa; }
+ul > li > * { color: black; }
-pre {
+.monospaced, code, pre {
+ font-family: "Courier New", Courier, monospace;
+ font-size: inherit;
+ color: navy;
padding: 0;
margin: 0;
}
-span#author {
+
+#author {
color: #527bbd;
- font-family: sans-serif;
font-weight: bold;
font-size: 1.1em;
}
-span#email {
+#email {
}
-span#revnumber, span#revdate, span#revremark {
- font-family: sans-serif;
+#revnumber, #revdate, #revremark {
}
-div#footer {
- font-family: sans-serif;
+#footer {
font-size: small;
border-top: 2px solid silver;
padding-top: 0.5em;
margin-top: 4.0em;
}
-div#footer-text {
+#footer-text {
float: left;
padding-bottom: 0.5em;
}
-div#footer-badges {
+#footer-badges {
float: right;
padding-bottom: 0.5em;
}
-div#preamble {
+#preamble {
margin-top: 1.5em;
margin-bottom: 1.5em;
}
-div.tableblock, div.imageblock, div.exampleblock, div.verseblock,
+div.imageblock, div.exampleblock, div.verseblock,
div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
div.admonitionblock {
margin-top: 1.0em;
@@ -135,7 +145,6 @@ div.content { /* Block element content. */ /* Block element titles. */
div.title, caption.title {
color: #527bbd;
- font-family: sans-serif;
font-weight: bold;
text-align: left;
margin-top: 1.0em;
@@ -157,13 +166,15 @@ div.content + div.title { div.sidebarblock > div.content {
background: #ffffee;
- border: 1px solid silver;
+ border: 1px solid #dddddd;
+ border-left: 4px solid #f0f0f0;
padding: 0.5em;
}
div.listingblock > div.content {
- border: 1px solid silver;
- background: #f4f4f4;
+ border: 1px solid #dddddd;
+ border-left: 5px solid #f0f0f0;
+ background: #f8f8f8;
padding: 0.5em;
}
@@ -171,8 +182,8 @@ div.quoteblock, div.verseblock { padding-left: 1.0em;
margin-left: 1.0em;
margin-right: 10%;
- border-left: 5px solid #dddddd;
- color: #777777;
+ border-left: 5px solid #f0f0f0;
+ color: #888;
}
div.quoteblock > div.attribution {
@@ -180,8 +191,9 @@ div.quoteblock > div.attribution { text-align: right;
}
-div.verseblock > div.content {
- white-space: pre;
+div.verseblock > pre.content {
+ font-family: inherit;
+ font-size: inherit;
}
div.verseblock > div.attribution {
padding-top: 0.75em;
@@ -254,35 +266,12 @@ div.compact div, div.compact div { 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;
@@ -339,25 +328,32 @@ span.footnote, span.footnoteref { min-width: 100px;
}
+div.colist td {
+ padding-right: 0.5em;
+ padding-bottom: 0.3em;
+ vertical-align: top;
+}
+div.colist td img {
+ margin-top: 0.3em;
+}
@media print {
- div#footer-badges { display: none; }
+ #footer-badges { display: none; }
}
-div#toc {
+#toc {
margin-bottom: 2.5em;
}
-div#toctitle {
+#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 {
+div.toclevel0, div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
margin-top: 0;
margin-bottom: 0;
}
@@ -373,69 +369,173 @@ div.toclevel4 { margin-left: 6em;
font-size: 0.9em;
}
-/* Overrides for manpage documents */
-h1 {
- padding-top: 0.5em;
- padding-bottom: 0.5em;
- border-top: 2px solid silver;
- border-bottom: 2px solid silver;
+
+span.aqua { color: aqua; }
+span.black { color: black; }
+span.blue { color: blue; }
+span.fuchsia { color: fuchsia; }
+span.gray { color: gray; }
+span.green { color: green; }
+span.lime { color: lime; }
+span.maroon { color: maroon; }
+span.navy { color: navy; }
+span.olive { color: olive; }
+span.purple { color: purple; }
+span.red { color: red; }
+span.silver { color: silver; }
+span.teal { color: teal; }
+span.white { color: white; }
+span.yellow { color: yellow; }
+
+span.aqua-background { background: aqua; }
+span.black-background { background: black; }
+span.blue-background { background: blue; }
+span.fuchsia-background { background: fuchsia; }
+span.gray-background { background: gray; }
+span.green-background { background: green; }
+span.lime-background { background: lime; }
+span.maroon-background { background: maroon; }
+span.navy-background { background: navy; }
+span.olive-background { background: olive; }
+span.purple-background { background: purple; }
+span.red-background { background: red; }
+span.silver-background { background: silver; }
+span.teal-background { background: teal; }
+span.white-background { background: white; }
+span.yellow-background { background: yellow; }
+
+span.big { font-size: 2em; }
+span.small { font-size: 0.6em; }
+
+span.underline { text-decoration: underline; }
+span.overline { text-decoration: overline; }
+span.line-through { text-decoration: line-through; }
+
+div.unbreakable { page-break-inside: avoid; }
+
+
+/*
+ * xhtml11 specific
+ *
+ * */
+
+div.tableblock {
+ margin-top: 1.0em;
+ margin-bottom: 1.5em;
}
-h2 {
+div.tableblock > table {
+ border: 3px solid #527bbd;
+}
+thead, p.table.header {
+ font-weight: bold;
+ color: #527bbd;
+}
+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.sectionbody {
- margin-left: 5%;
+div.tableblock > table[frame="hsides"] {
+ border-left-style: none;
+ border-right-style: none;
}
-
-@media print {
- div#toc { display: none; }
+div.tableblock > table[frame="vsides"] {
+ border-top-style: none;
+ border-bottom-style: none;
}
-/* Workarounds for IE6's broken and incomplete CSS2. */
-div.sidebar-content {
- background: #ffffee;
- border: 1px solid silver;
- padding: 0.5em;
+/*
+ * html5 specific
+ *
+ * */
+
+table.tableblock {
+ margin-top: 1.0em;
+ margin-bottom: 1.5em;
}
-div.sidebar-title, div.image-title {
- color: #527bbd;
- font-family: sans-serif;
+thead, p.tableblock.header {
font-weight: bold;
- margin-top: 0.0em;
- margin-bottom: 0.5em;
+ color: #527bbd;
+}
+p.tableblock {
+ margin-top: 0;
+}
+table.tableblock {
+ border-width: 3px;
+ border-spacing: 0px;
+ border-style: solid;
+ border-color: #527bbd;
+ border-collapse: collapse;
+}
+th.tableblock, td.tableblock {
+ border-width: 1px;
+ padding: 4px;
+ border-style: solid;
+ border-color: #527bbd;
}
-div.listingblock div.content {
- border: 1px solid silver;
- background: #f4f4f4;
- padding: 0.5em;
+table.tableblock.frame-topbot {
+ border-left-style: hidden;
+ border-right-style: hidden;
+}
+table.tableblock.frame-sides {
+ border-top-style: hidden;
+ border-bottom-style: hidden;
+}
+table.tableblock.frame-none {
+ border-style: hidden;
}
-div.quoteblock-attribution {
- padding-top: 0.5em;
+th.tableblock.halign-left, td.tableblock.halign-left {
+ text-align: left;
+}
+th.tableblock.halign-center, td.tableblock.halign-center {
+ text-align: center;
+}
+th.tableblock.halign-right, td.tableblock.halign-right {
text-align: right;
}
-div.verseblock-content {
- white-space: pre;
+th.tableblock.valign-top, td.tableblock.valign-top {
+ vertical-align: top;
}
-div.verseblock-attribution {
- padding-top: 0.75em;
- text-align: left;
+th.tableblock.valign-middle, td.tableblock.valign-middle {
+ vertical-align: middle;
+}
+th.tableblock.valign-bottom, td.tableblock.valign-bottom {
+ vertical-align: bottom;
}
-div.exampleblock-content {
- border-left: 3px solid #dddddd;
- padding-left: 0.5em;
+
+/*
+ * manpage specific
+ *
+ * */
+
+body.manpage h1 {
+ padding-top: 0.5em;
+ padding-bottom: 0.5em;
+ border-top: 2px solid silver;
+ border-bottom: 2px solid silver;
+}
+body.manpage h2 {
+ border-style: none;
}
+body.manpage div.sectionbody {
+ margin-left: 3em;
+}
+
+@media print {
+ body.manpage div#toc { display: none; }
+}
+
-/* IE6 sets dynamically generated links as visited. */
-div#toc a:visited { color: blue; }
</style>
<script type="text/javascript">
/*<+'])');
+ var re = new RegExp('[hH]([1-'+(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).
@@ -497,6 +597,25 @@ toc: function (toclevels) { }
var toc = document.getElementById("toc");
+ if (!toc) {
+ return;
+ }
+
+ // Delete existing TOC entries in case we're reloading the TOC.
+ var tocEntriesToRemove = [];
+ var i;
+ for (i = 0; i < toc.childNodes.length; i++) {
+ var entry = toc.childNodes[i];
+ if (entry.nodeName.toLowerCase() == 'div'
+ && entry.getAttribute("class")
+ && entry.getAttribute("class").match(/^toclevel/))
+ tocEntriesToRemove.push(entry);
+ }
+ for (i = 0; i < tocEntriesToRemove.length; i++) {
+ toc.removeChild(tocEntriesToRemove[i]);
+ }
+
+ // Rebuild TOC entries.
var entries = tocEntries(document.getElementById("content"), toclevels);
for (var i = 0; i < entries.length; ++i) {
var entry = entries[i];
@@ -524,24 +643,44 @@ toc: function (toclevels) { */
footnotes: function () {
- var cont = document.getElementById("content");
+ // Delete existing footnote entries in case we're reloading the footnodes.
+ var i;
var noteholder = document.getElementById("footnotes");
+ if (!noteholder) {
+ return;
+ }
+ var entriesToRemove = [];
+ for (i = 0; i < noteholder.childNodes.length; i++) {
+ var entry = noteholder.childNodes[i];
+ if (entry.nodeName.toLowerCase() == 'div' && entry.getAttribute("class") == "footnote")
+ entriesToRemove.push(entry);
+ }
+ for (i = 0; i < entriesToRemove.length; i++) {
+ noteholder.removeChild(entriesToRemove[i]);
+ }
+
+ // Rebuild footnote entries.
+ var cont = document.getElementById("content");
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];
+ var note = spans[i].getAttribute("data-note");
+ if (!note) {
+ // 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];
+ spans[i].innerHTML =
+ "[<a id='_footnoteref_" + n + "' href='#_footnote_" + n +
+ "' title='View footnote' class='footnote'>" + n + "</a>]";
+ spans[i].setAttribute("data-note", note);
+ }
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;
}
@@ -561,13 +700,36 @@ footnotes: function () { }
}
}
+},
+
+install: function(toclevels) {
+ var timerId;
+
+ function reinstall() {
+ asciidoc.footnotes();
+ if (toclevels) {
+ asciidoc.toc(toclevels);
+ }
+ }
+
+ function reinstallAndRemoveTimer() {
+ clearInterval(timerId);
+ reinstall();
+ }
+
+ timerId = setInterval(reinstall, 500);
+ if (document.addEventListener)
+ document.addEventListener("DOMContentLoaded", reinstallAndRemoveTimer, false);
+ else
+ window.onload = reinstallAndRemoveTimer;
}
}
+asciidoc.install();
/*]]>*/
</script>
</head>
-<body>
+<body class="manpage">
<div id="header">
<h1>
gitworkflows(7) Manual Page
@@ -580,17 +742,20 @@ gitworkflows(7) Manual Page </div>
</div>
<div id="content">
+<div class="sect1">
<h2 id="_synopsis">SYNOPSIS</h2>
<div class="sectionbody">
<div class="verseblock">
-<div class="verseblock-content">git *</div>
-<div class="verseblock-attribution">
+<pre class="content">git *</pre>
+<div class="attribution">
</div></div>
</div>
+</div>
+<div class="sect1">
<h2 id="_description">DESCRIPTION</h2>
<div class="sectionbody">
<div class="paragraph"><p>This document attempts to write down and motivate some of the workflow
-elements used for <tt>git.git</tt> itself. Many ideas apply in general,
+elements used for <code>git.git</code> itself. Many ideas apply in general,
though the full workflow is rarely required for smaller projects with
fewer people involved.</p></div>
<div class="paragraph"><p>We formulate a set of <em>rules</em> for quick reference, while the prose
@@ -598,6 +763,8 @@ tries to motivate each of them. Do not always take them literally; you should value good reasons for your actions higher than manpages
such as this one.</p></div>
</div>
+</div>
+<div class="sect1">
<h2 id="_separate_changes">SEPARATE CHANGES</h2>
<div class="sectionbody">
<div class="paragraph"><p>As a general rule, you should try to split your changes into small
@@ -610,11 +777,13 @@ useful for later inspection and analysis, for example with beginning. It is always easier to squash a few commits together than
to split one big commit into several. Don’t be afraid of making too
small or imperfect steps along the way. You can always go back later
-and edit the commits with <tt>git rebase --interactive</tt> before you
-publish them. You can use <tt>git stash save --keep-index</tt> to run the
+and edit the commits with <code>git rebase --interactive</code> before you
+publish them. You can use <code>git stash save --keep-index</code> to run the
test suite independent of other uncommitted changes; see the EXAMPLES
section of <a href="git-stash.html">git-stash(1)</a>.</p></div>
</div>
+</div>
+<div class="sect1">
<h2 id="_managing_branches">MANAGING BRANCHES</h2>
<div class="sectionbody">
<div class="paragraph"><p>There are two main tools that can be used to include changes from one
@@ -632,10 +801,11 @@ understand because a merge commit is a "promise" that all changes from all its parents are now included.</p></div>
<div class="paragraph"><p>There is a tradeoff of course: merges require a more careful branch
management. The following subsections discuss the important points.</p></div>
-<h3 id="_graduation">Graduation</h3><div style="clear:left"></div>
+<div class="sect2">
+<h3 id="_graduation">Graduation</h3>
<div class="paragraph"><p>As a given feature goes from experimental to stable, it also
"graduates" between the corresponding branches of the software.
-<tt>git.git</tt> uses the following <em>integration branches</em>:</p></div>
+<code>git.git</code> uses the following <em>integration branches</em>:</p></div>
<div class="ulist"><ul>
<li>
<p>
@@ -670,13 +840,15 @@ above it.</p></div> <div class="paragraph"><p>Conceptually, the feature enters at an unstable branch (usually <em>next</em>
or <em>pu</em>), and "graduates" to <em>master</em> for the next release once it is
considered stable enough.</p></div>
-<h3 id="_merging_upwards">Merging upwards</h3><div style="clear:left"></div>
+</div>
+<div class="sect2">
+<h3 id="_merging_upwards">Merging upwards</h3>
<div class="paragraph"><p>The "downwards graduation" discussed above cannot be done by actually
merging downwards, however, since that would merge <em>all</em> changes on
the unstable branch into the stable one. Hence the following:</p></div>
<div class="exampleblock">
<div class="title">Rule: Merge upwards</div>
-<div class="exampleblock-content">
+<div class="content">
<div class="paragraph"><p>Always commit your fixes to the oldest supported branch that require
them. Then (periodically) merge the integration branches upwards into each
other.</p></div>
@@ -686,7 +858,9 @@ have applied a fix to e.g. <em>master</em> that is also required in <em>maint</e you will need to cherry-pick it (using <a href="git-cherry-pick.html">git-cherry-pick(1)</a>)
downwards. This will happen a few times and is nothing to worry about
unless you do it very frequently.</p></div>
-<h3 id="_topic_branches">Topic branches</h3><div style="clear:left"></div>
+</div>
+<div class="sect2">
+<h3 id="_topic_branches">Topic branches</h3>
<div class="paragraph"><p>Any nontrivial feature will require several patches to implement, and
may get extra bugfixes or improvements during its lifetime.</p></div>
<div class="paragraph"><p>Committing everything directly on the integration branches leads to many
@@ -699,7 +873,7 @@ self explanatory, with a caveat that comes from the "merge upwards" rule above:</p></div>
<div class="exampleblock">
<div class="title">Rule: Topic branches</div>
-<div class="exampleblock-content">
+<div class="content">
<div class="paragraph"><p>Make a side branch for every topic (feature, bugfix, …). Fork it off
at the oldest integration branch that you will eventually want to merge it
into.</p></div>
@@ -738,7 +912,7 @@ merging an integration branch into your topics — and by extens merging anything upstream into anything downstream on a regular basis — is frowned upon:</p></div>
<div class="exampleblock">
<div class="title">Rule: Merge to downstream only at well-defined points</div>
-<div class="exampleblock-content">
+<div class="content">
<div class="paragraph"><p>Do not merge to downstream except with a good reason: upstream API
changes affect your branch; your branch no longer merges to upstream
cleanly; etc.</p></div>
@@ -749,7 +923,9 @@ greatly clutter up history. Anyone who later investigates the history of a file will have to find out whether that merge affected the topic
in development. An upstream might even inadvertently be merged into a
"more stable" branch. And so on.</p></div>
-<h3 id="_throw_away_integration">Throw-away integration</h3><div style="clear:left"></div>
+</div>
+<div class="sect2">
+<h3 id="_throw_away_integration">Throw-away integration</h3>
<div class="paragraph"><p>If you followed the last paragraph, you will now have many small topic
branches, and occasionally wonder how they interact. Perhaps the
result of merging them does not even work? But on the other hand, we
@@ -759,16 +935,18 @@ cannot easily be undone.</p></div> into a throw-away branch.</p></div>
<div class="exampleblock">
<div class="title">Rule: Throw-away integration branches</div>
-<div class="exampleblock-content">
+<div class="content">
<div class="paragraph"><p>To test the interaction of several topics, merge them into a
throw-away branch. You must never base any work on such a branch!</p></div>
</div></div>
<div class="paragraph"><p>If you make it (very) clear that this branch is going to be deleted
right after the testing, you can even publish this branch, for example
to give the testers a chance to work with it, or other developers a
-chance to see if their in-progress work will be compatible. <tt>git.git</tt>
+chance to see if their in-progress work will be compatible. <code>git.git</code>
has such an official throw-away integration branch called <em>pu</em>.</p></div>
-<h3 id="_branch_management_for_a_release">Branch management for a release</h3><div style="clear:left"></div>
+</div>
+<div class="sect2">
+<h3 id="_branch_management_for_a_release">Branch management for a release</h3>
<div class="paragraph"><p>Assuming you are using the merge approach discussed above, when you
are releasing your project you will need to do some additional branch
management work.</p></div>
@@ -781,8 +959,8 @@ will therefore not be included in your feature release.</p></div> <div class="paragraph"><p>To verify that <em>master</em> is indeed a superset of <em>maint</em>, use git log:</p></div>
<div class="exampleblock">
<div class="title">Recipe: Verify <em>master</em> is a superset of <em>maint</em></div>
-<div class="exampleblock-content">
-<div class="paragraph"><p><tt>git log master..maint</tt></p></div>
+<div class="content">
+<div class="paragraph"><p><code>git log master..maint</code></p></div>
</div></div>
<div class="paragraph"><p>This command should not list any commits. Otherwise, check out
<em>master</em> and merge <em>maint</em> into it.</p></div>
@@ -790,8 +968,8 @@ will therefore not be included in your feature release.</p></div> tag to the tip of <em>master</em> indicating the release version:</p></div>
<div class="exampleblock">
<div class="title">Recipe: Release tagging</div>
-<div class="exampleblock-content">
-<div class="paragraph"><p><tt>git tag -s -m "GIT X.Y.Z" vX.Y.Z master</tt></p></div>
+<div class="content">
+<div class="paragraph"><p><code>git tag -s -m "GIT X.Y.Z" vX.Y.Z master</code></p></div>
</div></div>
<div class="paragraph"><p>You need to push the new tag to a public git server (see
"DISTRIBUTED WORKFLOWS" below). This makes the tag available to
@@ -801,7 +979,9 @@ release tarballs and preformatted documentation pages.</p></div> <div class="paragraph"><p>Similarly, for a maintenance release, <em>maint</em> is tracking the commits
to be released. Therefore, in the steps above simply tag and push
<em>maint</em> rather than <em>master</em>.</p></div>
-<h3 id="_maintenance_branch_management_after_a_feature_release">Maintenance branch management after a feature release</h3><div style="clear:left"></div>
+</div>
+<div class="sect2">
+<h3 id="_maintenance_branch_management_after_a_feature_release">Maintenance branch management after a feature release</h3>
<div class="paragraph"><p>After a feature release, you need to manage your maintenance branches.</p></div>
<div class="paragraph"><p>First, if you wish to continue to release maintenance fixes for the
feature release made before the recent one, then you must create
@@ -811,23 +991,23 @@ named with the previous release version number (e.g. maint-X.Y.(Z-1) where X.Y.Z is the current release).</p></div>
<div class="exampleblock">
<div class="title">Recipe: Copy maint</div>
-<div class="exampleblock-content">
-<div class="paragraph"><p><tt>git branch maint-X.Y.(Z-1) maint</tt></p></div>
+<div class="content">
+<div class="paragraph"><p><code>git branch maint-X.Y.(Z-1) maint</code></p></div>
</div></div>
<div class="paragraph"><p>The <em>maint</em> branch should now be fast-forwarded to the newly released
code so that maintenance fixes can be tracked for the current release:</p></div>
<div class="exampleblock">
<div class="title">Recipe: Update maint to new release</div>
-<div class="exampleblock-content">
+<div class="content">
<div class="ulist"><ul>
<li>
<p>
-<tt>git checkout maint</tt>
+<code>git checkout maint</code>
</p>
</li>
<li>
<p>
-<tt>git merge --ff-only master</tt>
+<code>git merge --ff-only master</code>
</p>
</li>
</ul></div>
@@ -836,32 +1016,34 @@ code so that maintenance fixes can be tracked for the current release:</p></div> possible some fixes on <em>maint</em> were missed in the feature release.
This will not happen if the content of the branches was verified as
described in the previous section.</p></div>
-<h3 id="_branch_management_for_next_and_pu_after_a_feature_release">Branch management for next and pu after a feature release</h3><div style="clear:left"></div>
+</div>
+<div class="sect2">
+<h3 id="_branch_management_for_next_and_pu_after_a_feature_release">Branch management for next and pu after a feature release</h3>
<div class="paragraph"><p>After a feature release, the integration branch <em>next</em> may optionally be
rewound and rebuilt from the tip of <em>master</em> using the surviving
topics on <em>next</em>:</p></div>
<div class="exampleblock">
<div class="title">Recipe: Rewind and rebuild next</div>
-<div class="exampleblock-content">
+<div class="content">
<div class="ulist"><ul>
<li>
<p>
-<tt>git checkout next</tt>
+<code>git checkout next</code>
</p>
</li>
<li>
<p>
-<tt>git reset --hard master</tt>
+<code>git reset --hard master</code>
</p>
</li>
<li>
<p>
-<tt>git merge ai/topic_in_next1</tt>
+<code>git merge ai/topic_in_next1</code>
</p>
</li>
<li>
<p>
-<tt>git merge ai/topic_in_next2</tt>
+<code>git merge ai/topic_in_next2</code>
</p>
</li>
<li>
@@ -885,6 +1067,9 @@ that <em>next</em> was rewound and rebuilt.</p></div> announcement is not necessary since <em>pu</em> is a throw-away branch, as
described above.</p></div>
</div>
+</div>
+</div>
+<div class="sect1">
<h2 id="_distributed_workflows">DISTRIBUTED WORKFLOWS</h2>
<div class="sectionbody">
<div class="paragraph"><p>After the last section, you should know how to manage topics. In
@@ -893,13 +1078,14 @@ you will have to share your work.</p></div> <div class="paragraph"><p>Roughly speaking, there are two important workflows: merge and patch.
The important difference is that the merge workflow can propagate full
history, including merges, while patches cannot. Both workflows can
-be used in parallel: in <tt>git.git</tt>, only subsystem maintainers use
+be used in parallel: in <code>git.git</code>, only subsystem maintainers use
the merge workflow, while everyone else sends patches.</p></div>
<div class="paragraph"><p>Note that the maintainer(s) may impose restrictions, such as
"Signed-off-by" requirements, that all commits/patches submitted for
inclusion must adhere to. Consult your project’s documentation for
more information.</p></div>
-<h3 id="_merge_workflow">Merge workflow</h3><div style="clear:left"></div>
+<div class="sect2">
+<h3 id="_merge_workflow">Merge workflow</h3>
<div class="paragraph"><p>The merge workflow works by copying branches between upstream and
downstream. Upstream can merge contributions into the official
history; downstream base their work on the official history.</p></div>
@@ -928,8 +1114,8 @@ to merge the remote branch.</p></div> <div class="paragraph"><p>Getting changes out is easy:</p></div>
<div class="exampleblock">
<div class="title">Recipe: Push/pull: Publishing branches/topics</div>
-<div class="exampleblock-content">
-<div class="paragraph"><p><tt>git push <remote> <branch></tt> and tell everyone where they can fetch
+<div class="content">
+<div class="paragraph"><p><code>git push <remote> <branch></code> and tell everyone where they can fetch
from.</p></div>
</div></div>
<div class="paragraph"><p>You will still have to tell people by other means, such as mail. (Git
@@ -939,8 +1125,8 @@ requests to upstream maintainers to simplify this task.)</p></div> staying up to date is easy too:</p></div>
<div class="exampleblock">
<div class="title">Recipe: Push/pull: Staying up to date</div>
-<div class="exampleblock-content">
-<div class="paragraph"><p>Use <tt>git fetch <remote></tt> or <tt>git remote update</tt> to stay up to date.</p></div>
+<div class="content">
+<div class="paragraph"><p>Use <code>git fetch <remote></code> or <code>git remote update</code> to stay up to date.</p></div>
</div></div>
<div class="paragraph"><p>Then simply fork your topic branches from the stable remotes as
explained earlier.</p></div>
@@ -949,22 +1135,24 @@ branches to the integration branches, they will typically send a request to do so by mail. Such a request looks like</p></div>
<div class="listingblock">
<div class="content">
-<pre><tt>Please pull from
- <url> <branch></tt></pre>
+<pre><code>Please pull from
+ <url> <branch></code></pre>
</div></div>
<div class="paragraph"><p>In that case, <em>git pull</em> can do the fetch and merge in one go, as
follows.</p></div>
<div class="exampleblock">
<div class="title">Recipe: Push/pull: Merging remote topics</div>
-<div class="exampleblock-content">
-<div class="paragraph"><p><tt>git pull <url> <branch></tt></p></div>
+<div class="content">
+<div class="paragraph"><p><code>git pull <url> <branch></code></p></div>
</div></div>
<div class="paragraph"><p>Occasionally, the maintainer may get merge conflicts when he tries to
pull changes from downstream. In this case, he can ask downstream to
do the merge and resolve the conflicts themselves (perhaps they will
know better how to resolve them). It is one of the rare cases where
downstream <em>should</em> merge from upstream.</p></div>
-<h3 id="_patch_workflow">Patch workflow</h3><div style="clear:left"></div>
+</div>
+<div class="sect2">
+<h3 id="_patch_workflow">Patch workflow</h3>
<div class="paragraph"><p>If you are a contributor that sends changes upstream in the form of
emails, you should use topic branches as usual (see above). Then use
<a href="git-format-patch.html">git-format-patch(1)</a> to generate the corresponding emails
@@ -972,17 +1160,17 @@ emails, you should use topic branches as usual (see above). Then use maintainer’s life easier).</p></div>
<div class="exampleblock">
<div class="title">Recipe: format-patch/am: Publishing branches/topics</div>
-<div class="exampleblock-content">
+<div class="content">
<div class="ulist"><ul>
<li>
<p>
-<tt>git format-patch -M upstream..topic</tt> to turn them into preformatted
+<code>git format-patch -M upstream..topic</code> to turn them into preformatted
patch files
</p>
</li>
<li>
<p>
-<tt>git send-email --to=<recipient> <patches></tt>
+<code>git send-email --to=<recipient> <patches></code>
</p>
</li>
</ul></div>
@@ -994,8 +1182,8 @@ current upstream, you will have to rebase your topic (you cannot use a merge because you cannot format-patch merges):</p></div>
<div class="exampleblock">
<div class="title">Recipe: format-patch/am: Keeping topics up to date</div>
-<div class="exampleblock-content">
-<div class="paragraph"><p><tt>git pull --rebase <url> <branch></tt></p></div>
+<div class="content">
+<div class="paragraph"><p><code>git pull --rebase <url> <branch></code></p></div>
</div></div>
<div class="paragraph"><p>You can then fix the conflicts during the rebase. Presumably you have
not published your topic other than by mail, so rebasing it is not a
@@ -1005,14 +1193,17 @@ reader of the mailing list it was sent to), save the mails to files, create a new topic branch and use <em>git am</em> to import the commits:</p></div>
<div class="exampleblock">
<div class="title">Recipe: format-patch/am: Importing patches</div>
-<div class="exampleblock-content">
-<div class="paragraph"><p><tt>git am < patch</tt></p></div>
+<div class="content">
+<div class="paragraph"><p><code>git am < patch</code></p></div>
</div></div>
<div class="paragraph"><p>One feature worth pointing out is the three-way merge, which can help
-if you get conflicts: <tt>git am -3</tt> will use index information contained
+if you get conflicts: <code>git am -3</code> will use index information contained
in patches to figure out the merge base. See <a href="git-am.html">git-am(1)</a> for
other options.</p></div>
</div>
+</div>
+</div>
+<div class="sect1">
<h2 id="_see_also">SEE ALSO</h2>
<div class="sectionbody">
<div class="paragraph"><p><a href="gittutorial.html">gittutorial(7)</a>,
@@ -1024,11 +1215,14 @@ other options.</p></div> <a href="git-send-email.html">git-send-email(1)</a>,
<a href="git-am.html">git-am(1)</a></p></div>
</div>
+</div>
+<div class="sect1">
<h2 id="_git">GIT</h2>
<div class="sectionbody">
<div class="paragraph"><p>Part of the <a href="git.html">git(1)</a> suite.</p></div>
</div>
</div>
+</div>
<div id="footnotes"><hr /></div>
<div id="footer">
<div id="footer-text">
|