1079 lines
31 KiB
HTML
1079 lines
31 KiB
HTML
<?xml version="1.0" encoding="UTF-8"?>
|
|
<!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 10.2.0" />
|
|
<title>gitcli(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 overridden 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>
|
|
gitcli(7) Manual Page
|
|
</h1>
|
|
<h2>NAME</h2>
|
|
<div class="sectionbody">
|
|
<p>gitcli -
|
|
Git command-line interface and conventions
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="content">
|
|
<div class="sect1">
|
|
<h2 id="_synopsis">SYNOPSIS</h2>
|
|
<div class="sectionbody">
|
|
<div class="paragraph"><p>gitcli</p></div>
|
|
</div>
|
|
</div>
|
|
<div class="sect1">
|
|
<h2 id="_description">DESCRIPTION</h2>
|
|
<div class="sectionbody">
|
|
<div class="paragraph"><p>This manual describes the convention used throughout Git CLI.</p></div>
|
|
<div class="paragraph"><p>Many commands take revisions (most often "commits", but sometimes
|
|
"tree-ish", depending on the context and command) and paths as their
|
|
arguments. Here are the rules:</p></div>
|
|
<div class="ulist"><ul>
|
|
<li>
|
|
<p>
|
|
Options come first and then args.
|
|
A subcommand may take dashed options (which may take their own
|
|
arguments, e.g. "--max-parents 2") and arguments. You SHOULD
|
|
give dashed options first and then arguments. Some commands may
|
|
accept dashed options after you have already given non-option
|
|
arguments (which may make the command ambiguous), but you should
|
|
not rely on it (because eventually we may find a way to fix
|
|
these ambiguities by enforcing the "options then args" rule).
|
|
</p>
|
|
</li>
|
|
<li>
|
|
<p>
|
|
Revisions come first and then paths.
|
|
E.g. in <code>git</code> <code>diff</code> <code>v1.0</code> <code>v2.0</code> <code>arch/x86</code> <code>include/asm-x86</code>,
|
|
<code>v1.0</code> and <code>v2.0</code> are revisions and <code>arch/x86</code> and <code>include/asm-x86</code>
|
|
are paths.
|
|
</p>
|
|
</li>
|
|
<li>
|
|
<p>
|
|
When an argument can be misunderstood as either a revision or a path,
|
|
they can be disambiguated by placing <code>--</code> between them.
|
|
E.g. <code>git</code> <code>diff</code> <code>--</code> <code>HEAD</code> is, "I have a file called HEAD in my work
|
|
tree. Please show changes between the version I staged in the index
|
|
and what I have in the work tree for that file", not "show the difference
|
|
between the HEAD commit and the work tree as a whole". You can say
|
|
<code>git</code> <code>diff</code> <code>HEAD</code> <code>--</code> to ask for the latter.
|
|
</p>
|
|
</li>
|
|
<li>
|
|
<p>
|
|
Without disambiguating <code>--</code>, Git makes a reasonable guess, but errors
|
|
out and asks you to disambiguate when ambiguous. E.g. if you have a
|
|
file called HEAD in your work tree, <code>git</code> <code>diff</code> <code>HEAD</code> is ambiguous, and
|
|
you have to say either <code>git</code> <code>diff</code> <code>HEAD</code> <code>--</code> or <code>git</code> <code>diff</code> <code>--</code> <code>HEAD</code> to
|
|
disambiguate.
|
|
</p>
|
|
</li>
|
|
<li>
|
|
<p>
|
|
Because <code>--</code> disambiguates revisions and paths in some commands, it
|
|
cannot be used for those commands to separate options and revisions.
|
|
You can use <code>--end-of-options</code> for this (it also works for commands
|
|
that do not distinguish between revisions in paths, in which case it
|
|
is simply an alias for <code>--</code>).
|
|
</p>
|
|
<div class="paragraph"><p>When writing a script that is expected to handle random user-input, it is
|
|
a good practice to make it explicit which arguments are which by placing
|
|
disambiguating <code>--</code> at appropriate places.</p></div>
|
|
</li>
|
|
<li>
|
|
<p>
|
|
Many commands allow wildcards in paths, but you need to protect
|
|
them from getting globbed by the shell. These two mean different
|
|
things:
|
|
</p>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre><code>$ git restore *.c
|
|
$ git restore \*.c</code></pre>
|
|
</div></div>
|
|
<div class="paragraph"><p>The former lets your shell expand the fileglob, and you are asking
|
|
the dot-C files in your working tree to be overwritten with the version
|
|
in the index. The latter passes the <code>*.c</code> to Git, and you are asking
|
|
the paths in the index that match the pattern to be checked out to your
|
|
working tree. After running <code>git</code> <code>add</code> <code>hello.c</code>; <code>rm</code> <code>hello.c</code>, you will <em>not</em>
|
|
see <code>hello.c</code> in your working tree with the former, but with the latter
|
|
you will.</p></div>
|
|
</li>
|
|
<li>
|
|
<p>
|
|
Just as the filesystem <em>.</em> (period) refers to the current directory,
|
|
using a <em>.</em> as a repository name in Git (a dot-repository) is a relative
|
|
path and means your current repository.
|
|
</p>
|
|
</li>
|
|
</ul></div>
|
|
<div class="paragraph"><p>Here are the rules regarding the "flags" that you should follow when you are
|
|
scripting Git:</p></div>
|
|
<div class="ulist"><ul>
|
|
<li>
|
|
<p>
|
|
Splitting short options to separate words (prefer <code>git</code> <code>foo</code> <code>-a</code> <code>-b</code>
|
|
to <code>git</code> <code>foo</code> <code>-ab</code>, the latter may not even work).
|
|
</p>
|
|
</li>
|
|
<li>
|
|
<p>
|
|
When a command-line option takes an argument, use the <em>stuck</em> form. In
|
|
other words, write <code>git</code> <code>foo</code> <code>-oArg</code> instead of <code>git</code> <code>foo</code> <code>-o</code> <code>Arg</code> for short
|
|
options, and <code>git</code> <code>foo</code> <code>--long-opt=Arg</code> instead of <code>git</code> <code>foo</code> <code>--long-opt</code> <code>Arg</code>
|
|
for long options. An option that takes optional option-argument must be
|
|
written in the <em>stuck</em> form.
|
|
</p>
|
|
</li>
|
|
<li>
|
|
<p>
|
|
Despite the above suggestion, when Arg is a path relative to the
|
|
home directory of a user, e.g. <code>~/directory/file</code> or <code>~u/d/f</code>, you
|
|
may want to use the separate form, e.g. <code>git</code> <code>foo</code> <code>--file</code> <code>~/mine</code>,
|
|
not <code>git</code> <code>foo</code> <code>--file=~/mine</code>. The shell will expand <code>~/</code> in the
|
|
former to your home directory, but most shells keep the tilde in
|
|
the latter. Some of our commands know how to tilde-expand the
|
|
option value even when given in the stuck form, but not all of
|
|
them do.
|
|
</p>
|
|
</li>
|
|
<li>
|
|
<p>
|
|
When you give a revision parameter to a command, make sure the parameter is
|
|
not ambiguous with a name of a file in the work tree. E.g. do not write
|
|
<code>git</code> <code>log</code> <code>-1</code> <code>HEAD</code> but write <code>git</code> <code>log</code> <code>-1</code> <code>HEAD</code> <code>--</code>; the former will not work
|
|
if you happen to have a file called <code>HEAD</code> in the work tree.
|
|
</p>
|
|
</li>
|
|
<li>
|
|
<p>
|
|
Many commands allow a long option <code>--option</code> to be abbreviated
|
|
only to their unique prefix (e.g. if there is no other option
|
|
whose name begins with <code>opt</code>, you may be able to spell <code>--opt</code> to
|
|
invoke the <code>--option</code> flag), but you should fully spell them out
|
|
when writing your scripts; later versions of Git may introduce a
|
|
new option whose name shares the same prefix, e.g. <code>--optimize</code>,
|
|
to make a short prefix that used to be unique no longer unique.
|
|
</p>
|
|
</li>
|
|
</ul></div>
|
|
</div>
|
|
</div>
|
|
<div class="sect1">
|
|
<h2 id="_enhanced_option_parser">ENHANCED OPTION PARSER</h2>
|
|
<div class="sectionbody">
|
|
<div class="paragraph"><p>From the Git 1.5.4 series and further, many Git commands (not all of them at the
|
|
time of the writing though) come with an enhanced option parser.</p></div>
|
|
<div class="paragraph"><p>Here is a list of the facilities provided by this option parser.</p></div>
|
|
<div class="sect2">
|
|
<h3 id="_magic_options">Magic Options</h3>
|
|
<div class="paragraph"><p>Commands which have the enhanced option parser activated all understand a
|
|
couple of magic command-line options:</p></div>
|
|
<div class="dlist"><dl>
|
|
<dt class="hdlist1">
|
|
-h
|
|
</dt>
|
|
<dd>
|
|
<p>
|
|
gives a pretty printed usage of the command.
|
|
</p>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre><code>$ git describe -h
|
|
usage: git describe [<options>] <commit-ish>*
|
|
or: git describe [<options>] --dirty
|
|
|
|
--contains find the tag that comes after the commit
|
|
--debug debug search strategy on stderr
|
|
--all use any ref
|
|
--tags use any tag, even unannotated
|
|
--long always use long format
|
|
--abbrev[=<n>] use <n> digits to display SHA-1s</code></pre>
|
|
</div></div>
|
|
<div class="paragraph"><p>Note that some subcommand (e.g. <code>git</code> <code>grep</code>) may behave differently
|
|
when there are things on the command line other than <code>-h</code>, but <code>git</code>
|
|
<code>subcmd</code> <code>-h</code> without anything else on the command line is meant to
|
|
consistently give the usage.</p></div>
|
|
</dd>
|
|
<dt class="hdlist1">
|
|
--help-all
|
|
</dt>
|
|
<dd>
|
|
<p>
|
|
Some Git commands take options that are only used for plumbing or that
|
|
are deprecated, and such options are hidden from the default usage. This
|
|
option gives the full list of options.
|
|
</p>
|
|
</dd>
|
|
</dl></div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_negating_options">Negating options</h3>
|
|
<div class="paragraph"><p>Options with long option names can be negated by prefixing <code>--no-</code>. For
|
|
example, <code>git</code> <code>branch</code> has the option <code>--track</code> which is <em>on</em> by default. You
|
|
can use <code>--no-track</code> to override that behaviour. The same goes for <code>--color</code>
|
|
and <code>--no-color</code>.</p></div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_options_trump_configuration_and_environment">Options trump configuration and environment</h3>
|
|
<div class="paragraph"><p>When there is a configuration variable or an environment variable
|
|
that tweak the behaviour of an aspect of a Git command, and also a
|
|
command line option that tweaks the same, the command line option
|
|
overrides what the configuration and/or environment variable say.</p></div>
|
|
<div class="paragraph"><p>For example, the <code>user.name</code> configuration variable is used to
|
|
specify the human-readable name used by the <code>git</code> <code>commit</code> command to
|
|
record the author and the committer name in a newly created commit.
|
|
The <code>GIT_AUTHOR_NAME</code> environment variable, if set, takes precedence
|
|
when deciding what author name to record. The <code>--author=</code><em><author></em>
|
|
command line option of the <code>git</code> <code>commit</code> command, when given, takes
|
|
precedence over these two sources of information.</p></div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_aggregating_short_options">Aggregating short options</h3>
|
|
<div class="paragraph"><p>Commands that support the enhanced option parser allow you to aggregate short
|
|
options. This means that you can for example use <code>git</code> <code>rm</code> <code>-rf</code> or
|
|
<code>git</code> <code>clean</code> <code>-fdx</code>.</p></div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_abbreviating_long_options">Abbreviating long options</h3>
|
|
<div class="paragraph"><p>Commands that support the enhanced option parser accepts unique
|
|
prefix of a long option as if it is fully spelled out, but use this
|
|
with a caution. For example, <code>git</code> <code>commit</code> <code>--amen</code> behaves as if you
|
|
typed <code>git</code> <code>commit</code> <code>--amend</code>, but that is true only until a later version
|
|
of Git introduces another option that shares the same prefix,
|
|
e.g. <code>git</code> <code>commit</code> <code>--amenity</code> option.</p></div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_separating_argument_from_the_option">Separating argument from the option</h3>
|
|
<div class="paragraph"><p>You can write the mandatory option parameter to an option as a separate
|
|
word on the command line. That means that all the following uses work:</p></div>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre><code>$ git foo --long-opt=Arg
|
|
$ git foo --long-opt Arg
|
|
$ git foo -oArg
|
|
$ git foo -o Arg</code></pre>
|
|
</div></div>
|
|
<div class="paragraph"><p>However, this is <strong>NOT</strong> allowed for switches with an optional value, where the
|
|
<em>stuck</em> form must be used:</p></div>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre><code>$ git describe --abbrev HEAD # correct
|
|
$ git describe --abbrev=10 HEAD # correct
|
|
$ git describe --abbrev 10 HEAD # NOT WHAT YOU MEANT</code></pre>
|
|
</div></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect1">
|
|
<h2 id="_notes_on_frequently_confused_options">NOTES ON FREQUENTLY CONFUSED OPTIONS</h2>
|
|
<div class="sectionbody">
|
|
<div class="paragraph"><p>Many commands that can work on files in the working tree
|
|
and/or in the index can take <code>--cached</code> and/or <code>--index</code>
|
|
options. Sometimes people incorrectly think that, because
|
|
the index was originally called cache, these two are
|
|
synonyms. They are <strong>not</strong> — these two options mean very
|
|
different things.</p></div>
|
|
<div class="ulist"><ul>
|
|
<li>
|
|
<p>
|
|
The <code>--cached</code> option is used to ask a command that
|
|
usually works on files in the working tree to <strong>only</strong> work
|
|
with the index. For example, <code>git</code> <code>grep</code>, when used
|
|
without a commit to specify from which commit to look for
|
|
strings in, usually works on files in the working tree,
|
|
but with the <code>--cached</code> option, it looks for strings in
|
|
the index.
|
|
</p>
|
|
</li>
|
|
<li>
|
|
<p>
|
|
The <code>--index</code> option is used to ask a command that
|
|
usually works on files in the working tree to <strong>also</strong>
|
|
affect the index. For example, <code>git</code> <code>stash</code> <code>apply</code> usually
|
|
merges changes recorded in a stash entry to the working tree,
|
|
but with the <code>--index</code> option, it also merges changes to
|
|
the index as well.
|
|
</p>
|
|
</li>
|
|
</ul></div>
|
|
<div class="paragraph"><p><code>git</code> <code>apply</code> command can be used with <code>--cached</code> and
|
|
<code>--index</code> (but not at the same time). Usually the command
|
|
only affects the files in the working tree, but with
|
|
<code>--index</code>, it patches both the files and their index
|
|
entries, and with <code>--cached</code>, it modifies only the index
|
|
entries.</p></div>
|
|
<div class="paragraph"><p>See also <a href="https://lore.kernel.org/git/7v64clg5u9.fsf@assigned-by-dhcp.cox.net/">https://lore.kernel.org/git/7v64clg5u9.fsf@assigned-by-dhcp.cox.net/</a> and
|
|
<a href="https://lore.kernel.org/git/7vy7ej9g38.fsf@gitster.siamese.dyndns.org/">https://lore.kernel.org/git/7vy7ej9g38.fsf@gitster.siamese.dyndns.org/</a> for further
|
|
information.</p></div>
|
|
<div class="paragraph"><p>Some other commands that also work on files in the working tree and/or
|
|
in the index can take <code>--staged</code> and/or <code>--worktree</code>.</p></div>
|
|
<div class="ulist"><ul>
|
|
<li>
|
|
<p>
|
|
<code>--staged</code> is exactly like <code>--cached</code>, which is used to ask a
|
|
command to only work on the index, not the working tree.
|
|
</p>
|
|
</li>
|
|
<li>
|
|
<p>
|
|
<code>--worktree</code> is the opposite, to ask a command to work on the
|
|
working tree only, not the index.
|
|
</p>
|
|
</li>
|
|
<li>
|
|
<p>
|
|
The two options can be specified together to ask a command to work
|
|
on both the index and the working tree.
|
|
</p>
|
|
</li>
|
|
</ul></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
|
|
2025-08-18 02:18:23 CEST
|
|
</div>
|
|
</div>
|
|
</body>
|
|
</html>
|