Permalink
Browse files

Autogenerated HTML docs for v1.8.1.1-439-g50a6b

  • Loading branch information...
1 parent e77c5d0 commit 36d5229ff97f2456bb10db95a3793c682ced30ea @gitster committed Jan 25, 2013
View
36 RelNotes/1.8.2.txt
@@ -15,6 +15,13 @@ current branch to the branch with the same name, only when the current
branch is set to integrate with that remote branch. There is a user
preference configuration variable "push.default" to change this.
+"git push $there tag v1.2.3" used to allow replacing a tag v1.2.3
+that already exists in the repository $there, if the rewritten tag
+you are pushing points at a commit that is a decendant of a commit
+that the old tag v1.2.3 points at. This was found to be error prone
+and starting with this release, any attempt to update an existing
+ref under refs/tags/ hierarchy will fail, without "--force".
+
Updates since v1.8.1
--------------------
@@ -38,11 +45,16 @@ UI, Workflows & Features
* Scripts can ask Git that wildcard patterns in pathspecs they give do
not have any significance, i.e. take them as literal strings.
- * The pathspec code learned to grok "foo/**/bar" as a pattern that
- matches "bar" in 0-or-more levels of subdirectory in "foo".
+ * The patterns in .gitignore and .gitattributes files can have **/,
+ as a pattern that matches 0 or more levels of subdirectory.
+ E.g. "foo/**/bar" matches "bar" in "foo" itself or in a
+ subdirectory of "foo".
* "git blame" (and "git diff") learned the "--no-follow" option.
+ * "git check-ignore" command to help debugging .gitignore files has
+ been added.
+
* "git cherry-pick" can be used to replay a root commit to an unborn
branch.
@@ -72,6 +84,9 @@ UI, Workflows & Features
* "git push" now requires "-f" to update a tag, even if it is a
fast-forward, as tags are meant to be fixed points.
+ * "git push" will stop without doing anything if the new "pre-push"
+ hook exists and exits with a failure.
+
* When "git rebase" fails to generate patches to be applied (e.g. due
to oom), it failed to detect the failure and instead behaved as if
there were nothing to do. A workaround to use a temporary file has
@@ -117,12 +132,27 @@ Performance, Internal Implementation, etc.
from a conflicted state, that we may have missed.
* The implementation of "imap-send" has been updated to reuse xml
- quoting code from http-push codepath.
+ quoting code from http-push codepath, and lost a lot of unused
+ code.
* There is a simple-minded checker for the test scripts in t/
directory to catch most common mistakes (it is not enabled by
default).
+ * You can build with USE_WILDMATCH=YesPlease to use a replacement
+ implementation of pattern matching logic used for pathname-like
+ things, e.g. refnames and paths in the repository. This new
+ implementation is not expected change the existing behaviour of Git
+ in this release, except for "git for-each-ref" where you can now
+ say "refs/**/master" and match with both refs/heads/master and
+ refs/remotes/origin/master. We plan to use this new implementation
+ in wider places (e.g. "git ls-files '**/Makefile' may find Makefile
+ at the top-level, and "git log '**/t*.sh'" may find commits that
+ touch a shell script whose name begins with "t" at any level) in
+ future versions of Git, but we are not there yet. By building with
+ USE_WILDMATCH, using the resulting Git daily and reporting when you
+ find breakages, you can help us get closer to that goal.
+
Also contains minor documentation updates and code clean-ups.
View
3 cmds-purehelpers.txt
@@ -1,6 +1,9 @@
linkgit:git-check-attr[1]::
Display gitattributes information.
+linkgit:git-check-ignore[1]::
+ Debug gitignore / exclude files.
+
linkgit:git-check-ref-format[1]::
Ensures that a reference name is well formed.
View
883 git-check-ignore.html
@@ -0,0 +1,883 @@
+<!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="application/xhtml+xml; charset=UTF-8" />
+<meta name="generator" content="AsciiDoc 8.6.8" />
+<title>git-check-ignore(1)</title>
+<style type="text/css">
+/* 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 {
+ 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;
+}
+
+h1, h2, h3, h4, h5, h6 {
+ color: #527bbd;
+ 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;
+}
+h5 {
+ font-size: 1.0em;
+}
+
+div.sectionbody {
+ margin-left: 0;
+}
+
+hr {
+ border: 1px solid silver;
+}
+
+p {
+ margin-top: 0.5em;
+ margin-bottom: 0.5em;
+}
+
+ul, ol, li > p {
+ margin-top: 0;
+}
+ul > li { color: #aaa; }
+ul > li > * { color: black; }
+
+.monospaced, code, pre {
+ font-family: "Courier New", Courier, monospace;
+ font-size: inherit;
+ color: navy;
+ padding: 0;
+ margin: 0;
+}
+
+
+#author {
+ color: #527bbd;
+ font-weight: bold;
+ font-size: 1.1em;
+}
+#email {
+}
+#revnumber, #revdate, #revremark {
+}
+
+#footer {
+ font-size: small;
+ border-top: 2px solid silver;
+ padding-top: 0.5em;
+ margin-top: 4.0em;
+}
+#footer-text {
+ float: left;
+ padding-bottom: 0.5em;
+}
+#footer-badges {
+ float: right;
+ padding-bottom: 0.5em;
+}
+
+#preamble {
+ margin-top: 1.5em;
+ margin-bottom: 1.5em;
+}
+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-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 #dddddd;
+ border-left: 4px solid #f0f0f0;
+ padding: 0.5em;
+}
+
+div.listingblock > div.content {
+ border: 1px solid #dddddd;
+ border-left: 5px solid #f0f0f0;
+ background: #f8f8f8;
+ padding: 0.5em;
+}
+
+div.quoteblock, div.verseblock {
+ padding-left: 1.0em;
+ margin-left: 1.0em;
+ margin-right: 10%;
+ border-left: 5px solid #f0f0f0;
+ color: #888;
+}
+
+div.quoteblock > div.attribution {
+ padding-top: 0.5em;
+ text-align: right;
+}
+
+div.verseblock > pre.content {
+ font-family: inherit;
+ font-size: 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;
+}
+
+tfoot {
+ font-weight: bold;
+}
+td > div.verse {
+ white-space: pre;
+}
+
+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;
+}
+
+div.colist td {
+ padding-right: 0.5em;
+ padding-bottom: 0.3em;
+ vertical-align: top;
+}
+div.colist td img {
+ margin-top: 0.3em;
+}
+
+@media print {
+ #footer-badges { display: none; }
+}
+
+#toc {
+ margin-bottom: 2.5em;
+}
+
+#toctitle {
+ color: #527bbd;
+ font-size: 1.1em;
+ font-weight: bold;
+ margin-top: 1.0em;
+ margin-bottom: 0.1em;
+}
+
+div.toclevel0, 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;
+}
+
+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;
+}
+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.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;
+}
+
+
+/*
+ * html5 specific
+ *
+ * */
+
+table.tableblock {
+ margin-top: 1.0em;
+ margin-bottom: 1.5em;
+}
+thead, p.tableblock.header {
+ font-weight: bold;
+ 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;
+}
+
+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;
+}
+
+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;
+}
+
+th.tableblock.valign-top, td.tableblock.valign-top {
+ vertical-align: top;
+}
+th.tableblock.valign-middle, td.tableblock.valign-middle {
+ vertical-align: middle;
+}
+th.tableblock.valign-bottom, td.tableblock.valign-bottom {
+ vertical-align: bottom;
+}
+
+
+/*
+ * 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; }
+}
+
+
+</style>
+<script type="text/javascript">
+/*<![CDATA[*/
+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]([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).
+ 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");
+ 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];
+ 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 () {
+ // 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++;
+ 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>";
+ 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>]";
+ }
+ }
+ }
+},
+
+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 class="manpage">
+<div id="header">
+<h1>
+git-check-ignore(1) Manual Page
+</h1>
+<h2>NAME</h2>
+<div class="sectionbody">
+<p>git-check-ignore -
+ Debug gitignore / exclude files
+</p>
+</div>
+</div>
+<div id="content">
+<div class="sect1">
+<h2 id="_synopsis">SYNOPSIS</h2>
+<div class="sectionbody">
+<div class="verseblock">
+<pre class="content"><em>git check-ignore</em> [options] pathname&#8230;
+<em>git check-ignore</em> [options] --stdin &lt; &lt;list-of-paths&gt;</pre>
+<div class="attribution">
+</div></div>
+</div>
+</div>
+<div class="sect1">
+<h2 id="_description">DESCRIPTION</h2>
+<div class="sectionbody">
+<div class="paragraph"><p>For each pathname given via the command-line or from a file via
+<code>--stdin</code>, show the pattern from .gitignore (or other input files to
+the exclude mechanism) that decides if the pathname is excluded or
+included. Later patterns within a file take precedence over earlier
+ones.</p></div>
+</div>
+</div>
+<div class="sect1">
+<h2 id="_options">OPTIONS</h2>
+<div class="sectionbody">
+<div class="dlist"><dl>
+<dt class="hdlist1">
+-q, --quiet
+</dt>
+<dd>
+<p>
+ Don&#8217;t output anything, just set exit status. This is only
+ valid with a single pathname.
+</p>
+</dd>
+<dt class="hdlist1">
+-v, --verbose
+</dt>
+<dd>
+<p>
+ Also output details about the matching pattern (if any)
+ for each given pathname.
+</p>
+</dd>
+<dt class="hdlist1">
+--stdin
+</dt>
+<dd>
+<p>
+ Read file names from stdin instead of from the command-line.
+</p>
+</dd>
+<dt class="hdlist1">
+-z
+</dt>
+<dd>
+<p>
+ The output format is modified to be machine-parseable (see
+ below). If <code>--stdin</code> is also given, input paths are separated
+ with a NUL character instead of a linefeed character.
+</p>
+</dd>
+</dl></div>
+</div>
+</div>
+<div class="sect1">
+<h2 id="_output">OUTPUT</h2>
+<div class="sectionbody">
+<div class="paragraph"><p>By default, any of the given pathnames which match an ignore pattern
+will be output, one per line. If no pattern matches a given path,
+nothing will be output for that path; this means that path will not be
+ignored.</p></div>
+<div class="paragraph"><p>If <code>--verbose</code> is specified, the output is a series of lines of the form:</p></div>
+<div class="paragraph"><p>&lt;source&gt; &lt;COLON&gt; &lt;linenum&gt; &lt;COLON&gt; &lt;pattern&gt; &lt;HT&gt; &lt;pathname&gt;</p></div>
+<div class="paragraph"><p>&lt;pathname&gt; is the path of a file being queried, &lt;pattern&gt; is the
+matching pattern, &lt;source&gt; is the pattern&#8217;s source file, and &lt;linenum&gt;
+is the line number of the pattern within that source. If the pattern
+contained a <code>!</code> prefix or <code>/</code> suffix, it will be preserved in the
+output. &lt;source&gt; will be an absolute path when referring to the file
+configured by <code>core.excludesfile</code>, or relative to the repository root
+when referring to <code>.git/info/exclude</code> or a per-directory exclude file.</p></div>
+<div class="paragraph"><p>If <code>-z</code> is specified, the pathnames in the output are delimited by the
+null character; if <code>--verbose</code> is also specified then null characters
+are also used instead of colons and hard tabs:</p></div>
+<div class="paragraph"><p>&lt;source&gt; &lt;NULL&gt; &lt;linenum&gt; &lt;NULL&gt; &lt;pattern&gt; &lt;NULL&gt; &lt;pathname&gt; &lt;NULL&gt;</p></div>
+</div>
+</div>
+<div class="sect1">
+<h2 id="_exit_status">EXIT STATUS</h2>
+<div class="sectionbody">
+<div class="dlist"><dl>
+<dt class="hdlist1">
+0
+</dt>
+<dd>
+<p>
+ One or more of the provided paths is ignored.
+</p>
+</dd>
+<dt class="hdlist1">
+1
+</dt>
+<dd>
+<p>
+ None of the provided paths are ignored.
+</p>
+</dd>
+<dt class="hdlist1">
+128
+</dt>
+<dd>
+<p>
+ A fatal error was encountered.
+</p>
+</dd>
+</dl></div>
+</div>
+</div>
+<div class="sect1">
+<h2 id="_see_also">SEE ALSO</h2>
+<div class="sectionbody">
+<div class="paragraph"><p><a href="gitignore.html">gitignore(5)</a>
+<a href="gitconfig.html">gitconfig(5)</a>
+<a href="git-ls-files.html">git-ls-files(5)</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">
+Last updated 2013-01-25 13:32:06 PST
+</div>
+</div>
+</body>
+</html>
View
89 git-check-ignore.txt
@@ -0,0 +1,89 @@
+git-check-ignore(1)
+===================
+
+NAME
+----
+git-check-ignore - Debug gitignore / exclude files
+
+
+SYNOPSIS
+--------
+[verse]
+'git check-ignore' [options] pathname...
+'git check-ignore' [options] --stdin < <list-of-paths>
+
+DESCRIPTION
+-----------
+
+For each pathname given via the command-line or from a file via
+`--stdin`, show the pattern from .gitignore (or other input files to
+the exclude mechanism) that decides if the pathname is excluded or
+included. Later patterns within a file take precedence over earlier
+ones.
+
+OPTIONS
+-------
+-q, --quiet::
+ Don't output anything, just set exit status. This is only
+ valid with a single pathname.
+
+-v, --verbose::
+ Also output details about the matching pattern (if any)
+ for each given pathname.
+
+--stdin::
+ Read file names from stdin instead of from the command-line.
+
+-z::
+ The output format is modified to be machine-parseable (see
+ below). If `--stdin` is also given, input paths are separated
+ with a NUL character instead of a linefeed character.
+
+OUTPUT
+------
+
+By default, any of the given pathnames which match an ignore pattern
+will be output, one per line. If no pattern matches a given path,
+nothing will be output for that path; this means that path will not be
+ignored.
+
+If `--verbose` is specified, the output is a series of lines of the form:
+
+<source> <COLON> <linenum> <COLON> <pattern> <HT> <pathname>
+
+<pathname> is the path of a file being queried, <pattern> is the
+matching pattern, <source> is the pattern's source file, and <linenum>
+is the line number of the pattern within that source. If the pattern
+contained a `!` prefix or `/` suffix, it will be preserved in the
+output. <source> will be an absolute path when referring to the file
+configured by `core.excludesfile`, or relative to the repository root
+when referring to `.git/info/exclude` or a per-directory exclude file.
+
+If `-z` is specified, the pathnames in the output are delimited by the
+null character; if `--verbose` is also specified then null characters
+are also used instead of colons and hard tabs:
+
+<source> <NULL> <linenum> <NULL> <pattern> <NULL> <pathname> <NULL>
+
+
+EXIT STATUS
+-----------
+
+0::
+ One or more of the provided paths is ignored.
+
+1::
+ None of the provided paths are ignored.
+
+128::
+ A fatal error was encountered.
+
+SEE ALSO
+--------
+linkgit:gitignore[5]
+linkgit:gitconfig[5]
+linkgit:git-ls-files[5]
+
+GIT
+---
+Part of the linkgit:git[1] suite
View
39 git-cvsserver.html
@@ -1234,8 +1234,41 @@ <h2 id="_clients_known_to_work">Clients known to work</h2>
<h2 id="_operations_supported">Operations supported</h2>
<div class="sectionbody">
<div class="paragraph"><p>All the operations required for normal use are supported, including
-checkout, diff, status, update, log, add, remove, commit.
-Legacy monitoring operations are not supported (edit, watch and related).
+checkout, diff, status, update, log, add, remove, commit.</p></div>
+<div class="paragraph"><p>Most CVS command arguments that read CVS tags or revision numbers
+(typically -r) work, and also support any git refspec
+(tag, branch, commit ID, etc).
+However, CVS revision numbers for non-default branches are not well
+emulated, and cvs log does not show tags or branches at
+all. (Non-main-branch CVS revision numbers superficially resemble CVS
+revision numbers, but they actually encode a git commit ID directly,
+rather than represent the number of revisions since the branch point.)</p></div>
+<div class="paragraph"><p>Note that there are two ways to checkout a particular branch.
+As described elsewhere on this page, the "module" parameter
+of cvs checkout is interpreted as a branch name, and it becomes
+the main branch. It remains the main branch for a given sandbox
+even if you temporarily make another branch sticky with
+cvs update -r. Alternatively, the -r argument can indicate
+some other branch to actually checkout, even though the module
+is still the "main" branch. Tradeoffs (as currently
+implemented): Each new "module" creates a new database on disk with
+a history for the given module, and after the database is created,
+operations against that main branch are fast. Or alternatively,
+-r doesn&#8217;t take any extra disk space, but may be significantly slower for
+many operations, like cvs update.</p></div>
+<div class="paragraph"><p>If you want to refer to a git refspec that has characters that are
+not allowed by CVS, you have two options. First, it may just work
+to supply the git refspec directly to the appropriate CVS -r argument;
+some CVS clients don&#8217;t seem to do much sanity checking of the argument.
+Second, if that fails, you can use a special character escape mechanism
+that only uses characters that are valid in CVS tags. A sequence
+of 4 or 5 characters of the form (underscore (<code>"_"</code>), dash (<code>"-"</code>),
+one or two characters, and dash (<code>"-"</code>)) can encode various characters based
+on the one or two letters: <code>"s"</code> for slash (<code>"/"</code>), <code>"p"</code> for
+period (<code>"."</code>), <code>"u"</code> for underscore (<code>"_"</code>), or two hexadecimal digits
+for any byte value at all (typically an ASCII number, or perhaps a part
+of a UTF-8 encoded character).</p></div>
+<div class="paragraph"><p>Legacy monitoring operations are not supported (edit, watch and related).
Exports and tagging (tags and branches) are not supported at this stage.</p></div>
<div class="sect2">
<h3 id="_crlf_line_ending_conversions">CRLF Line Ending Conversions</h3>
@@ -1276,7 +1309,7 @@ <h2 id="_git">GIT</h2>
<div id="footnotes"><hr /></div>
<div id="footer">
<div id="footer-text">
-Last updated 2012-05-02 15:00:44 PDT
+Last updated 2013-01-25 13:32:06 PST
</div>
</div>
</body>
View
37 git-cvsserver.txt
@@ -359,6 +359,43 @@ Operations supported
All the operations required for normal use are supported, including
checkout, diff, status, update, log, add, remove, commit.
+
+Most CVS command arguments that read CVS tags or revision numbers
+(typically -r) work, and also support any git refspec
+(tag, branch, commit ID, etc).
+However, CVS revision numbers for non-default branches are not well
+emulated, and cvs log does not show tags or branches at
+all. (Non-main-branch CVS revision numbers superficially resemble CVS
+revision numbers, but they actually encode a git commit ID directly,
+rather than represent the number of revisions since the branch point.)
+
+Note that there are two ways to checkout a particular branch.
+As described elsewhere on this page, the "module" parameter
+of cvs checkout is interpreted as a branch name, and it becomes
+the main branch. It remains the main branch for a given sandbox
+even if you temporarily make another branch sticky with
+cvs update -r. Alternatively, the -r argument can indicate
+some other branch to actually checkout, even though the module
+is still the "main" branch. Tradeoffs (as currently
+implemented): Each new "module" creates a new database on disk with
+a history for the given module, and after the database is created,
+operations against that main branch are fast. Or alternatively,
+-r doesn't take any extra disk space, but may be significantly slower for
+many operations, like cvs update.
+
+If you want to refer to a git refspec that has characters that are
+not allowed by CVS, you have two options. First, it may just work
+to supply the git refspec directly to the appropriate CVS -r argument;
+some CVS clients don't seem to do much sanity checking of the argument.
+Second, if that fails, you can use a special character escape mechanism
+that only uses characters that are valid in CVS tags. A sequence
+of 4 or 5 characters of the form (underscore (`"_"`), dash (`"-"`),
+one or two characters, and dash (`"-"`)) can encode various characters based
+on the one or two letters: `"s"` for slash (`"/"`), `"p"` for
+period (`"."`), `"u"` for underscore (`"_"`), or two hexadecimal digits
+for any byte value at all (typically an ASCII number, or perhaps a part
+of a UTF-8 encoded character).
+
Legacy monitoring operations are not supported (edit, watch and related).
Exports and tagging (tags and branches) are not supported at this stage.
View
10 git.html
@@ -2017,6 +2017,14 @@ <h3 id="_internal_helper_commands">Internal helper commands</h3>
</p>
</dd>
<dt class="hdlist1">
+<a href="git-check-ignore.html">git-check-ignore(1)</a>
+</dt>
+<dd>
+<p>
+ Debug gitignore / exclude files.
+</p>
+</dd>
+<dt class="hdlist1">
<a href="git-check-ref-format.html">git-check-ref-format(1)</a>
</dt>
<dd>
@@ -2726,7 +2734,7 @@ <h2 id="_git">GIT</h2>
<div id="footnotes"><hr /></div>
<div id="footer">
<div id="footer-text">
-Last updated 2013-01-07 00:07:51 PST
+Last updated 2013-01-14 11:47:43 PST
</div>
</div>
</body>
View
30 githooks.html
@@ -892,6 +892,34 @@ <h3 id="_post_merge">post-merge</h3>
for an example of how to do this.</p></div>
</div>
<div class="sect2">
+<h3 id="_pre_push">pre-push</h3>
+<div class="paragraph"><p>This hook is called by <em>git push</em> and can be used to prevent a push from taking
+place. The hook is called with two parameters which provide the name and
+location of the destination remote, if a named remote is not being used both
+values will be the same.</p></div>
+<div class="paragraph"><p>Information about what is to be pushed is provided on the hook&#8217;s standard
+input with lines of the form:</p></div>
+<div class="literalblock">
+<div class="content">
+<pre><code>&lt;local ref&gt; SP &lt;local sha1&gt; SP &lt;remote ref&gt; SP &lt;remote sha1&gt; LF</code></pre>
+</div></div>
+<div class="paragraph"><p>For instance, if the command <code>git push origin master:foreign</code> were run the
+hook would receive a line like the following:</p></div>
+<div class="literalblock">
+<div class="content">
+<pre><code>refs/heads/master 67890 refs/heads/foreign 12345</code></pre>
+</div></div>
+<div class="paragraph"><p>although the full, 40-character SHA1s would be supplied. If the foreign ref
+does not yet exist the <code>&lt;remote SHA1&gt;</code> will be 40 <code>0</code>. If a ref is to be
+deleted, the <code>&lt;local ref&gt;</code> will be supplied as <code>(delete)</code> and the <code>&lt;local
+SHA1&gt;</code> will be 40 <code>0</code>. If the local commit was specified by something other
+than a name which could be expanded (such as <code>HEAD~</code>, or a SHA1) it will be
+supplied as it was originally given.</p></div>
+<div class="paragraph"><p>If this hook exits with a non-zero status, <em>git push</em> will abort without
+pushing anything. Information about why the push is rejected may be sent
+to the user by writing to standard error.</p></div>
+</div>
+<div class="sect2">
<h3 id="pre-receive">pre-receive</h3>
<div class="paragraph"><p>This hook is invoked by <em>git-receive-pack</em> on the remote repository,
which happens when a <em>git push</em> is done on a local repository.
@@ -1065,7 +1093,7 @@ <h2 id="_git">GIT</h2>
<div id="footnotes"><hr /></div>
<div id="footer">
<div id="footer-text">
-Last updated 2012-05-02 15:00:44 PDT
+Last updated 2013-01-25 13:32:06 PST
</div>
</div>
</body>
View
29 githooks.txt
@@ -176,6 +176,35 @@ save and restore any form of metadata associated with the working tree
(eg: permissions/ownership, ACLS, etc). See contrib/hooks/setgitperms.perl
for an example of how to do this.
+pre-push
+~~~~~~~~
+
+This hook is called by 'git push' and can be used to prevent a push from taking
+place. The hook is called with two parameters which provide the name and
+location of the destination remote, if a named remote is not being used both
+values will be the same.
+
+Information about what is to be pushed is provided on the hook's standard
+input with lines of the form:
+
+ <local ref> SP <local sha1> SP <remote ref> SP <remote sha1> LF
+
+For instance, if the command +git push origin master:foreign+ were run the
+hook would receive a line like the following:
+
+ refs/heads/master 67890 refs/heads/foreign 12345
+
+although the full, 40-character SHA1s would be supplied. If the foreign ref
+does not yet exist the `<remote SHA1>` will be 40 `0`. If a ref is to be
+deleted, the `<local ref>` will be supplied as `(delete)` and the `<local
+SHA1>` will be 40 `0`. If the local commit was specified by something other
+than a name which could be expanded (such as `HEAD~`, or a SHA1) it will be
+supplied as it was originally given.
+
+If this hook exits with a non-zero status, 'git push' will abort without
+pushing anything. Information about why the push is rejected may be sent
+to the user by writing to standard error.
+
[[pre-receive]]
pre-receive
~~~~~~~~~~~
View
8 gitignore.html
@@ -984,8 +984,10 @@ <h2 id="_examples">EXAMPLES</h2>
<div class="sect1">
<h2 id="_see_also">SEE ALSO</h2>
<div class="sectionbody">
-<div class="paragraph"><p><a href="git-rm.html">git-rm(1)</a>, <a href="git-update-index.html">git-update-index(1)</a>,
-<a href="gitrepository-layout.html">gitrepository-layout(5)</a></p></div>
+<div class="paragraph"><p><a href="git-rm.html">git-rm(1)</a>,
+<a href="git-update-index.html">git-update-index(1)</a>,
+<a href="gitrepository-layout.html">gitrepository-layout(5)</a>,
+<a href="git-check-ignore.html">git-check-ignore(1)</a></p></div>
</div>
</div>
<div class="sect1">
@@ -998,7 +1000,7 @@ <h2 id="_git">GIT</h2>
<div id="footnotes"><hr /></div>
<div id="footer">
<div id="footer-text">
-Last updated 2013-01-10 15:37:47 PST
+Last updated 2013-01-25 13:32:06 PST
</div>
</div>
</body>
View
6 gitignore.txt
@@ -184,8 +184,10 @@ The second .gitignore prevents git from ignoring
SEE ALSO
--------
-linkgit:git-rm[1], linkgit:git-update-index[1],
-linkgit:gitrepository-layout[5]
+linkgit:git-rm[1],
+linkgit:git-update-index[1],
+linkgit:gitrepository-layout[5],
+linkgit:git-check-ignore[1]
GIT
---
View
450 howto/maintain-git.html
@@ -734,13 +734,14 @@
<h1>How to maintain Git</h1>
</div>
<div id="content">
-<div id="preamble">
+<div class="sect1">
+<h2 id="_activities">Activities</h2>
<div class="sectionbody">
<div class="paragraph"><p>The maintainer&#8217;s git time is spent on three activities.</p></div>
<div class="ulist"><ul>
<li>
<p>
-Communication (60%)
+Communication (45%)
</p>
<div class="literalblock">
<div class="content">
@@ -751,7 +752,7 @@
</li>
<li>
<p>
-Integration (30%)
+Integration (50%)
</p>
<div class="literalblock">
<div class="content">
@@ -763,18 +764,22 @@
</li>
<li>
<p>
-Own development (10%)
+Own development (5%)
</p>
<div class="literalblock">
<div class="content">
<pre><code>Scratching my own itch and sending proposed patch series out.</code></pre>
</div></div>
</li>
</ul></div>
+</div>
+</div>
+<div class="sect1">
+<h2 id="_the_policy">The Policy</h2>
+<div class="sectionbody">
<div class="paragraph"><p>The policy on Integration is informally mentioned in "A Note
from the maintainer" message, which is periodically posted to
this mailing list after each feature release is made.</p></div>
-<div class="paragraph"><p>The policy.</p></div>
<div class="ulist"><ul>
<li>
<p>
@@ -785,6 +790,12 @@
</li>
<li>
<p>
+One release cycle for a feature release is expected to last for
+ eight to ten weeks.
+</p>
+</li>
+<li>
+<p>
Maintenance releases are numbered as vX.Y.Z.W and are meant
to contain only bugfixes for the corresponding vX.Y.Z feature
release and earlier maintenance releases vX.Y.Z.V (V &lt; W).
@@ -823,15 +834,18 @@
</li>
<li>
<p>
-The tips of <em>master</em>, <em>maint</em> and <em>next</em> branches will always
- fast-forward, to allow people to build their own
- customization on top of them.
+The tips of <em>master</em> and <em>maint</em> branches will not be rewound to
+ allow people to build their own customization on top of them.
+ Early in a new development cycle, <em>next</em> is rewound to the tip of
+ <em>master</em> once, but otherwise it will not be rewound until the end
+ of the cycle.
</p>
</li>
<li>
<p>
-Usually <em>master</em> contains all of <em>maint</em>, <em>next</em> contains all
- of <em>master</em> and <em>pu</em> contains all of <em>next</em>.
+Usually <em>master</em> contains all of <em>maint</em> and <em>next</em> contains all
+ of <em>master</em>. <em>pu</em> contains all the topics merged to <em>next</em>, but
+ is rebuilt directly on <em>master</em>.
</p>
</li>
<li>
@@ -848,16 +862,29 @@
</p>
</li>
</ul></div>
+</div>
+</div>
+<div class="sect1">
+<h2 id="_a_typical_git_day">A Typical Git Day</h2>
+<div class="sectionbody">
<div class="paragraph"><p>A typical git day for the maintainer implements the above policy
by doing the following:</p></div>
<div class="ulist"><ul>
<li>
<p>
-Scan mailing list and #git channel log. Respond with review
- comments, suggestions etc. Kibitz. Collect potentially
- usable patches from the mailing list. Patches about a single
- topic go to one mailbox (I read my mail in Gnus, and type
- \C-o to save/append messages in files in mbox format).
+Scan mailing list. Respond with review comments, suggestions
+ etc. Kibitz. Collect potentially usable patches from the
+ mailing list. Patches about a single topic go to one mailbox (I
+ read my mail in Gnus, and type \C-o to save/append messages in
+ files in mbox format).
+</p>
+</li>
+<li>
+<p>
+Write his own patches to address issues raised on the list but
+ nobody has stepped up solving. Send it out just like other
+ contributors do, and pick them up just like patches from other
+ contributors (see above).
</p>
</li>
<li>
@@ -885,64 +912,50 @@
Obviously correct fixes that pertain to the tip of <em>master</em>
are directly applied to <em>master</em>.
</p>
+</li>
+<li>
+<p>
+Other topics are not handled in this step.
+</p>
<div class="literalblock">
<div class="content">
<pre><code>This step is done with "git am".</code></pre>
</div></div>
<div class="literalblock">
<div class="content">
<pre><code>$ git checkout master ;# or "git checkout maint"
-$ git am -3 -s mailbox
+$ git am -sc3 mailbox
$ make test</code></pre>
</div></div>
-</li>
-<li>
-<p>
-Merge downwards (maint&#8594;master):
-</p>
<div class="literalblock">
<div class="content">
-<pre><code>$ git checkout master
-$ git merge maint
-$ make test</code></pre>
+<pre><code>In practice, almost no patch directly goes to 'master' or
+'maint'.</code></pre>
</div></div>
</li>
<li>
<p>
Review the last issue of "What&#8217;s cooking" message, review the
- topics scheduled for merging upwards (topic&#8594;master and
- topic&#8594;maint), and merge.
+ topics ready for merging (topic&#8594;master and topic&#8594;maint). Use
+ "Meta/cook -w" script (where Meta/ contains a checkout of the
+ <em>todo</em> branch) to aid this step.
</p>
<div class="literalblock">
<div class="content">
-<pre><code>$ git checkout master ;# or "git checkout maint"
-$ git merge ai/topic ;# or "git merge ai/maint-topic"
-$ git log -p ORIG_HEAD.. ;# final review
-$ git diff ORIG_HEAD.. ;# final review
-$ make test ;# final review
-$ git branch -d ai/topic ;# or "git branch -d ai/maint-topic"</code></pre>
+<pre><code>And perform the merge. Use "Meta/Reintegrate -e" script (see
+later) to aid this step.</code></pre>
</div></div>
-</li>
-<li>
-<p>
-Merge downwards (maint&#8594;master) if needed:
-</p>
<div class="literalblock">
<div class="content">
-<pre><code>$ git checkout master
-$ git merge maint
-$ make test</code></pre>
+<pre><code>$ Meta/cook -w last-issue-of-whats-cooking.mbox</code></pre>
</div></div>
-</li>
-<li>
-<p>
-Merge downwards (master&#8594;next) if needed:
-</p>
<div class="literalblock">
<div class="content">
-<pre><code>$ git checkout next
-$ git merge master
-$ make test</code></pre>
+<pre><code>$ git checkout master ;# or "git checkout maint"
+$ echo ai/topic | Meta/Reintegrate -e ;# "git merge ai/topic"
+$ git log -p ORIG_HEAD.. ;# final review
+$ git diff ORIG_HEAD.. ;# final review
+$ make test ;# final review</code></pre>
</div></div>
</li>
<li>
@@ -957,9 +970,9 @@
and not in <em>master</em>) is applied to a new topic branch that
is forked from the tip of <em>master</em>. This includes both
enhancements and unobvious fixes to <em>master</em>. A topic
- branch is named as ai/topic where "ai" is typically
- author&#8217;s initial and "topic" is a descriptive name of the
- topic (in other words, "what&#8217;s the series is about").
+ branch is named as ai/topic where "ai" is two-letter string
+ named after author&#8217;s initial and "topic" is a descriptive name
+ of the topic (in other words, "what&#8217;s the series is about").
</p>
</li>
<li>
@@ -996,7 +1009,8 @@
</div></div>
<div class="literalblock">
<div class="content">
-<pre><code>$ git am -3 -s mailbox</code></pre>
+<pre><code>$ git checkout ai/topic ;# or "git checkout -b ai/topic master"
+$ git am -sc3 mailbox</code></pre>
</div></div>
<div class="literalblock">
<div class="content">
@@ -1012,8 +1026,9 @@
</div></div>
<div class="literalblock">
<div class="content">
-<pre><code>$ git reset --hard ai/topic~$n
-$ git am -3 -s 000*.txt</code></pre>
+<pre><code>$ git checkout ai/topic
+$ git reset --hard ai/topic~$n
+$ git am -sc3 -s 000*.txt</code></pre>
</div></div>
<div class="literalblock">
<div class="content">
@@ -1024,141 +1039,269 @@
</li>
<li>
<p>
-Update "What&#8217;s cooking" message to review the updates to
- existing topics, newly added topics and graduated topics.
+Merge maint to master as needed:
</p>
<div class="literalblock">
<div class="content">
-<pre><code>This step is helped with Meta/cook script (where Meta/ contains
-a checkout of the 'todo' branch).</code></pre>
+<pre><code>$ git checkout master
+$ git merge maint
+$ make test</code></pre>
</div></div>
</li>
<li>
<p>
-Merge topics to <em>next</em>. For each branch whose tip is not
- merged to <em>next</em>, one of three things can happen:
-</p>
-</li>
-<li>
-<p>
-The commits are all next-worthy; merge the topic to next:
+Merge master to next as needed:
</p>
<div class="literalblock">
<div class="content">
<pre><code>$ git checkout next
-$ git merge ai/topic ;# or "git merge ai/maint-topic"
+$ git merge master
$ make test</code></pre>
</div></div>
</li>
<li>
<p>
-The new parts are of mixed quality, but earlier ones are
- next-worthy; merge the early parts to next:
+Review the last issue of "What&#8217;s cooking" again and see if topics
+ that are ready to be merged to <em>next</em> are still in good shape
+ (e.g. has there any new issue identified on the list with the
+ series?)
+</p>
+</li>
+<li>
+<p>
+Prepare <em>jch</em> branch, which is used to represent somewhere
+ between <em>master</em> and <em>pu</em> and often is slightly ahead of <em>next</em>.
</p>
<div class="literalblock">
<div class="content">
-<pre><code>$ git checkout next
-$ git merge ai/topic~2 ;# the tip two are dubious
-$ make test</code></pre>
+<pre><code>$ Meta/Reintegrate master..pu &gt;Meta/redo-jch.sh</code></pre>
+</div></div>
+<div class="literalblock">
+<div class="content">
+<pre><code>The result is a script that lists topics to be merged in order to
+rebuild 'pu' as the input to Meta/Reintegrate script. Remove
+later topics that should not be in 'jch' yet. Add a line that
+consists of '### match next' before the name of the first topic
+in the output that should be in 'jch' but not in 'next' yet.</code></pre>
</div></div>
</li>
<li>
<p>
-Nothing is next-worthy; do not do anything.
+Now we are ready to start merging topics to <em>next</em>. For each
+ branch whose tip is not merged to <em>next</em>, one of three things can
+ happen:
+</p>
+</li>
+<li>
+<p>
+The commits are all next-worthy; merge the topic to next;
</p>
</li>
<li>
<p>
-[<strong> OBSOLETE </strong>] Optionally rebase topics that do not have any commit
- in next yet, when they can take advantage of low-level framework
- change that is merged to <em>master</em> already.
+The new parts are of mixed quality, but earlier ones are
+ next-worthy; merge the early parts to next;
+</p>
+</li>
+<li>
+<p>
+Nothing is next-worthy; do not do anything.
</p>
<div class="literalblock">
<div class="content">
-<pre><code>$ git rebase master ai/topic</code></pre>
+<pre><code>This step is aided with Meta/redo-jch.sh script created earlier.
+If a topic that was already in 'next' gained a patch, the script
+would list it as "ai/topic~1". To include the new patch to the
+updated 'next', drop the "~1" part; to keep it excluded, do not
+touch the line. If a topic that was not in 'next' should be
+merged to 'next', add it at the end of the list. Then:</code></pre>
</div></div>
<div class="literalblock">
<div class="content">
-<pre><code>This step is helped with Meta/git-topic.perl script to
-identify which topic is rebaseable. There also is a
-pre-rebase hook to make sure that topics that are already in
-'next' are not rebased beyond the merged commit.</code></pre>
+<pre><code>$ git checkout -B jch master
+$ Meta/redo-jch.sh -c1</code></pre>
</div></div>
-</li>
-<li>
-<p>
-[<strong> OBSOLETE </strong>] Rebuild "pu" to merge the tips of topics not in <em>next</em>.
-</p>
<div class="literalblock">
<div class="content">
-<pre><code>$ git checkout pu
-$ git reset --hard next
-$ git merge ai/topic ;# repeat for all remaining topics
-$ make test</code></pre>
+<pre><code>to rebuild the 'jch' branch from scratch. "-c1" tells the script
+to stop merging at the first line that begins with '###'
+(i.e. the "### match next" line you added earlier).</code></pre>
</div></div>
<div class="literalblock">
<div class="content">
-<pre><code>This step is helped with Meta/PU script</code></pre>
+<pre><code>At this point, build-test the result. It may reveal semantic
+conflicts (e.g. a topic renamed a variable, another added a new
+reference to the variable under its old name), in which case
+prepare an appropriate merge-fix first (see appendix), and
+rebuild the 'jch' branch from scratch, starting at the tip of
+'master'.</code></pre>
+</div></div>
+<div class="literalblock">
+<div class="content">
+<pre><code>Then do the same to 'next'</code></pre>
+</div></div>
+<div class="literalblock">
+<div class="content">
+<pre><code>$ git checkout next
+$ sh Meta/redo-jch.sh -c1 -e</code></pre>
+</div></div>
+<div class="literalblock">
+<div class="content">
+<pre><code>The "-e" option allows the merge message that comes from the
+history of the topic and the comments in the "What's cooking" to
+be edited. The resulting tree should match 'jch' as the same set
+of topics are merged on 'master'; otherwise there is a mismerge.
+Investigate why and do not proceed until the mismerge is found
+and rectified.</code></pre>
+</div></div>
+<div class="literalblock">
+<div class="content">
+<pre><code>$ git diff jch next</code></pre>
+</div></div>
+<div class="literalblock">
+<div class="content">
+<pre><code>When all is well, clean up the redo-jch.sh script with</code></pre>
+</div></div>
+<div class="literalblock">
+<div class="content">
+<pre><code>$ sh Meta/redo-jch.sh -u</code></pre>
+</div></div>
+<div class="literalblock">
+<div class="content">
+<pre><code>This removes topics listed in the script that have already been
+merged to 'master'. This may lose '### match next' marker;
+add it again to the appropriate place when it happens.</code></pre>
</div></div>
</li>
<li>
<p>
-Push four integration branches to a private repository at
- k.org and run "make test" on all of them.
+Rebuild <em>pu</em>.
</p>
+<div class="literalblock">
+<div class="content">
+<pre><code>$ Meta/Reintegrate master..pu &gt;Meta/redo-pu.sh</code></pre>
+</div></div>
+<div class="literalblock">
+<div class="content">
+<pre><code>Edit the result by adding new topics that are not still in 'pu'
+in the script. Then</code></pre>
+</div></div>
+<div class="literalblock">
+<div class="content">
+<pre><code>$ git checkout -B pu jch
+$ sh Meta/redo-pu.sh</code></pre>
+</div></div>
+<div class="literalblock">
+<div class="content">
+<pre><code>When all is well, clean up the redo-pu.sh script with</code></pre>
+</div></div>
+<div class="literalblock">
+<div class="content">
+<pre><code>$ sh Meta/redo-pu.sh -u</code></pre>
+</div></div>
+<div class="literalblock">
+<div class="content">
+<pre><code>Double check by running</code></pre>
+</div></div>
+<div class="literalblock">
+<div class="content">
+<pre><code>$ git branch --no-merged pu</code></pre>
+</div></div>
+<div class="literalblock">
+<div class="content">
+<pre><code>to see there is no unexpected leftover topics.</code></pre>
+</div></div>
+<div class="literalblock">
+<div class="content">
+<pre><code>At this point, build-test the result for semantic conflicts, and
+if there are, prepare an appropriate merge-fix first (see
+appendix), and rebuild the 'pu' branch from scratch, starting at
+the tip of 'jch'.</code></pre>
+</div></div>
</li>
<li>
<p>
-Push four integration branches to /pub/scm/git/git.git at
- k.org. This triggers its post-update hook which:
+Update "What&#8217;s cooking" message to review the updates to
+ existing topics, newly added topics and graduated topics.
</p>
<div class="literalblock">
<div class="content">
-<pre><code>(1) runs "git pull" in $HOME/git-doc/ repository to pull
- 'master' just pushed out;</code></pre>
+<pre><code>This step is helped with Meta/cook script.</code></pre>
+</div></div>
+<div class="literalblock">
+<div class="content">
+<pre><code>$ Meta/cook</code></pre>
</div></div>
<div class="literalblock">
<div class="content">
-<pre><code>(2) runs "make doc" in $HOME/git-doc/, install the generated
- documentation in staging areas, which are separate
- repositories that have html and man branches checked
- out.</code></pre>
+<pre><code>This script inspects the history between master..pu, finds tips
+of topic branches, compares what it found with the current
+contents in Meta/whats-cooking.txt, and updates that file.
+Topics not listed in the file but are found in master..pu are
+added to the "New topics" section, topics listed in the file that
+are no longer found in master..pu are moved to the "Graduated to
+master" section, and topics whose commits changed their states
+(e.g. used to be only in 'pu', now merged to 'next') are updated
+with change markers "&lt;&lt;" and "&gt;&gt;".</code></pre>
</div></div>
<div class="literalblock">
<div class="content">
-<pre><code>(3) runs "git commit" in the staging areas, and run "git
- push" back to /pub/scm/git/git.git/ to update the html
- and man branches.</code></pre>
+<pre><code>Look for lines enclosed in "&lt;&lt;" and "&gt;&gt;"; they hold contents from
+old file that are replaced by this integration round. After
+verifying them, remove the old part. Review the description for
+each topic and update its doneness and plan as needed. To review
+the updated plan, run</code></pre>
</div></div>
<div class="literalblock">
<div class="content">
-<pre><code>(4) installs generated documentation to /pub/software/scm/git/docs/
- to be viewed from http://www.kernel.org/</code></pre>
+<pre><code>$ Meta/cook -w</code></pre>
+</div></div>
+<div class="literalblock">
+<div class="content">
+<pre><code>which will pick up comments given to the topics, such as "Will
+merge to 'next'", etc. (see Meta/cook script to learn what kind
+of phrases are supported).</code></pre>
</div></div>
</li>
<li>
<p>
-Fetch html and man branches back from k.org, and push four
- integration branches and the two documentation branches to
- repo.or.cz and other mirrors.
+Compile, test and install all four (five) integration branches;
+ Meta/Dothem script may aid this step.
+</p>
+</li>
+<li>
+<p>
+Format documentation if the <em>master</em> branch was updated;
+ Meta/dodoc.sh script may aid this step.
+</p>
+</li>
+<li>
+<p>
+Push the integration branches out to public places; Meta/pushall
+ script may aid this step.
</p>
</li>
</ul></div>
+</div>
+</div>
+<div class="sect1">
+<h2 id="_observations">Observations</h2>
+<div class="sectionbody">
<div class="paragraph"><p>Some observations to be made.</p></div>
<div class="ulist"><ul>
<li>
<p>
-Each topic is tested individually, and also together with
- other topics cooking in <em>next</em>. Until it matures, none part
- of it is merged to <em>master</em>.
+Each topic is tested individually, and also together with other
+ topics cooking first in <em>pu</em>, then in <em>jch</em> and then in <em>next</em>.
+ Until it matures, no part of it is merged to <em>master</em>.
</p>
</li>
<li>
<p>
A topic already in <em>next</em> can get fixes while still in
<em>next</em>. Such a topic will have many merges to <em>next</em> (in
other words, "git log --first-parent next" will show many
- "Merge ai/topic to next" for the same topic.
+ "Merge branch <em>ai/topic</em> to next" for the same topic.
</p>
</li>
<li>
@@ -1200,11 +1343,92 @@
</ul></div>
</div>
</div>
+<div class="sect1">
+<h2 id="_appendix">Appendix</h2>
+<div class="sectionbody">
+<div class="sect2">
+<h3 id="_preparing_a_merge_fix">Preparing a "merge-fix"</h3>
+<div class="paragraph"><p>A merge of two topics may not textually conflict but still have
+conflict at the semantic level. A classic example is for one topic
+to rename an variable and all its uses, while another topic adds a
+new use of the variable under its old name. When these two topics
+are merged together, the reference to the variable newly added by
+the latter topic will still use the old name in the result.</p></div>
+<div class="paragraph"><p>The Meta/Reintegrate script that is used by redo-jch and redo-pu
+scripts implements a crude but usable way to work this issue around.
+When the script merges branch $X, it checks if "refs/merge-fix/$X"
+exists, and if so, the effect of it is squashed into the result of
+the mechanical merge. In other words,</p></div>
+<div class="literalblock">
+<div class="content">
+<pre><code>$ echo $X | Meta/Reintegrate</code></pre>
+</div></div>
+<div class="paragraph"><p>is roughly equivalent to this sequence:</p></div>
+<div class="literalblock">
+<div class="content">
+<pre><code>$ git merge --rerere-autoupdate $X
+$ git commit
+$ git cherry-pick -n refs/merge-fix/$X
+$ git commit --amend</code></pre>
+</div></div>
+<div class="paragraph"><p>The goal of this "prepare a merge-fix" step is to come up with a
+commit that can be squashed into a result of mechanical merge to
+correct semantic conflicts.</p></div>
+<div class="paragraph"><p>After finding that the result of merging branch "ai/topic" to an
+integration branch had such a semantic conflict, say pu~4, check the
+problematic merge out on a detached HEAD, edit the working tree to
+fix the semantic conflict, and make a separate commit to record the
+fix-up:</p></div>
+<div class="literalblock">
+<div class="content">
+<pre><code>$ git checkout pu~4
+$ git show -s --pretty=%s ;# double check
+Merge branch 'ai/topic' to pu
+$ edit
+$ git commit -m 'merge-fix/ai/topic' -a</code></pre>
+</div></div>
+<div class="paragraph"><p>Then make a reference "refs/merge-fix/ai/topic" to point at this
+result:</p></div>
+<div class="literalblock">
+<div class="content">
+<pre><code>$ git update-ref refs/merge-fix/ai/topic HEAD</code></pre>
+</div></div>
+<div class="paragraph"><p>Then double check the result by asking Meta/Reintegrate to redo the
+merge:</p></div>
+<div class="literalblock">
+<div class="content">
+<pre><code>$ git checkout pu~5 ;# the parent of the problem merge
+$ echo ai/topic | Meta/Reintegrate
+$ git diff pu~4</code></pre>
+</div></div>
+<div class="paragraph"><p>This time, because you prepared refs/merge-fix/ai/topic, the
+resulting merge should have been tweaked to include the fix for the
+semantic conflict.</p></div>
+<div class="paragraph"><p>Note that this assumes that the order in which conflicting branches
+are merged does not change. If the reason why merging ai/topic
+branch needs this merge-fix is because another branch merged earlier
+to the integration branch changed the underlying assumption ai/topic
+branch made (e.g. ai/topic branch added a site to refer to a
+variable, while the other branch renamed that variable and adjusted
+existing use sites), and if you changed redo-jch (or redo-pu) script
+to merge ai/topic branch before the other branch, then the above
+merge-fix should not be applied while merging ai/topic, but should
+instead be applied while merging the other branch. You would need
+to move the fix to apply to the other branch, perhaps like this:</p></div>
+<div class="literalblock">
+<div class="content">
+<pre><code>$ mf=refs/merge-fix
+$ git update-ref $mf/$the_other_branch $mf/ai/topic
+$ git update-ref -d $mf/ai/topic</code></pre>
+</div></div>
+</div>
+</div>
+</div>
</div>
<div id="footnotes"><hr /></div>
<div id="footer">
<div id="footer-text">
-Last updated 2012-12-31 16:06:41 PST
+Last updated 2013-01-25 13:32:11 PST
</div>
</div>
</body>
View
347 howto/maintain-git.txt
@@ -10,35 +10,42 @@ Content-type: text/asciidoc
How to maintain Git
===================
+Activities
+----------
+
The maintainer's git time is spent on three activities.
- - Communication (60%)
+ - Communication (45%)
Mailing list discussions on general design, fielding user
questions, diagnosing bug reports; reviewing, commenting on,
suggesting alternatives to, and rejecting patches.
- - Integration (30%)
+ - Integration (50%)
Applying new patches from the contributors while spotting and
correcting minor mistakes, shuffling the integration and
testing branches, pushing the results out, cutting the
releases, and making announcements.
- - Own development (10%)
+ - Own development (5%)
Scratching my own itch and sending proposed patch series out.
+The Policy
+----------
+
The policy on Integration is informally mentioned in "A Note
from the maintainer" message, which is periodically posted to
this mailing list after each feature release is made.
-The policy.
-
- Feature releases are numbered as vX.Y.Z and are meant to
contain bugfixes and enhancements in any area, including
functionality, performance and usability, without regression.
+ - One release cycle for a feature release is expected to last for
+ eight to ten weeks.
+
- Maintenance releases are numbered as vX.Y.Z.W and are meant
to contain only bugfixes for the corresponding vX.Y.Z feature
release and earlier maintenance releases vX.Y.Z.V (V < W).
@@ -62,12 +69,15 @@ The policy.
- 'pu' branch is used to publish other proposed changes that do
not yet pass the criteria set for 'next'.
- - The tips of 'master', 'maint' and 'next' branches will always
- fast-forward, to allow people to build their own
- customization on top of them.
+ - The tips of 'master' and 'maint' branches will not be rewound to
+ allow people to build their own customization on top of them.
+ Early in a new development cycle, 'next' is rewound to the tip of
+ 'master' once, but otherwise it will not be rewound until the end
+ of the cycle.
- - Usually 'master' contains all of 'maint', 'next' contains all
- of 'master' and 'pu' contains all of 'next'.
+ - Usually 'master' contains all of 'maint' and 'next' contains all
+ of 'master'. 'pu' contains all the topics merged to 'next', but
+ is rebuilt directly on 'master'.
- The tip of 'master' is meant to be more stable than any
tagged releases, and the users are encouraged to follow it.
@@ -77,14 +87,22 @@ The policy.
are found before new topics are merged to 'master'.
+A Typical Git Day
+-----------------
+
A typical git day for the maintainer implements the above policy
by doing the following:
- - Scan mailing list and #git channel log. Respond with review
- comments, suggestions etc. Kibitz. Collect potentially
- usable patches from the mailing list. Patches about a single
- topic go to one mailbox (I read my mail in Gnus, and type
- \C-o to save/append messages in files in mbox format).
+ - Scan mailing list. Respond with review comments, suggestions
+ etc. Kibitz. Collect potentially usable patches from the
+ mailing list. Patches about a single topic go to one mailbox (I
+ read my mail in Gnus, and type \C-o to save/append messages in
+ files in mbox format).
+
+ - Write his own patches to address issues raised on the list but
+ nobody has stepped up solving. Send it out just like other
+ contributors do, and pick them up just like patches from other
+ contributors (see above).
- Review the patches in the saved mailboxes. Edit proposed log
message for typofixes and clarifications, and add Acks
@@ -100,40 +118,32 @@ by doing the following:
- Obviously correct fixes that pertain to the tip of 'master'
are directly applied to 'master'.
+ - Other topics are not handled in this step.
+
This step is done with "git am".
$ git checkout master ;# or "git checkout maint"
- $ git am -3 -s mailbox
+ $ git am -sc3 mailbox
$ make test
- - Merge downwards (maint->master):
-
- $ git checkout master
- $ git merge maint
- $ make test
+ In practice, almost no patch directly goes to 'master' or
+ 'maint'.
- Review the last issue of "What's cooking" message, review the
- topics scheduled for merging upwards (topic->master and
- topic->maint), and merge.
+ topics ready for merging (topic->master and topic->maint). Use
+ "Meta/cook -w" script (where Meta/ contains a checkout of the
+ 'todo' branch) to aid this step.
+
+ And perform the merge. Use "Meta/Reintegrate -e" script (see
+ later) to aid this step.
+
+ $ Meta/cook -w last-issue-of-whats-cooking.mbox
$ git checkout master ;# or "git checkout maint"
- $ git merge ai/topic ;# or "git merge ai/maint-topic"
+ $ echo ai/topic | Meta/Reintegrate -e ;# "git merge ai/topic"
$ git log -p ORIG_HEAD.. ;# final review
$ git diff ORIG_HEAD.. ;# final review
$ make test ;# final review
- $ git branch -d ai/topic ;# or "git branch -d ai/maint-topic"
-
- - Merge downwards (maint->master) if needed:
-
- $ git checkout master
- $ git merge maint
- $ make test
-
- - Merge downwards (master->next) if needed:
-
- $ git checkout next
- $ git merge master
- $ make test
- Handle the remaining patches:
@@ -142,9 +152,9 @@ by doing the following:
and not in 'master') is applied to a new topic branch that
is forked from the tip of 'master'. This includes both
enhancements and unobvious fixes to 'master'. A topic
- branch is named as ai/topic where "ai" is typically
- author's initial and "topic" is a descriptive name of the
- topic (in other words, "what's the series is about").
+ branch is named as ai/topic where "ai" is two-letter string
+ named after author's initial and "topic" is a descriptive name
+ of the topic (in other words, "what's the series is about").
- An unobvious fix meant for 'maint' is applied to a new
topic branch that is forked from the tip of 'maint'. The
@@ -162,101 +172,179 @@ by doing the following:
The above except the "replacement" are all done with:
- $ git am -3 -s mailbox
+ $ git checkout ai/topic ;# or "git checkout -b ai/topic master"
+ $ git am -sc3 mailbox
while patch replacement is often done by:
$ git format-patch ai/topic~$n..ai/topic ;# export existing
then replace some parts with the new patch, and reapplying:
+ $ git checkout ai/topic
$ git reset --hard ai/topic~$n
- $ git am -3 -s 000*.txt
+ $ git am -sc3 -s 000*.txt
The full test suite is always run for 'maint' and 'master'
after patch application; for topic branches the tests are run
as time permits.
- - Update "What's cooking" message to review the updates to
- existing topics, newly added topics and graduated topics.
+ - Merge maint to master as needed:
- This step is helped with Meta/cook script (where Meta/ contains
- a checkout of the 'todo' branch).
-
- - Merge topics to 'next'. For each branch whose tip is not
- merged to 'next', one of three things can happen:
+ $ git checkout master
+ $ git merge maint
+ $ make test
- - The commits are all next-worthy; merge the topic to next:
+ - Merge master to next as needed:
$ git checkout next
- $ git merge ai/topic ;# or "git merge ai/maint-topic"
+ $ git merge master
$ make test
+ - Review the last issue of "What's cooking" again and see if topics
+ that are ready to be merged to 'next' are still in good shape
+ (e.g. has there any new issue identified on the list with the
+ series?)
+
+ - Prepare 'jch' branch, which is used to represent somewhere
+ between 'master' and 'pu' and often is slightly ahead of 'next'.