Last active
August 29, 2015 14:10
-
-
Save mikz/de9730742ccf051c4413 to your computer and use it in GitHub Desktop.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
<!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.9" /> | |
<title>giteveryday(7)</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; | |
} | |
pre { | |
white-space: pre-wrap; | |
} | |
#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; vertical-align: text-bottom; } | |
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"> | |
/*<+'])'); | |
// 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> | |
giteveryday(7) Manual Page | |
</h1> | |
<h2>NAME</h2> | |
<div class="sectionbody"> | |
<p>giteveryday - | |
A useful minimum set of commands for Everyday Git | |
</p> | |
</div> | |
</div> | |
<div id="content"> | |
<div class="sect1"> | |
<h2 id="_synopsis">SYNOPSIS</h2> | |
<div class="sectionbody"> | |
<div class="paragraph"><p>Everyday Git With 20 Commands Or So</p></div> | |
</div> | |
</div> | |
<div class="sect1"> | |
<h2 id="_description">DESCRIPTION</h2> | |
<div class="sectionbody"> | |
<div class="paragraph"><p>Git users can broadly be grouped into four categories for the purposes of | |
describing here a small set of useful command for everyday Git.</p></div> | |
<div class="ulist"><ul> | |
<li> | |
<p> | |
<a href="#STANDALONE">Individual Developer (Standalone)</a> commands are essential | |
for anybody who makes a commit, even for somebody who works alone. | |
</p> | |
</li> | |
<li> | |
<p> | |
If you work with other people, you will need commands listed in | |
the <a href="#PARTICIPANT">Individual Developer (Participant)</a> section as well. | |
</p> | |
</li> | |
<li> | |
<p> | |
People who play the <a href="#INTEGRATOR">Integrator</a> role need to learn some | |
more commands in addition to the above. | |
</p> | |
</li> | |
<li> | |
<p> | |
<a href="#ADMINISTRATION">Repository Administration</a> commands are for system | |
administrators who are responsible for the care and feeding | |
of Git repositories. | |
</p> | |
</li> | |
</ul></div> | |
</div> | |
</div> | |
<div class="sect1"> | |
<h2 id="_individual_developer_standalone_a_id_standalone_a">Individual Developer (Standalone)<a id="STANDALONE"></a></h2> | |
<div class="sectionbody"> | |
<div class="paragraph"><p>A standalone individual developer does not exchange patches with | |
other people, and works alone in a single repository, using the | |
following commands.</p></div> | |
<div class="ulist"><ul> | |
<li> | |
<p> | |
<a href="git-init.html">git-init(1)</a> to create a new repository. | |
</p> | |
</li> | |
<li> | |
<p> | |
<a href="git-log.html">git-log(1)</a> to see what happened. | |
</p> | |
</li> | |
<li> | |
<p> | |
<a href="git-checkout.html">git-checkout(1)</a> and <a href="git-branch.html">git-branch(1)</a> to switch | |
branches. | |
</p> | |
</li> | |
<li> | |
<p> | |
<a href="git-add.html">git-add(1)</a> to manage the index file. | |
</p> | |
</li> | |
<li> | |
<p> | |
<a href="git-diff.html">git-diff(1)</a> and <a href="git-status.html">git-status(1)</a> to see what | |
you are in the middle of doing. | |
</p> | |
</li> | |
<li> | |
<p> | |
<a href="git-commit.html">git-commit(1)</a> to advance the current branch. | |
</p> | |
</li> | |
<li> | |
<p> | |
<a href="git-reset.html">git-reset(1)</a> and <a href="git-checkout.html">git-checkout(1)</a> (with | |
pathname parameters) to undo changes. | |
</p> | |
</li> | |
<li> | |
<p> | |
<a href="git-merge.html">git-merge(1)</a> to merge between local branches. | |
</p> | |
</li> | |
<li> | |
<p> | |
<a href="git-rebase.html">git-rebase(1)</a> to maintain topic branches. | |
</p> | |
</li> | |
<li> | |
<p> | |
<a href="git-tag.html">git-tag(1)</a> to mark a known point. | |
</p> | |
</li> | |
</ul></div> | |
<div class="sect2"> | |
<h3 id="_examples">Examples</h3> | |
<div class="dlist"><dl> | |
<dt class="hdlist1"> | |
Use a tarball as a starting point for a new repository. | |
</dt> | |
<dd> | |
<div class="listingblock"> | |
<div class="content"> | |
<pre><code>$ tar zxf frotz.tar.gz | |
$ cd frotz | |
$ git init | |
$ git add . <b><1></b> | |
$ git commit -m "import of frotz source tree." | |
$ git tag v2.43 <b><2></b></code></pre> | |
</div></div> | |
<div class="colist arabic"><ol> | |
<li> | |
<p> | |
add everything under the current directory. | |
</p> | |
</li> | |
<li> | |
<p> | |
make a lightweight, unannotated tag. | |
</p> | |
</li> | |
</ol></div> | |
</dd> | |
<dt class="hdlist1"> | |
Create a topic branch and develop. | |
</dt> | |
<dd> | |
<div class="listingblock"> | |
<div class="content"> | |
<pre><code>$ git checkout -b alsa-audio <b><1></b> | |
$ edit/compile/test | |
$ git checkout -- curses/ux_audio_oss.c <b><2></b> | |
$ git add curses/ux_audio_alsa.c <b><3></b> | |
$ edit/compile/test | |
$ git diff HEAD <b><4></b> | |
$ git commit -a -s <b><5></b> | |
$ edit/compile/test | |
$ git diff HEAD^ <b><6></b> | |
$ git commit -a --amend <b><7></b> | |
$ git checkout master <b><8></b> | |
$ git merge alsa-audio <b><9></b> | |
$ git log --since='3 days ago' <b><10></b> | |
$ git log v2.43.. curses/ <b><11></b></code></pre> | |
</div></div> | |
<div class="colist arabic"><ol> | |
<li> | |
<p> | |
create a new topic branch. | |
</p> | |
</li> | |
<li> | |
<p> | |
revert your botched changes in <code>curses/ux_audio_oss.c</code>. | |
</p> | |
</li> | |
<li> | |
<p> | |
you need to tell Git if you added a new file; removal and | |
modification will be caught if you do <code>git commit -a</code> later. | |
</p> | |
</li> | |
<li> | |
<p> | |
to see what changes you are committing. | |
</p> | |
</li> | |
<li> | |
<p> | |
commit everything, as you have tested, with your sign-off. | |
</p> | |
</li> | |
<li> | |
<p> | |
look at all your changes including the previous commit. | |
</p> | |
</li> | |
<li> | |
<p> | |
amend the previous commit, adding all your new changes, | |
using your original message. | |
</p> | |
</li> | |
<li> | |
<p> | |
switch to the master branch. | |
</p> | |
</li> | |
<li> | |
<p> | |
merge a topic branch into your master branch. | |
</p> | |
</li> | |
<li> | |
<p> | |
review commit logs; other forms to limit output can be | |
combined and include <code>-10</code> (to show up to 10 commits), | |
<code>--until=2005-12-10</code>, etc. | |
</p> | |
</li> | |
<li> | |
<p> | |
view only the changes that touch what’s in <code>curses/</code> | |
directory, since <code>v2.43</code> tag. | |
</p> | |
</li> | |
</ol></div> | |
</dd> | |
</dl></div> | |
</div> | |
</div> | |
</div> | |
<div class="sect1"> | |
<h2 id="_individual_developer_participant_a_id_participant_a">Individual Developer (Participant)<a id="PARTICIPANT"></a></h2> | |
<div class="sectionbody"> | |
<div class="paragraph"><p>A developer working as a participant in a group project needs to | |
learn how to communicate with others, and uses these commands in | |
addition to the ones needed by a standalone developer.</p></div> | |
<div class="ulist"><ul> | |
<li> | |
<p> | |
<a href="git-clone.html">git-clone(1)</a> from the upstream to prime your local | |
repository. | |
</p> | |
</li> | |
<li> | |
<p> | |
<a href="git-pull.html">git-pull(1)</a> and <a href="git-fetch.html">git-fetch(1)</a> from "origin" | |
to keep up-to-date with the upstream. | |
</p> | |
</li> | |
<li> | |
<p> | |
<a href="git-push.html">git-push(1)</a> to shared repository, if you adopt CVS | |
style shared repository workflow. | |
</p> | |
</li> | |
<li> | |
<p> | |
<a href="git-format-patch.html">git-format-patch(1)</a> to prepare e-mail submission, if | |
you adopt Linux kernel-style public forum workflow. | |
</p> | |
</li> | |
<li> | |
<p> | |
<a href="git-send-email.html">git-send-email(1)</a> to send your e-mail submission without | |
corruption by your MUA. | |
</p> | |
</li> | |
<li> | |
<p> | |
<a href="git-request-pull.html">git-request-pull(1)</a> to create a summary of changes | |
for your upstream to pull. | |
</p> | |
</li> | |
</ul></div> | |
<div class="sect2"> | |
<h3 id="_examples_2">Examples</h3> | |
<div class="dlist"><dl> | |
<dt class="hdlist1"> | |
Clone the upstream and work on it. Feed changes to upstream. | |
</dt> | |
<dd> | |
<div class="listingblock"> | |
<div class="content"> | |
<pre><code>$ git clone git://git.kernel.org/pub/scm/.../torvalds/linux-2.6 my2.6 | |
$ cd my2.6 | |
$ git checkout -b mine master <b><1></b> | |
$ edit/compile/test; git commit -a -s <b><2></b> | |
$ git format-patch master <b><3></b> | |
$ git send-email --to="person <[email protected]>" 00*.patch <b><4></b> | |
$ git checkout master <b><5></b> | |
$ git pull <b><6></b> | |
$ git log -p ORIG_HEAD.. arch/i386 include/asm-i386 <b><7></b> | |
$ git ls-remote --heads http://git.kernel.org/.../jgarzik/libata-dev.git <b><8></b> | |
$ git pull git://git.kernel.org/pub/.../jgarzik/libata-dev.git ALL <b><9></b> | |
$ git reset --hard ORIG_HEAD <b><10></b> | |
$ git gc <b><11></b></code></pre> | |
</div></div> | |
<div class="colist arabic"><ol> | |
<li> | |
<p> | |
checkout a new branch <code>mine</code> from master. | |
</p> | |
</li> | |
<li> | |
<p> | |
repeat as needed. | |
</p> | |
</li> | |
<li> | |
<p> | |
extract patches from your branch, relative to master, | |
</p> | |
</li> | |
<li> | |
<p> | |
and email them. | |
</p> | |
</li> | |
<li> | |
<p> | |
return to <code>master</code>, ready to see what’s new | |
</p> | |
</li> | |
<li> | |
<p> | |
<code>git pull</code> fetches from <code>origin</code> by default and merges into the | |
current branch. | |
</p> | |
</li> | |
<li> | |
<p> | |
immediately after pulling, look at the changes done upstream | |
since last time we checked, only in the | |
area we are interested in. | |
</p> | |
</li> | |
<li> | |
<p> | |
check the branch names in an external repository (if not known). | |
</p> | |
</li> | |
<li> | |
<p> | |
fetch from a specific branch <code>ALL</code> from a specific repository | |
and merge it. | |
</p> | |
</li> | |
<li> | |
<p> | |
revert the pull. | |
</p> | |
</li> | |
<li> | |
<p> | |
garbage collect leftover objects from reverted pull. | |
</p> | |
</li> | |
</ol></div> | |
</dd> | |
<dt class="hdlist1"> | |
Push into another repository. | |
</dt> | |
<dd> | |
<div class="listingblock"> | |
<div class="content"> | |
<pre><code>satellite$ git clone mothership:frotz frotz <b><1></b> | |
satellite$ cd frotz | |
satellite$ git config --get-regexp '^(remote|branch)\.' <b><2></b> | |
remote.origin.url mothership:frotz | |
remote.origin.fetch refs/heads/*:refs/remotes/origin/* | |
branch.master.remote origin | |
branch.master.merge refs/heads/master | |
satellite$ git config remote.origin.push \ | |
+refs/heads/*:refs/remotes/satellite/* <b><3></b> | |
satellite$ edit/compile/test/commit | |
satellite$ git push origin <b><4></b> | |
mothership$ cd frotz | |
mothership$ git checkout master | |
mothership$ git merge satellite/master <b><5></b></code></pre> | |
</div></div> | |
<div class="colist arabic"><ol> | |
<li> | |
<p> | |
mothership machine has a frotz repository under your home | |
directory; clone from it to start a repository on the satellite | |
machine. | |
</p> | |
</li> | |
<li> | |
<p> | |
clone sets these configuration variables by default. | |
It arranges <code>git pull</code> to fetch and store the branches of mothership | |
machine to local <code>remotes/origin/*</code> remote-tracking branches. | |
</p> | |
</li> | |
<li> | |
<p> | |
arrange <code>git push</code> to push all local branches to | |
their corresponding branch of the mothership machine. | |
</p> | |
</li> | |
<li> | |
<p> | |
push will stash all our work away on <code>remotes/satellite/*</code> | |
remote-tracking branches on the mothership machine. You could use this | |
as a back-up method. Likewise, you can pretend that mothership | |
"fetched" from you (useful when access is one sided). | |
</p> | |
</li> | |
<li> | |
<p> | |
on mothership machine, merge the work done on the satellite | |
machine into the master branch. | |
</p> | |
</li> | |
</ol></div> | |
</dd> | |
<dt class="hdlist1"> | |
Branch off of a specific tag. | |
</dt> | |
<dd> | |
<div class="listingblock"> | |
<div class="content"> | |
<pre><code>$ git checkout -b private2.6.14 v2.6.14 <b><1></b> | |
$ edit/compile/test; git commit -a | |
$ git checkout master | |
$ git cherry-pick v2.6.14..private2.6.14 <b><2></b></code></pre> | |
</div></div> | |
<div class="colist arabic"><ol> | |
<li> | |
<p> | |
create a private branch based on a well known (but somewhat behind) | |
tag. | |
</p> | |
</li> | |
<li> | |
<p> | |
forward port all changes in <code>private2.6.14</code> branch to <code>master</code> branch | |
without a formal "merging". Or longhand<br /> | |
<code>git format-patch -k -m --stdout v2.6.14..private2.6.14 | | |
git am -3 -k</code> | |
</p> | |
</li> | |
</ol></div> | |
</dd> | |
</dl></div> | |
<div class="paragraph"><p>An alternate participant submission mechanism is using the | |
<code>git request-pull</code> or pull-request mechanisms (e.g as used on | |
GitHub (www.github.com) to notify your upstream of your | |
contribution.</p></div> | |
</div> | |
</div> | |
</div> | |
<div class="sect1"> | |
<h2 id="_integrator_a_id_integrator_a">Integrator<a id="INTEGRATOR"></a></h2> | |
<div class="sectionbody"> | |
<div class="paragraph"><p>A fairly central person acting as the integrator in a group | |
project receives changes made by others, reviews and integrates | |
them and publishes the result for others to use, using these | |
commands in addition to the ones needed by participants.</p></div> | |
<div class="paragraph"><p>This section can also be used by those who respond to <code>git | |
request-pull</code> or pull-request on GitHub (www.github.com) to | |
integrate the work of others into their history. An sub-area | |
lieutenant for a repository will act both as a participant and | |
as an integrator.</p></div> | |
<div class="ulist"><ul> | |
<li> | |
<p> | |
<a href="git-am.html">git-am(1)</a> to apply patches e-mailed in from your | |
contributors. | |
</p> | |
</li> | |
<li> | |
<p> | |
<a href="git-pull.html">git-pull(1)</a> to merge from your trusted lieutenants. | |
</p> | |
</li> | |
<li> | |
<p> | |
<a href="git-format-patch.html">git-format-patch(1)</a> to prepare and send suggested | |
alternative to contributors. | |
</p> | |
</li> | |
<li> | |
<p> | |
<a href="git-revert.html">git-revert(1)</a> to undo botched commits. | |
</p> | |
</li> | |
<li> | |
<p> | |
<a href="git-push.html">git-push(1)</a> to publish the bleeding edge. | |
</p> | |
</li> | |
</ul></div> | |
<div class="sect2"> | |
<h3 id="_examples_3">Examples</h3> | |
<div class="dlist"><dl> | |
<dt class="hdlist1"> | |
A typical integrator’s Git day. | |
</dt> | |
<dd> | |
<div class="listingblock"> | |
<div class="content"> | |
<pre><code>$ git status <b><1></b> | |
$ git branch --no-merged master <b><2></b> | |
$ mailx <b><3></b> | |
& s 2 3 4 5 ./+to-apply | |
& s 7 8 ./+hold-linus | |
& q | |
$ git checkout -b topic/one master | |
$ git am -3 -i -s ./+to-apply <b><4></b> | |
$ compile/test | |
$ git checkout -b hold/linus && git am -3 -i -s ./+hold-linus <b><5></b> | |
$ git checkout topic/one && git rebase master <b><6></b> | |
$ git checkout pu && git reset --hard next <b><7></b> | |
$ git merge topic/one topic/two && git merge hold/linus <b><8></b> | |
$ git checkout maint | |
$ git cherry-pick master~4 <b><9></b> | |
$ compile/test | |
$ git tag -s -m "GIT 0.99.9x" v0.99.9x <b><10></b> | |
$ git fetch ko && for branch in master maint next pu <b><11></b> | |
do | |
git show-branch ko/$branch $branch <b><12></b> | |
done | |
$ git push --follow-tags ko <b><13></b></code></pre> | |
</div></div> | |
<div class="colist arabic"><ol> | |
<li> | |
<p> | |
see what you were in the middle of doing, if anything. | |
</p> | |
</li> | |
<li> | |
<p> | |
see which branches haven’t been merged into <code>master</code> yet. | |
Likewise for any other integration branches e.g. <code>maint</code>, <code>next</code> | |
and <code>pu</code> (potential updates). | |
</p> | |
</li> | |
<li> | |
<p> | |
read mails, save ones that are applicable, and save others | |
that are not quite ready (other mail readers are available). | |
</p> | |
</li> | |
<li> | |
<p> | |
apply them, interactively, with your sign-offs. | |
</p> | |
</li> | |
<li> | |
<p> | |
create topic branch as needed and apply, again with sign-offs. | |
</p> | |
</li> | |
<li> | |
<p> | |
rebase internal topic branch that has not been merged to the | |
master or exposed as a part of a stable branch. | |
</p> | |
</li> | |
<li> | |
<p> | |
restart <code>pu</code> every time from the next. | |
</p> | |
</li> | |
<li> | |
<p> | |
and bundle topic branches still cooking. | |
</p> | |
</li> | |
<li> | |
<p> | |
backport a critical fix. | |
</p> | |
</li> | |
<li> | |
<p> | |
create a signed tag. | |
</p> | |
</li> | |
<li> | |
<p> | |
make sure master was not accidentally rewound beyond that | |
already pushed out. <code>ko</code> shorthand points at the Git maintainer’s | |
repository at kernel.org, and looks like this: | |
</p> | |
<div class="listingblock"> | |
<div class="content"> | |
<pre><code>(in .git/config) | |
[remote "ko"] | |
url = kernel.org:/pub/scm/git/git.git | |
fetch = refs/heads/*:refs/remotes/ko/* | |
push = refs/heads/master | |
push = refs/heads/next | |
push = +refs/heads/pu | |
push = refs/heads/maint</code></pre> | |
</div></div> | |
</li> | |
<li> | |
<p> | |
In the output from <code>git show-branch</code>, <code>master</code> should have | |
everything <code>ko/master</code> has, and <code>next</code> should have | |
everything <code>ko/next</code> has, etc. | |
</p> | |
</li> | |
<li> | |
<p> | |
push out the bleeding edge, together with new tags that point | |
into the pushed history. | |
</p> | |
</li> | |
</ol></div> | |
</dd> | |
</dl></div> | |
</div> | |
</div> | |
</div> | |
<div class="sect1"> | |
<h2 id="_repository_administration_a_id_administration_a">Repository Administration<a id="ADMINISTRATION"></a></h2> | |
<div class="sectionbody"> | |
<div class="paragraph"><p>A repository administrator uses the following tools to set up | |
and maintain access to the repository by developers.</p></div> | |
<div class="ulist"><ul> | |
<li> | |
<p> | |
<a href="git-daemon.html">git-daemon(1)</a> to allow anonymous download from | |
repository. | |
</p> | |
</li> | |
<li> | |
<p> | |
<a href="git-shell.html">git-shell(1)</a> can be used as a <em>restricted login shell</em> | |
for shared central repository users. | |
</p> | |
</li> | |
<li> | |
<p> | |
<a href="git-http-backend.html">git-http-backend(1)</a> provides a server side implementation | |
of Git-over-HTTP ("Smart http") allowing both fetch and push services. | |
</p> | |
</li> | |
<li> | |
<p> | |
<a href="gitweb.html">gitweb(1)</a> provides a web front-end to Git repositories, | |
which can be set-up using the <a href="git-instaweb.html">git-instaweb(1)</a> script. | |
</p> | |
</li> | |
</ul></div> | |
<div class="paragraph"><p><a href="howto/update-hook-example.html">update hook howto</a> has a good | |
example of managing a shared central repository.</p></div> | |
<div class="paragraph"><p>In addition there are a number of other widely deployed hosting, browsing | |
and reviewing solutions such as:</p></div> | |
<div class="ulist"><ul> | |
<li> | |
<p> | |
gitolite, gerrit code review, cgit and others. | |
</p> | |
</li> | |
</ul></div> | |
<div class="sect2"> | |
<h3 id="_examples_4">Examples</h3> | |
<div class="dlist"><dl> | |
<dt class="hdlist1"> | |
We assume the following in /etc/services | |
</dt> | |
<dd> | |
<div class="listingblock"> | |
<div class="content"> | |
<pre><code>$ grep 9418 /etc/services | |
git 9418/tcp # Git Version Control System</code></pre> | |
</div></div> | |
</dd> | |
<dt class="hdlist1"> | |
Run git-daemon to serve /pub/scm from inetd. | |
</dt> | |
<dd> | |
<div class="listingblock"> | |
<div class="content"> | |
<pre><code>$ grep git /etc/inetd.conf | |
git stream tcp nowait nobody \ | |
/usr/bin/git-daemon git-daemon --inetd --export-all /pub/scm</code></pre> | |
</div></div> | |
<div class="paragraph"><p>The actual configuration line should be on one line.</p></div> | |
</dd> | |
<dt class="hdlist1"> | |
Run git-daemon to serve /pub/scm from xinetd. | |
</dt> | |
<dd> | |
<div class="listingblock"> | |
<div class="content"> | |
<pre><code>$ cat /etc/xinetd.d/git-daemon | |
# default: off | |
# description: The Git server offers access to Git repositories | |
service git | |
{ | |
disable = no | |
type = UNLISTED | |
port = 9418 | |
socket_type = stream | |
wait = no | |
user = nobody | |
server = /usr/bin/git-daemon | |
server_args = --inetd --export-all --base-path=/pub/scm | |
log_on_failure += USERID | |
}</code></pre> | |
</div></div> | |
<div class="paragraph"><p>Check your xinetd(8) documentation and setup, this is from a Fedora system. | |
Others might be different.</p></div> | |
</dd> | |
<dt class="hdlist1"> | |
Give push/pull only access to developers using git-over-ssh. | |
</dt> | |
<dd> | |
<p> | |
e.g. those using: | |
<code>$ git push/pull ssh://host.xz/pub/scm/project</code> | |
</p> | |
<div class="listingblock"> | |
<div class="content"> | |
<pre><code>$ grep git /etc/passwd <b><1></b> | |
alice:x:1000:1000::/home/alice:/usr/bin/git-shell | |
bob:x:1001:1001::/home/bob:/usr/bin/git-shell | |
cindy:x:1002:1002::/home/cindy:/usr/bin/git-shell | |
david:x:1003:1003::/home/david:/usr/bin/git-shell | |
$ grep git /etc/shells <b><2></b> | |
/usr/bin/git-shell</code></pre> | |
</div></div> | |
<div class="colist arabic"><ol> | |
<li> | |
<p> | |
log-in shell is set to /usr/bin/git-shell, which does not | |
allow anything but <code>git push</code> and <code>git pull</code>. The users require | |
ssh access to the machine. | |
</p> | |
</li> | |
<li> | |
<p> | |
in many distributions /etc/shells needs to list what is used | |
as the login shell. | |
</p> | |
</li> | |
</ol></div> | |
</dd> | |
<dt class="hdlist1"> | |
CVS-style shared repository. | |
</dt> | |
<dd> | |
<div class="listingblock"> | |
<div class="content"> | |
<pre><code>$ grep git /etc/group <b><1></b> | |
git:x:9418:alice,bob,cindy,david | |
$ cd /home/devo.git | |
$ ls -l <b><2></b> | |
lrwxrwxrwx 1 david git 17 Dec 4 22:40 HEAD -> refs/heads/master | |
drwxrwsr-x 2 david git 4096 Dec 4 22:40 branches | |
-rw-rw-r-- 1 david git 84 Dec 4 22:40 config | |
-rw-rw-r-- 1 david git 58 Dec 4 22:40 description | |
drwxrwsr-x 2 david git 4096 Dec 4 22:40 hooks | |
-rw-rw-r-- 1 david git 37504 Dec 4 22:40 index | |
drwxrwsr-x 2 david git 4096 Dec 4 22:40 info | |
drwxrwsr-x 4 david git 4096 Dec 4 22:40 objects | |
drwxrwsr-x 4 david git 4096 Nov 7 14:58 refs | |
drwxrwsr-x 2 david git 4096 Dec 4 22:40 remotes | |
$ ls -l hooks/update <b><3></b> | |
-r-xr-xr-x 1 david git 3536 Dec 4 22:40 update | |
$ cat info/allowed-users <b><4></b> | |
refs/heads/master alice\|cindy | |
refs/heads/doc-update bob | |
refs/tags/v[0-9]* david</code></pre> | |
</div></div> | |
<div class="colist arabic"><ol> | |
<li> | |
<p> | |
place the developers into the same git group. | |
</p> | |
</li> | |
<li> | |
<p> | |
and make the shared repository writable by the group. | |
</p> | |
</li> | |
<li> | |
<p> | |
use update-hook example by Carl from Documentation/howto/ | |
for branch policy control. | |
</p> | |
</li> | |
<li> | |
<p> | |
alice and cindy can push into master, only bob can push into doc-update. | |
david is the release manager and is the only person who can | |
create and push version tags. | |
</p> | |
</li> | |
</ol></div> | |
</dd> | |
</dl></div> | |
</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 2014-11-26 10:51:09 PST | |
</div> | |
</div> | |
</body> | |
</html> | |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
GITEVERYDAY(7) Git Manual GITEVERYDAY(7) | |
NNAAMMEE | |
giteveryday - A useful minimum set of commands for Everyday Git | |
SSYYNNOOPPSSIISS | |
Everyday Git With 20 Commands Or So | |
DDEESSCCRRIIPPTTIIOONN | |
Git users can broadly be grouped into four categories for the purposes | |
of describing here a small set of useful command for everyday Git. | |
+o Individual Developer (Standalone) commands are essential for | |
anybody who makes a commit, even for somebody who works alone. | |
+o If you work with other people, you will need commands listed in the | |
Individual Developer (Participant) section as well. | |
+o People who play the Integrator role need to learn some more | |
commands in addition to the above. | |
+o Repository Administration commands are for system administrators | |
who are responsible for the care and feeding of Git repositories. | |
IINNDDIIVVIIDDUUAALL DDEEVVEELLOOPPEERR ((SSTTAANNDDAALLOONNEE)) | |
A standalone individual developer does not exchange patches with other | |
people, and works alone in a single repository, using the following | |
commands. | |
+o ggiitt--iinniitt(1) to create a new repository. | |
+o ggiitt--lloogg(1) to see what happened. | |
+o ggiitt--cchheecckkoouutt(1) and ggiitt--bbrraanncchh(1) to switch branches. | |
+o ggiitt--aadddd(1) to manage the index file. | |
+o ggiitt--ddiiffff(1) and ggiitt--ssttaattuuss(1) to see what you are in the middle of | |
doing. | |
+o ggiitt--ccoommmmiitt(1) to advance the current branch. | |
+o ggiitt--rreesseett(1) and ggiitt--cchheecckkoouutt(1) (with pathname parameters) to undo | |
changes. | |
+o ggiitt--mmeerrggee(1) to merge between local branches. | |
+o ggiitt--rreebbaassee(1) to maintain topic branches. | |
+o ggiitt--ttaagg(1) to mark a known point. | |
EExxaammpplleess | |
Use a tarball as a starting point for a new repository. | |
$ tar zxf frotz.tar.gz | |
$ cd frotz | |
$ git init | |
$ git add . ((11)) | |
$ git commit -m "import of frotz source tree." | |
$ git tag v2.43 ((22)) | |
11.. add everything under the current directory. | |
22.. make a lightweight, unannotated tag. | |
Create a topic branch and develop. | |
$ git checkout -b alsa-audio ((11)) | |
$ edit/compile/test | |
$ git checkout -- curses/ux_audio_oss.c ((22)) | |
$ git add curses/ux_audio_alsa.c ((33)) | |
$ edit/compile/test | |
$ git diff HEAD ((44)) | |
$ git commit -a -s ((55)) | |
$ edit/compile/test | |
$ git diff HEAD^ ((66)) | |
$ git commit -a --amend ((77)) | |
$ git checkout master ((88)) | |
$ git merge alsa-audio ((99)) | |
$ git log --since='3 days ago' ((1100)) | |
$ git log v2.43.. curses/ ((1111)) | |
11.. create a new topic branch. | |
22.. revert your botched changes in curses/ux_audio_oss.c. | |
33.. you need to tell Git if you added a new file; removal and | |
modification will be caught if you do git commit -a later. | |
44.. to see what changes you are committing. | |
55.. commit everything, as you have tested, with your sign-off. | |
66.. look at all your changes including the previous commit. | |
77.. amend the previous commit, adding all your new changes, using | |
your original message. | |
88.. switch to the master branch. | |
99.. merge a topic branch into your master branch. | |
1100.. review commit logs; other forms to limit output can be combined | |
and include -10 (to show up to 10 commits), --until=2005-12-10, | |
etc. | |
1111.. view only the changes that touch what's in curses/ directory, | |
since v2.43 tag. | |
IINNDDIIVVIIDDUUAALL DDEEVVEELLOOPPEERR ((PPAARRTTIICCIIPPAANNTT)) | |
A developer working as a participant in a group project needs to learn | |
how to communicate with others, and uses these commands in addition to | |
the ones needed by a standalone developer. | |
+o ggiitt--cclloonnee(1) from the upstream to prime your local repository. | |
+o ggiitt--ppuullll(1) and ggiitt--ffeettcchh(1) from "origin" to keep up-to-date with | |
the upstream. | |
+o ggiitt--ppuusshh(1) to shared repository, if you adopt CVS style shared | |
repository workflow. | |
+o ggiitt--ffoorrmmaatt--ppaattcchh(1) to prepare e-mail submission, if you adopt | |
Linux kernel-style public forum workflow. | |
+o ggiitt--sseenndd--eemmaaiill(1) to send your e-mail submission without corruption | |
by your MUA. | |
+o ggiitt--rreeqquueesstt--ppuullll(1) to create a summary of changes for your | |
upstream to pull. | |
EExxaammpplleess | |
Clone the upstream and work on it. Feed changes to upstream. | |
$ git clone git://git.kernel.org/pub/scm/.../torvalds/linux-2.6 my2.6 | |
$ cd my2.6 | |
$ git checkout -b mine master ((11)) | |
$ edit/compile/test; git commit -a -s ((22)) | |
$ git format-patch master ((33)) | |
$ git send-email --to="person <[email protected]>" 00*.patch ((44)) | |
$ git checkout master ((55)) | |
$ git pull ((66)) | |
$ git log -p ORIG_HEAD.. arch/i386 include/asm-i386 ((77)) | |
$ git ls-remote --heads http://git.kernel.org/.../jgarzik/libata-dev.git ((88)) | |
$ git pull git://git.kernel.org/pub/.../jgarzik/libata-dev.git ALL ((99)) | |
$ git reset --hard ORIG_HEAD ((1100)) | |
$ git gc ((1111)) | |
11.. checkout a new branch mine from master. | |
22.. repeat as needed. | |
33.. extract patches from your branch, relative to master, | |
44.. and email them. | |
55.. return to master, ready to see what's new | |
66.. git pull fetches from origin by default and merges into the | |
current branch. | |
77.. immediately after pulling, look at the changes done upstream | |
since last time we checked, only in the area we are interested in. | |
88.. check the branch names in an external repository (if not known). | |
99.. fetch from a specific branch ALL from a specific repository and | |
merge it. | |
1100.. revert the pull. | |
1111.. garbage collect leftover objects from reverted pull. | |
Push into another repository. | |
satellite$ git clone mothership:frotz frotz ((11)) | |
satellite$ cd frotz | |
satellite$ git config --get-regexp '^(remote|branch)\.' ((22)) | |
remote.origin.url mothership:frotz | |
remote.origin.fetch refs/heads/*:refs/remotes/origin/* | |
branch.master.remote origin | |
branch.master.merge refs/heads/master | |
satellite$ git config remote.origin.push \ | |
+refs/heads/*:refs/remotes/satellite/* ((33)) | |
satellite$ edit/compile/test/commit | |
satellite$ git push origin ((44)) | |
mothership$ cd frotz | |
mothership$ git checkout master | |
mothership$ git merge satellite/master ((55)) | |
11.. mothership machine has a frotz repository under your home | |
directory; clone from it to start a repository on the satellite | |
machine. | |
22.. clone sets these configuration variables by default. It arranges | |
git pull to fetch and store the branches of mothership machine to | |
local remotes/origin/* remote-tracking branches. | |
33.. arrange git push to push all local branches to their | |
corresponding branch of the mothership machine. | |
44.. push will stash all our work away on remotes/satellite/* | |
remote-tracking branches on the mothership machine. You could use | |
this as a back-up method. Likewise, you can pretend that mothership | |
"fetched" from you (useful when access is one sided). | |
55.. on mothership machine, merge the work done on the satellite | |
machine into the master branch. | |
Branch off of a specific tag. | |
$ git checkout -b private2.6.14 v2.6.14 ((11)) | |
$ edit/compile/test; git commit -a | |
$ git checkout master | |
$ git cherry-pick v2.6.14..private2.6.14 ((22)) | |
11.. create a private branch based on a well known (but somewhat | |
behind) tag. | |
22.. forward port all changes in private2.6.14 branch to master | |
branch without a formal "merging". Or longhand git format-patch -k | |
-m --stdout v2.6.14..private2.6.14 | git am -3 -k | |
An alternate participant submission mechanism is using the git | |
request-pull or pull-request mechanisms (e.g as used on GitHub | |
(www.github.com) to notify your upstream of your contribution. | |
IINNTTEEGGRRAATTOORR | |
A fairly central person acting as the integrator in a group project | |
receives changes made by others, reviews and integrates them and | |
publishes the result for others to use, using these commands in | |
addition to the ones needed by participants. | |
This section can also be used by those who respond to git request-pull | |
or pull-request on GitHub (www.github.com) to integrate the work of | |
others into their history. An sub-area lieutenant for a repository will | |
act both as a participant and as an integrator. | |
+o ggiitt--aamm(1) to apply patches e-mailed in from your contributors. | |
+o ggiitt--ppuullll(1) to merge from your trusted lieutenants. | |
+o ggiitt--ffoorrmmaatt--ppaattcchh(1) to prepare and send suggested alternative to | |
contributors. | |
+o ggiitt--rreevveerrtt(1) to undo botched commits. | |
+o ggiitt--ppuusshh(1) to publish the bleeding edge. | |
EExxaammpplleess | |
A typical integrator's Git day. | |
$ git status ((11)) | |
$ git branch --no-merged master ((22)) | |
$ mailx ((33)) | |
& s 2 3 4 5 ./+to-apply | |
& s 7 8 ./+hold-linus | |
& q | |
$ git checkout -b topic/one master | |
$ git am -3 -i -s ./+to-apply ((44)) | |
$ compile/test | |
$ git checkout -b hold/linus && git am -3 -i -s ./+hold-linus ((55)) | |
$ git checkout topic/one && git rebase master ((66)) | |
$ git checkout pu && git reset --hard next ((77)) | |
$ git merge topic/one topic/two && git merge hold/linus ((88)) | |
$ git checkout maint | |
$ git cherry-pick master~4 ((99)) | |
$ compile/test | |
$ git tag -s -m "GIT 0.99.9x" v0.99.9x ((1100)) | |
$ git fetch ko && for branch in master maint next pu ((1111)) | |
do | |
git show-branch ko/$branch $branch ((1122)) | |
done | |
$ git push --follow-tags ko ((1133)) | |
11.. see what you were in the middle of doing, if anything. | |
22.. see which branches haven't been merged into master yet. Likewise | |
for any other integration branches e.g. maint, next and pu | |
(potential updates). | |
33.. read mails, save ones that are applicable, and save others that | |
are not quite ready (other mail readers are available). | |
44.. apply them, interactively, with your sign-offs. | |
55.. create topic branch as needed and apply, again with sign-offs. | |
66.. rebase internal topic branch that has not been merged to the | |
master or exposed as a part of a stable branch. | |
77.. restart pu every time from the next. | |
88.. and bundle topic branches still cooking. | |
99.. backport a critical fix. | |
1100.. create a signed tag. | |
1111.. make sure master was not accidentally rewound beyond that | |
already pushed out. ko shorthand points at the Git maintainer's | |
repository at kernel.org, and looks like this: | |
(in .git/config) | |
[remote "ko"] | |
url = kernel.org:/pub/scm/git/git.git | |
fetch = refs/heads/*:refs/remotes/ko/* | |
push = refs/heads/master | |
push = refs/heads/next | |
push = +refs/heads/pu | |
push = refs/heads/maint | |
1122.. In the output from git show-branch, master should have | |
everything ko/master has, and next should have everything ko/next | |
has, etc. | |
1133.. push out the bleeding edge, together with new tags that point | |
into the pushed history. | |
RREEPPOOSSIITTOORRYY AADDMMIINNIISSTTRRAATTIIOONN | |
A repository administrator uses the following tools to set up and | |
maintain access to the repository by developers. | |
+o ggiitt--ddaaeemmoonn(1) to allow anonymous download from repository. | |
+o ggiitt--sshheellll(1) can be used as a _r_e_s_t_r_i_c_t_e_d _l_o_g_i_n _s_h_e_l_l for shared | |
central repository users. | |
+o ggiitt--hhttttpp--bbaacckkeenndd(1) provides a server side implementation of | |
Git-over-HTTP ("Smart http") allowing both fetch and push services. | |
+o ggiittwweebb(1) provides a web front-end to Git repositories, which can | |
be set-up using the ggiitt--iinnssttaawweebb(1) script. | |
uuppddaattee hhooookk hhoowwttoo[1] has a good example of managing a shared central | |
repository. | |
In addition there are a number of other widely deployed hosting, | |
browsing and reviewing solutions such as: | |
+o gitolite, gerrit code review, cgit and others. | |
EExxaammpplleess | |
We assume the following in /etc/services | |
$ grep 9418 /etc/services | |
git 9418/tcp # Git Version Control System | |
Run git-daemon to serve /pub/scm from inetd. | |
$ grep git /etc/inetd.conf | |
git stream tcp nowait nobody \ | |
/usr/bin/git-daemon git-daemon --inetd --export-all /pub/scm | |
The actual configuration line should be on one line. | |
Run git-daemon to serve /pub/scm from xinetd. | |
$ cat /etc/xinetd.d/git-daemon | |
# default: off | |
# description: The Git server offers access to Git repositories | |
service git | |
{ | |
disable = no | |
type = UNLISTED | |
port = 9418 | |
socket_type = stream | |
wait = no | |
user = nobody | |
server = /usr/bin/git-daemon | |
server_args = --inetd --export-all --base-path=/pub/scm | |
log_on_failure += USERID | |
} | |
Check your xinetd(8) documentation and setup, this is from a Fedora | |
system. Others might be different. | |
Give push/pull only access to developers using git-over-ssh. | |
e.g. those using: $ git push/pull ssh://host.xz/pub/scm/project | |
$ grep git /etc/passwd ((11)) | |
alice:x:1000:1000::/home/alice:/usr/bin/git-shell | |
bob:x:1001:1001::/home/bob:/usr/bin/git-shell | |
cindy:x:1002:1002::/home/cindy:/usr/bin/git-shell | |
david:x:1003:1003::/home/david:/usr/bin/git-shell | |
$ grep git /etc/shells ((22)) | |
/usr/bin/git-shell | |
11.. log-in shell is set to /usr/bin/git-shell, which does not allow | |
anything but git push and git pull. The users require ssh access to | |
the machine. | |
22.. in many distributions /etc/shells needs to list what is used as | |
the login shell. | |
CVS-style shared repository. | |
$ grep git /etc/group ((11)) | |
git:x:9418:alice,bob,cindy,david | |
$ cd /home/devo.git | |
$ ls -l ((22)) | |
lrwxrwxrwx 1 david git 17 Dec 4 22:40 HEAD -> refs/heads/master | |
drwxrwsr-x 2 david git 4096 Dec 4 22:40 branches | |
-rw-rw-r-- 1 david git 84 Dec 4 22:40 config | |
-rw-rw-r-- 1 david git 58 Dec 4 22:40 description | |
drwxrwsr-x 2 david git 4096 Dec 4 22:40 hooks | |
-rw-rw-r-- 1 david git 37504 Dec 4 22:40 index | |
drwxrwsr-x 2 david git 4096 Dec 4 22:40 info | |
drwxrwsr-x 4 david git 4096 Dec 4 22:40 objects | |
drwxrwsr-x 4 david git 4096 Nov 7 14:58 refs | |
drwxrwsr-x 2 david git 4096 Dec 4 22:40 remotes | |
$ ls -l hooks/update ((33)) | |
-r-xr-xr-x 1 david git 3536 Dec 4 22:40 update | |
$ cat info/allowed-users ((44)) | |
refs/heads/master alice\|cindy | |
refs/heads/doc-update bob | |
refs/tags/v[0-9]* david | |
11.. place the developers into the same git group. | |
22.. and make the shared repository writable by the group. | |
33.. use update-hook example by Carl from Documentation/howto/ for | |
branch policy control. | |
44.. alice and cindy can push into master, only bob can push into | |
doc-update. david is the release manager and is the only person who | |
can create and push version tags. | |
GGIITT | |
Part of the ggiitt(1) suite | |
NNOOTTEESS | |
1. update hook howto | |
git-htmldocs/howto/update-hook-example.html | |
Git 11/26/2014 GITEVERYDAY(7) |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment