| <!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>git-config(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; | |
| } | |
| 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> | |
| git-config(1) Manual Page | |
| </h1> | |
| <h2>NAME</h2> | |
| <div class="sectionbody"> | |
| <p>git-config - | |
| Get and set repository or global options | |
| </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 config</em> [<file-option>] [type] [--show-origin] [-z|--null] name [value [value_regex]] | |
| <em>git config</em> [<file-option>] [type] --add name value | |
| <em>git config</em> [<file-option>] [type] --replace-all name value [value_regex] | |
| <em>git config</em> [<file-option>] [type] [--show-origin] [-z|--null] --get name [value_regex] | |
| <em>git config</em> [<file-option>] [type] [--show-origin] [-z|--null] --get-all name [value_regex] | |
| <em>git config</em> [<file-option>] [type] [--show-origin] [-z|--null] [--name-only] --get-regexp name_regex [value_regex] | |
| <em>git config</em> [<file-option>] [type] [-z|--null] --get-urlmatch name URL | |
| <em>git config</em> [<file-option>] --unset name [value_regex] | |
| <em>git config</em> [<file-option>] --unset-all name [value_regex] | |
| <em>git config</em> [<file-option>] --rename-section old_name new_name | |
| <em>git config</em> [<file-option>] --remove-section name | |
| <em>git config</em> [<file-option>] [--show-origin] [-z|--null] [--name-only] -l | --list | |
| <em>git config</em> [<file-option>] --get-color name [default] | |
| <em>git config</em> [<file-option>] --get-colorbool name [stdout-is-tty] | |
| <em>git config</em> [<file-option>] -e | --edit</pre> | |
| <div class="attribution"> | |
| </div></div> | |
| </div> | |
| </div> | |
| <div class="sect1"> | |
| <h2 id="_description">DESCRIPTION</h2> | |
| <div class="sectionbody"> | |
| <div class="paragraph"><p>You can query/set/replace/unset options with this command. The name is | |
| actually the section and the key separated by a dot, and the value will be | |
| escaped.</p></div> | |
| <div class="paragraph"><p>Multiple lines can be added to an option by using the <code>--add</code> option. | |
| If you want to update or unset an option which can occur on multiple | |
| lines, a POSIX regexp <code>value_regex</code> needs to be given. Only the | |
| existing values that match the regexp are updated or unset. If | |
| you want to handle the lines that do <strong>not</strong> match the regex, just | |
| prepend a single exclamation mark in front (see also <a href="#EXAMPLES">[EXAMPLES]</a>).</p></div> | |
| <div class="paragraph"><p>The type specifier can be either <code>--int</code> or <code>--bool</code>, to make | |
| <em>git config</em> ensure that the variable(s) are of the given type and | |
| convert the value to the canonical form (simple decimal number for int, | |
| a "true" or "false" string for bool), or <code>--path</code>, which does some | |
| path expansion (see <code>--path</code> below). If no type specifier is passed, no | |
| checks or transformations are performed on the value.</p></div> | |
| <div class="paragraph"><p>When reading, the values are read from the system, global and | |
| repository local configuration files by default, and options | |
| <code>--system</code>, <code>--global</code>, <code>--local</code> and <code>--file <filename></code> can be | |
| used to tell the command to read from only that location (see <a href="#FILES">[FILES]</a>).</p></div> | |
| <div class="paragraph"><p>When writing, the new value is written to the repository local | |
| configuration file by default, and options <code>--system</code>, <code>--global</code>, | |
| <code>--file <filename></code> can be used to tell the command to write to | |
| that location (you can say <code>--local</code> but that is the default).</p></div> | |
| <div class="paragraph"><p>This command will fail with non-zero status upon error. Some exit | |
| codes are:</p></div> | |
| <div class="ulist"><ul> | |
| <li> | |
| <p> | |
| The section or key is invalid (ret=1), | |
| </p> | |
| </li> | |
| <li> | |
| <p> | |
| no section or name was provided (ret=2), | |
| </p> | |
| </li> | |
| <li> | |
| <p> | |
| the config file is invalid (ret=3), | |
| </p> | |
| </li> | |
| <li> | |
| <p> | |
| the config file cannot be written (ret=4), | |
| </p> | |
| </li> | |
| <li> | |
| <p> | |
| you try to unset an option which does not exist (ret=5), | |
| </p> | |
| </li> | |
| <li> | |
| <p> | |
| you try to unset/set an option for which multiple lines match (ret=5), or | |
| </p> | |
| </li> | |
| <li> | |
| <p> | |
| you try to use an invalid regexp (ret=6). | |
| </p> | |
| </li> | |
| </ul></div> | |
| <div class="paragraph"><p>On success, the command returns the exit code 0.</p></div> | |
| </div> | |
| </div> | |
| <div class="sect1"> | |
| <h2 id="_options">OPTIONS</h2> | |
| <div class="sectionbody"> | |
| <div class="dlist"><dl> | |
| <dt class="hdlist1"> | |
| --replace-all | |
| </dt> | |
| <dd> | |
| <p> | |
| Default behavior is to replace at most one line. This replaces | |
| all lines matching the key (and optionally the value_regex). | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| --add | |
| </dt> | |
| <dd> | |
| <p> | |
| Adds a new line to the option without altering any existing | |
| values. This is the same as providing <em>^$</em> as the value_regex | |
| in <code>--replace-all</code>. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| --get | |
| </dt> | |
| <dd> | |
| <p> | |
| Get the value for a given key (optionally filtered by a regex | |
| matching the value). Returns error code 1 if the key was not | |
| found and the last value if multiple key values were found. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| --get-all | |
| </dt> | |
| <dd> | |
| <p> | |
| Like get, but returns all values for a multi-valued key. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| --get-regexp | |
| </dt> | |
| <dd> | |
| <p> | |
| Like --get-all, but interprets the name as a regular expression and | |
| writes out the key names. Regular expression matching is currently | |
| case-sensitive and done against a canonicalized version of the key | |
| in which section and variable names are lowercased, but subsection | |
| names are not. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| --get-urlmatch name URL | |
| </dt> | |
| <dd> | |
| <p> | |
| When given a two-part name section.key, the value for | |
| section.<url>.key whose <url> part matches the best to the | |
| given URL is returned (if no such key exists, the value for | |
| section.key is used as a fallback). When given just the | |
| section as name, do so for all the keys in the section and | |
| list them. Returns error code 1 if no value is found. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| --global | |
| </dt> | |
| <dd> | |
| <p> | |
| For writing options: write to global <code>~/.gitconfig</code> file | |
| rather than the repository <code>.git/config</code>, write to | |
| <code>$XDG_CONFIG_HOME/git/config</code> file if this file exists and the | |
| <code>~/.gitconfig</code> file doesn’t. | |
| </p> | |
| <div class="paragraph"><p>For reading options: read only from global <code>~/.gitconfig</code> and from | |
| <code>$XDG_CONFIG_HOME/git/config</code> rather than from all available files.</p></div> | |
| <div class="paragraph"><p>See also <a href="#FILES">[FILES]</a>.</p></div> | |
| </dd> | |
| <dt class="hdlist1"> | |
| --system | |
| </dt> | |
| <dd> | |
| <p> | |
| For writing options: write to system-wide | |
| <code>$(prefix)/etc/gitconfig</code> rather than the repository | |
| <code>.git/config</code>. | |
| </p> | |
| <div class="paragraph"><p>For reading options: read only from system-wide <code>$(prefix)/etc/gitconfig</code> | |
| rather than from all available files.</p></div> | |
| <div class="paragraph"><p>See also <a href="#FILES">[FILES]</a>.</p></div> | |
| </dd> | |
| <dt class="hdlist1"> | |
| --local | |
| </dt> | |
| <dd> | |
| <p> | |
| For writing options: write to the repository <code>.git/config</code> file. | |
| This is the default behavior. | |
| </p> | |
| <div class="paragraph"><p>For reading options: read only from the repository <code>.git/config</code> rather than | |
| from all available files.</p></div> | |
| <div class="paragraph"><p>See also <a href="#FILES">[FILES]</a>.</p></div> | |
| </dd> | |
| <dt class="hdlist1"> | |
| -f config-file | |
| </dt> | |
| <dt class="hdlist1"> | |
| --file config-file | |
| </dt> | |
| <dd> | |
| <p> | |
| Use the given config file instead of the one specified by GIT_CONFIG. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| --blob blob | |
| </dt> | |
| <dd> | |
| <p> | |
| Similar to <code>--file</code> but use the given blob instead of a file. E.g. | |
| you can use <em>master:.gitmodules</em> to read values from the file | |
| <em>.gitmodules</em> in the master branch. See "SPECIFYING REVISIONS" | |
| section in <a href="gitrevisions.html">gitrevisions(7)</a> for a more complete list of | |
| ways to spell blob names. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| --remove-section | |
| </dt> | |
| <dd> | |
| <p> | |
| Remove the given section from the configuration file. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| --rename-section | |
| </dt> | |
| <dd> | |
| <p> | |
| Rename the given section to a new name. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| --unset | |
| </dt> | |
| <dd> | |
| <p> | |
| Remove the line matching the key from config file. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| --unset-all | |
| </dt> | |
| <dd> | |
| <p> | |
| Remove all lines matching the key from config file. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| -l | |
| </dt> | |
| <dt class="hdlist1"> | |
| --list | |
| </dt> | |
| <dd> | |
| <p> | |
| List all variables set in config file, along with their values. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| --bool | |
| </dt> | |
| <dd> | |
| <p> | |
| <em>git config</em> will ensure that the output is "true" or "false" | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| --int | |
| </dt> | |
| <dd> | |
| <p> | |
| <em>git config</em> will ensure that the output is a simple | |
| decimal number. An optional value suffix of <em>k</em>, <em>m</em>, or <em>g</em> | |
| in the config file will cause the value to be multiplied | |
| by 1024, 1048576, or 1073741824 prior to output. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| --bool-or-int | |
| </dt> | |
| <dd> | |
| <p> | |
| <em>git config</em> will ensure that the output matches the format of | |
| either --bool or --int, as described above. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| --path | |
| </dt> | |
| <dd> | |
| <p> | |
| <em>git-config</em> will expand leading <em>~</em> to the value of | |
| <em>$HOME</em>, and <em>~user</em> to the home directory for the | |
| specified user. This option has no effect when setting the | |
| value (but you can use <em>git config bla ~/</em> from the | |
| command line to let your shell do the expansion). | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| -z | |
| </dt> | |
| <dt class="hdlist1"> | |
| --null | |
| </dt> | |
| <dd> | |
| <p> | |
| For all options that output values and/or keys, always | |
| end values with the null character (instead of a | |
| newline). Use newline instead as a delimiter between | |
| key and value. This allows for secure parsing of the | |
| output without getting confused e.g. by values that | |
| contain line breaks. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| --name-only | |
| </dt> | |
| <dd> | |
| <p> | |
| Output only the names of config variables for <code>--list</code> or | |
| <code>--get-regexp</code>. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| --show-origin | |
| </dt> | |
| <dd> | |
| <p> | |
| Augment the output of all queried config options with the | |
| origin type (file, standard input, blob, command line) and | |
| the actual origin (config file path, ref, or blob id if | |
| applicable). | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| --get-colorbool name [stdout-is-tty] | |
| </dt> | |
| <dd> | |
| <p> | |
| Find the color setting for <code>name</code> (e.g. <code>color.diff</code>) and output | |
| "true" or "false". <code>stdout-is-tty</code> should be either "true" or | |
| "false", and is taken into account when configuration says | |
| "auto". If <code>stdout-is-tty</code> is missing, then checks the standard | |
| output of the command itself, and exits with status 0 if color | |
| is to be used, or exits with status 1 otherwise. | |
| When the color setting for <code>name</code> is undefined, the command uses | |
| <code>color.ui</code> as fallback. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| --get-color name [default] | |
| </dt> | |
| <dd> | |
| <p> | |
| Find the color configured for <code>name</code> (e.g. <code>color.diff.new</code>) and | |
| output it as the ANSI color escape sequence to the standard | |
| output. The optional <code>default</code> parameter is used instead, if | |
| there is no color configured for <code>name</code>. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| -e | |
| </dt> | |
| <dt class="hdlist1"> | |
| --edit | |
| </dt> | |
| <dd> | |
| <p> | |
| Opens an editor to modify the specified config file; either | |
| <code>--system</code>, <code>--global</code>, or repository (default). | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| --[no-]includes | |
| </dt> | |
| <dd> | |
| <p> | |
| Respect <code>include.*</code> directives in config files when looking up | |
| values. Defaults to <code>off</code> when a specific file is given (e.g., | |
| using <code>--file</code>, <code>--global</code>, etc) and <code>on</code> when searching all | |
| config files. | |
| </p> | |
| </dd> | |
| </dl></div> | |
| </div> | |
| </div> | |
| <div class="sect1"> | |
| <h2 id="FILES">FILES</h2> | |
| <div class="sectionbody"> | |
| <div class="paragraph"><p>If not set explicitly with <code>--file</code>, there are four files where | |
| <em>git config</em> will search for configuration options:</p></div> | |
| <div class="dlist"><dl> | |
| <dt class="hdlist1"> | |
| $(prefix)/etc/gitconfig | |
| </dt> | |
| <dd> | |
| <p> | |
| System-wide configuration file. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| $XDG_CONFIG_HOME/git/config | |
| </dt> | |
| <dd> | |
| <p> | |
| Second user-specific configuration file. If $XDG_CONFIG_HOME is not set | |
| or empty, <code>$HOME/.config/git/config</code> will be used. Any single-valued | |
| variable set in this file will be overwritten by whatever is in | |
| <code>~/.gitconfig</code>. It is a good idea not to create this file if | |
| you sometimes use older versions of Git, as support for this | |
| file was added fairly recently. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| ~/.gitconfig | |
| </dt> | |
| <dd> | |
| <p> | |
| User-specific configuration file. Also called "global" | |
| configuration file. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| $GIT_DIR/config | |
| </dt> | |
| <dd> | |
| <p> | |
| Repository specific configuration file. | |
| </p> | |
| </dd> | |
| </dl></div> | |
| <div class="paragraph"><p>If no further options are given, all reading options will read all of these | |
| files that are available. If the global or the system-wide configuration | |
| file are not available they will be ignored. If the repository configuration | |
| file is not available or readable, <em>git config</em> will exit with a non-zero | |
| error code. However, in neither case will an error message be issued.</p></div> | |
| <div class="paragraph"><p>The files are read in the order given above, with last value found taking | |
| precedence over values read earlier. When multiple values are taken then all | |
| values of a key from all files will be used.</p></div> | |
| <div class="paragraph"><p>All writing options will per default write to the repository specific | |
| configuration file. Note that this also affects options like <code>--replace-all</code> | |
| and <code>--unset</code>. <strong><em>git config</em> will only ever change one file at a time</strong>.</p></div> | |
| <div class="paragraph"><p>You can override these rules either by command-line options or by environment | |
| variables. The <code>--global</code> and the <code>--system</code> options will limit the file used | |
| to the global or system-wide file respectively. The <code>GIT_CONFIG</code> environment | |
| variable has a similar effect, but you can specify any filename you want.</p></div> | |
| </div> | |
| </div> | |
| <div class="sect1"> | |
| <h2 id="_environment">ENVIRONMENT</h2> | |
| <div class="sectionbody"> | |
| <div class="dlist"><dl> | |
| <dt class="hdlist1"> | |
| GIT_CONFIG | |
| </dt> | |
| <dd> | |
| <p> | |
| Take the configuration from the given file instead of .git/config. | |
| Using the "--global" option forces this to ~/.gitconfig. Using the | |
| "--system" option forces this to $(prefix)/etc/gitconfig. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| GIT_CONFIG_NOSYSTEM | |
| </dt> | |
| <dd> | |
| <p> | |
| Whether to skip reading settings from the system-wide | |
| $(prefix)/etc/gitconfig file. See <a href="git.html">git(1)</a> for details. | |
| </p> | |
| </dd> | |
| </dl></div> | |
| <div class="paragraph"><p>See also <a href="#FILES">[FILES]</a>.</p></div> | |
| </div> | |
| </div> | |
| <div class="sect1"> | |
| <h2 id="EXAMPLES">EXAMPLES</h2> | |
| <div class="sectionbody"> | |
| <div class="paragraph"><p>Given a .git/config like this:</p></div> | |
| <div class="literalblock"> | |
| <div class="content"> | |
| <pre><code># | |
| # This is the config file, and | |
| # a '#' or ';' character indicates | |
| # a comment | |
| #</code></pre> | |
| </div></div> | |
| <div class="literalblock"> | |
| <div class="content"> | |
| <pre><code>; core variables | |
| [core] | |
| ; Don't trust file modes | |
| filemode = false</code></pre> | |
| </div></div> | |
| <div class="literalblock"> | |
| <div class="content"> | |
| <pre><code>; Our diff algorithm | |
| [diff] | |
| external = /usr/local/bin/diff-wrapper | |
| renames = true</code></pre> | |
| </div></div> | |
| <div class="literalblock"> | |
| <div class="content"> | |
| <pre><code>; Proxy settings | |
| [core] | |
| gitproxy=proxy-command for kernel.org | |
| gitproxy=default-proxy ; for all the rest</code></pre> | |
| </div></div> | |
| <div class="literalblock"> | |
| <div class="content"> | |
| <pre><code>; HTTP | |
| [http] | |
| sslVerify | |
| [http "https://weak.example.com"] | |
| sslVerify = false | |
| cookieFile = /tmp/cookie.txt</code></pre> | |
| </div></div> | |
| <div class="paragraph"><p>you can set the filemode to true with</p></div> | |
| <div class="listingblock"> | |
| <div class="content"> | |
| <pre><code>% git config core.filemode true</code></pre> | |
| </div></div> | |
| <div class="paragraph"><p>The hypothetical proxy command entries actually have a postfix to discern | |
| what URL they apply to. Here is how to change the entry for kernel.org | |
| to "ssh".</p></div> | |
| <div class="listingblock"> | |
| <div class="content"> | |
| <pre><code>% git config core.gitproxy '"ssh" for kernel.org' 'for kernel.org$'</code></pre> | |
| </div></div> | |
| <div class="paragraph"><p>This makes sure that only the key/value pair for kernel.org is replaced.</p></div> | |
| <div class="paragraph"><p>To delete the entry for renames, do</p></div> | |
| <div class="listingblock"> | |
| <div class="content"> | |
| <pre><code>% git config --unset diff.renames</code></pre> | |
| </div></div> | |
| <div class="paragraph"><p>If you want to delete an entry for a multivar (like core.gitproxy above), | |
| you have to provide a regex matching the value of exactly one line.</p></div> | |
| <div class="paragraph"><p>To query the value for a given key, do</p></div> | |
| <div class="listingblock"> | |
| <div class="content"> | |
| <pre><code>% git config --get core.filemode</code></pre> | |
| </div></div> | |
| <div class="paragraph"><p>or</p></div> | |
| <div class="listingblock"> | |
| <div class="content"> | |
| <pre><code>% git config core.filemode</code></pre> | |
| </div></div> | |
| <div class="paragraph"><p>or, to query a multivar:</p></div> | |
| <div class="listingblock"> | |
| <div class="content"> | |
| <pre><code>% git config --get core.gitproxy "for kernel.org$"</code></pre> | |
| </div></div> | |
| <div class="paragraph"><p>If you want to know all the values for a multivar, do:</p></div> | |
| <div class="listingblock"> | |
| <div class="content"> | |
| <pre><code>% git config --get-all core.gitproxy</code></pre> | |
| </div></div> | |
| <div class="paragraph"><p>If you like to live dangerously, you can replace <strong>all</strong> core.gitproxy by a | |
| new one with</p></div> | |
| <div class="listingblock"> | |
| <div class="content"> | |
| <pre><code>% git config --replace-all core.gitproxy ssh</code></pre> | |
| </div></div> | |
| <div class="paragraph"><p>However, if you really only want to replace the line for the default proxy, | |
| i.e. the one without a "for …" postfix, do something like this:</p></div> | |
| <div class="listingblock"> | |
| <div class="content"> | |
| <pre><code>% git config core.gitproxy ssh '! for '</code></pre> | |
| </div></div> | |
| <div class="paragraph"><p>To actually match only values with an exclamation mark, you have to</p></div> | |
| <div class="listingblock"> | |
| <div class="content"> | |
| <pre><code>% git config section.key value '[!]'</code></pre> | |
| </div></div> | |
| <div class="paragraph"><p>To add a new proxy, without altering any of the existing ones, use</p></div> | |
| <div class="listingblock"> | |
| <div class="content"> | |
| <pre><code>% git config --add core.gitproxy '"proxy-command" for example.com'</code></pre> | |
| </div></div> | |
| <div class="paragraph"><p>An example to use customized color from the configuration in your | |
| script:</p></div> | |
| <div class="listingblock"> | |
| <div class="content"> | |
| <pre><code>#!/bin/sh | |
| WS=$(git config --get-color color.diff.whitespace "blue reverse") | |
| RESET=$(git config --get-color "" "reset") | |
| echo "${WS}your whitespace color or blue reverse${RESET}"</code></pre> | |
| </div></div> | |
| <div class="paragraph"><p>For URLs in <code>https://weak.example.com</code>, <code>http.sslVerify</code> is set to | |
| false, while it is set to <code>true</code> for all others:</p></div> | |
| <div class="listingblock"> | |
| <div class="content"> | |
| <pre><code>% git config --bool --get-urlmatch http.sslverify https://good.example.com | |
| true | |
| % git config --bool --get-urlmatch http.sslverify https://weak.example.com | |
| false | |
| % git config --get-urlmatch http https://weak.example.com | |
| http.cookieFile /tmp/cookie.txt | |
| http.sslverify false</code></pre> | |
| </div></div> | |
| </div> | |
| </div> | |
| <div class="sect1"> | |
| <h2 id="_configuration_file">CONFIGURATION FILE</h2> | |
| <div class="sectionbody"> | |
| <div class="paragraph"><p>The Git configuration file contains a number of variables that affect | |
| the Git commands' behavior. The <code>.git/config</code> file in each repository | |
| is used to store the configuration for that repository, and | |
| <code>$HOME/.gitconfig</code> is used to store a per-user configuration as | |
| fallback values for the <code>.git/config</code> file. The file <code>/etc/gitconfig</code> | |
| can be used to store a system-wide default configuration.</p></div> | |
| <div class="paragraph"><p>The configuration variables are used by both the Git plumbing | |
| and the porcelains. The variables are divided into sections, wherein | |
| the fully qualified variable name of the variable itself is the last | |
| dot-separated segment and the section name is everything before the last | |
| dot. The variable names are case-insensitive, allow only alphanumeric | |
| characters and <code>-</code>, and must start with an alphabetic character. Some | |
| variables may appear multiple times; we say then that the variable is | |
| multivalued.</p></div> | |
| <div class="sect2"> | |
| <h3 id="_syntax">Syntax</h3> | |
| <div class="paragraph"><p>The syntax is fairly flexible and permissive; whitespaces are mostly | |
| ignored. The <em>#</em> and <em>;</em> characters begin comments to the end of line, | |
| blank lines are ignored.</p></div> | |
| <div class="paragraph"><p>The file consists of sections and variables. A section begins with | |
| the name of the section in square brackets and continues until the next | |
| section begins. Section names are case-insensitive. Only alphanumeric | |
| characters, <code>-</code> and <code>.</code> are allowed in section names. Each variable | |
| must belong to some section, which means that there must be a section | |
| header before the first setting of a variable.</p></div> | |
| <div class="paragraph"><p>Sections can be further divided into subsections. To begin a subsection | |
| put its name in double quotes, separated by space from the section name, | |
| in the section header, like in the example below:</p></div> | |
| <div class="listingblock"> | |
| <div class="content"> | |
| <pre><code> [section "subsection"]</code></pre> | |
| </div></div> | |
| <div class="paragraph"><p>Subsection names are case sensitive and can contain any characters except | |
| newline (doublequote <code>"</code> and backslash can be included by escaping them | |
| as <code>\"</code> and <code>\\</code>, respectively). Section headers cannot span multiple | |
| lines. Variables may belong directly to a section or to a given subsection. | |
| You can have <code>[section]</code> if you have <code>[section "subsection"]</code>, but you | |
| don’t need to.</p></div> | |
| <div class="paragraph"><p>There is also a deprecated <code>[section.subsection]</code> syntax. With this | |
| syntax, the subsection name is converted to lower-case and is also | |
| compared case sensitively. These subsection names follow the same | |
| restrictions as section names.</p></div> | |
| <div class="paragraph"><p>All the other lines (and the remainder of the line after the section | |
| header) are recognized as setting variables, in the form | |
| <em>name = value</em> (or just <em>name</em>, which is a short-hand to say that | |
| the variable is the boolean "true"). | |
| The variable names are case-insensitive, allow only alphanumeric characters | |
| and <code>-</code>, and must start with an alphabetic character.</p></div> | |
| <div class="paragraph"><p>A line that defines a value can be continued to the next line by | |
| ending it with a <code>\</code>; the backquote and the end-of-line are | |
| stripped. Leading whitespaces after <em>name =</em>, the remainder of the | |
| line after the first comment character <em>#</em> or <em>;</em>, and trailing | |
| whitespaces of the line are discarded unless they are enclosed in | |
| double quotes. Internal whitespaces within the value are retained | |
| verbatim.</p></div> | |
| <div class="paragraph"><p>Inside double quotes, double quote <code>"</code> and backslash <code>\</code> characters | |
| must be escaped: use <code>\"</code> for <code>"</code> and <code>\\</code> for <code>\</code>.</p></div> | |
| <div class="paragraph"><p>The following escape sequences (beside <code>\"</code> and <code>\\</code>) are recognized: | |
| <code>\n</code> for newline character (NL), <code>\t</code> for horizontal tabulation (HT, TAB) | |
| and <code>\b</code> for backspace (BS). Other char escape sequences (including octal | |
| escape sequences) are invalid.</p></div> | |
| </div> | |
| <div class="sect2"> | |
| <h3 id="_includes">Includes</h3> | |
| <div class="paragraph"><p>You can include one config file from another by setting the special | |
| <code>include.path</code> variable to the name of the file to be included. The | |
| variable takes a pathname as its value, and is subject to tilde | |
| expansion.</p></div> | |
| <div class="paragraph"><p>The | |
| included file is expanded immediately, as if its contents had been | |
| found at the location of the include directive. If the value of the | |
| <code>include.path</code> variable is a relative path, the path is considered to be | |
| relative to the configuration file in which the include directive was | |
| found. See below for examples.</p></div> | |
| </div> | |
| <div class="sect2"> | |
| <h3 id="_example">Example</h3> | |
| <div class="literalblock"> | |
| <div class="content"> | |
| <pre><code># Core variables | |
| [core] | |
| ; Don't trust file modes | |
| filemode = false</code></pre> | |
| </div></div> | |
| <div class="literalblock"> | |
| <div class="content"> | |
| <pre><code># Our diff algorithm | |
| [diff] | |
| external = /usr/local/bin/diff-wrapper | |
| renames = true</code></pre> | |
| </div></div> | |
| <div class="literalblock"> | |
| <div class="content"> | |
| <pre><code>[branch "devel"] | |
| remote = origin | |
| merge = refs/heads/devel</code></pre> | |
| </div></div> | |
| <div class="literalblock"> | |
| <div class="content"> | |
| <pre><code># Proxy settings | |
| [core] | |
| gitProxy="ssh" for "kernel.org" | |
| gitProxy=default-proxy ; for the rest</code></pre> | |
| </div></div> | |
| <div class="literalblock"> | |
| <div class="content"> | |
| <pre><code>[include] | |
| path = /path/to/foo.inc ; include by absolute path | |
| path = foo ; expand "foo" relative to the current file | |
| path = ~/foo ; expand "foo" in your `$HOME` directory</code></pre> | |
| </div></div> | |
| </div> | |
| <div class="sect2"> | |
| <h3 id="_values">Values</h3> | |
| <div class="paragraph"><p>Values of many variables are treated as a simple string, but there | |
| are variables that take values of specific types and there are rules | |
| as to how to spell them.</p></div> | |
| <div class="dlist"><dl> | |
| <dt class="hdlist1"> | |
| boolean | |
| </dt> | |
| <dd> | |
| <p> | |
| When a variable is said to take a boolean value, many | |
| synonyms are accepted for <em>true</em> and <em>false</em>; these are all | |
| case-insensitive. | |
| </p> | |
| <div class="dlist"><dl> | |
| <dt class="hdlist1"> | |
| true | |
| </dt> | |
| <dd> | |
| <p> | |
| Boolean true can be spelled as <code>yes</code>, <code>on</code>, <code>true</code>, | |
| or <code>1</code>. Also, a variable defined without <code>= <value></code> | |
| is taken as true. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| false | |
| </dt> | |
| <dd> | |
| <p> | |
| Boolean false can be spelled as <code>no</code>, <code>off</code>, | |
| <code>false</code>, or <code>0</code>. | |
| </p> | |
| <div class="paragraph"><p>When converting value to the canonical form using <code>--bool</code> type | |
| specifier; <em>git config</em> will ensure that the output is "true" or | |
| "false" (spelled in lowercase).</p></div> | |
| </dd> | |
| </dl></div> | |
| </dd> | |
| <dt class="hdlist1"> | |
| integer | |
| </dt> | |
| <dd> | |
| <p> | |
| The value for many variables that specify various sizes can | |
| be suffixed with <code>k</code>, <code>M</code>,… to mean "scale the number by | |
| 1024", "by 1024x1024", etc. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| color | |
| </dt> | |
| <dd> | |
| <p> | |
| The value for a variable that takes a color is a list of | |
| colors (at most two, one for foreground and one for background) | |
| and attributes (as many as you want), separated by spaces. | |
| </p> | |
| <div class="paragraph"><p>The basic colors accepted are <code>normal</code>, <code>black</code>, <code>red</code>, <code>green</code>, <code>yellow</code>, | |
| <code>blue</code>, <code>magenta</code>, <code>cyan</code> and <code>white</code>. The first color given is the | |
| foreground; the second is the background.</p></div> | |
| <div class="paragraph"><p>Colors may also be given as numbers between 0 and 255; these use ANSI | |
| 256-color mode (but note that not all terminals may support this). If | |
| your terminal supports it, you may also specify 24-bit RGB values as | |
| hex, like <code>#ff0ab3</code>.</p></div> | |
| <div class="paragraph"><p>The accepted attributes are <code>bold</code>, <code>dim</code>, <code>ul</code>, <code>blink</code>, <code>reverse</code>, | |
| <code>italic</code>, and <code>strike</code> (for crossed-out or "strikethrough" letters). | |
| The position of any attributes with respect to the colors | |
| (before, after, or in between), doesn’t matter. Specific attributes may | |
| be turned off by prefixing them with <code>no</code> or <code>no-</code> (e.g., <code>noreverse</code>, | |
| <code>no-ul</code>, etc).</p></div> | |
| <div class="paragraph"><p>For git’s pre-defined color slots, the attributes are meant to be reset | |
| at the beginning of each item in the colored output. So setting | |
| <code>color.decorate.branch</code> to <code>black</code> will paint that branch name in a | |
| plain <code>black</code>, even if the previous thing on the same output line (e.g. | |
| opening parenthesis before the list of branch names in <code>log --decorate</code> | |
| output) is set to be painted with <code>bold</code> or some other attribute. | |
| However, custom log formats may do more complicated and layered | |
| coloring, and the negated forms may be useful there.</p></div> | |
| </dd> | |
| <dt class="hdlist1"> | |
| pathname | |
| </dt> | |
| <dd> | |
| <p> | |
| A variable that takes a pathname value can be given a | |
| string that begins with "<code>~/</code>" or "<code>~user/</code>", and the usual | |
| tilde expansion happens to such a string: <code>~/</code> | |
| is expanded to the value of <code>$HOME</code>, and <code>~user/</code> to the | |
| specified user’s home directory. | |
| </p> | |
| </dd> | |
| </dl></div> | |
| </div> | |
| <div class="sect2"> | |
| <h3 id="_variables">Variables</h3> | |
| <div class="paragraph"><p>Note that this list is non-comprehensive and not necessarily complete. | |
| For command-specific variables, you will find a more detailed description | |
| in the appropriate manual page.</p></div> | |
| <div class="paragraph"><p>Other git-related tools may and do use their own variables. When | |
| inventing new variables for use in your own tool, make sure their | |
| names do not conflict with those that are used by Git itself and | |
| other popular tools, and describe them in your documentation.</p></div> | |
| <div class="dlist"><dl> | |
| <dt class="hdlist1"> | |
| advice.* | |
| </dt> | |
| <dd> | |
| <p> | |
| These variables control various optional help messages designed to | |
| aid new users. All <em>advice.*</em> variables default to <em>true</em>, and you | |
| can tell Git that you do not need help by setting these to <em>false</em>: | |
| </p> | |
| <div class="openblock"> | |
| <div class="content"> | |
| <div class="dlist"><dl> | |
| <dt class="hdlist1"> | |
| pushUpdateRejected | |
| </dt> | |
| <dd> | |
| <p> | |
| Set this variable to <em>false</em> if you want to disable | |
| <em>pushNonFFCurrent</em>, | |
| <em>pushNonFFMatching</em>, <em>pushAlreadyExists</em>, | |
| <em>pushFetchFirst</em>, and <em>pushNeedsForce</em> | |
| simultaneously. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| pushNonFFCurrent | |
| </dt> | |
| <dd> | |
| <p> | |
| Advice shown when <a href="git-push.html">git-push(1)</a> fails due to a | |
| non-fast-forward update to the current branch. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| pushNonFFMatching | |
| </dt> | |
| <dd> | |
| <p> | |
| Advice shown when you ran <a href="git-push.html">git-push(1)</a> and pushed | |
| <em>matching refs</em> explicitly (i.e. you used <em>:</em>, or | |
| specified a refspec that isn’t your current branch) and | |
| it resulted in a non-fast-forward error. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| pushAlreadyExists | |
| </dt> | |
| <dd> | |
| <p> | |
| Shown when <a href="git-push.html">git-push(1)</a> rejects an update that | |
| does not qualify for fast-forwarding (e.g., a tag.) | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| pushFetchFirst | |
| </dt> | |
| <dd> | |
| <p> | |
| Shown when <a href="git-push.html">git-push(1)</a> rejects an update that | |
| tries to overwrite a remote ref that points at an | |
| object we do not have. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| pushNeedsForce | |
| </dt> | |
| <dd> | |
| <p> | |
| Shown when <a href="git-push.html">git-push(1)</a> rejects an update that | |
| tries to overwrite a remote ref that points at an | |
| object that is not a commit-ish, or make the remote | |
| ref point at an object that is not a commit-ish. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| statusHints | |
| </dt> | |
| <dd> | |
| <p> | |
| Show directions on how to proceed from the current | |
| state in the output of <a href="git-status.html">git-status(1)</a>, in | |
| the template shown when writing commit messages in | |
| <a href="git-commit.html">git-commit(1)</a>, and in the help message shown | |
| by <a href="git-checkout.html">git-checkout(1)</a> when switching branch. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| statusUoption | |
| </dt> | |
| <dd> | |
| <p> | |
| Advise to consider using the <code>-u</code> option to <a href="git-status.html">git-status(1)</a> | |
| when the command takes more than 2 seconds to enumerate untracked | |
| files. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| commitBeforeMerge | |
| </dt> | |
| <dd> | |
| <p> | |
| Advice shown when <a href="git-merge.html">git-merge(1)</a> refuses to | |
| merge to avoid overwriting local changes. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| resolveConflict | |
| </dt> | |
| <dd> | |
| <p> | |
| Advice shown by various commands when conflicts | |
| prevent the operation from being performed. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| implicitIdentity | |
| </dt> | |
| <dd> | |
| <p> | |
| Advice on how to set your identity configuration when | |
| your information is guessed from the system username and | |
| domain name. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| detachedHead | |
| </dt> | |
| <dd> | |
| <p> | |
| Advice shown when you used <a href="git-checkout.html">git-checkout(1)</a> to | |
| move to the detach HEAD state, to instruct how to create | |
| a local branch after the fact. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| amWorkDir | |
| </dt> | |
| <dd> | |
| <p> | |
| Advice that shows the location of the patch file when | |
| <a href="git-am.html">git-am(1)</a> fails to apply it. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| rmHints | |
| </dt> | |
| <dd> | |
| <p> | |
| In case of failure in the output of <a href="git-rm.html">git-rm(1)</a>, | |
| show directions on how to proceed from the current state. | |
| </p> | |
| </dd> | |
| </dl></div> | |
| </div></div> | |
| </dd> | |
| <dt class="hdlist1"> | |
| core.fileMode | |
| </dt> | |
| <dd> | |
| <p> | |
| Tells Git if the executable bit of files in the working tree | |
| is to be honored. | |
| </p> | |
| <div class="paragraph"><p>Some filesystems lose the executable bit when a file that is | |
| marked as executable is checked out, or checks out an | |
| non-executable file with executable bit on. | |
| <a href="git-clone.html">git-clone(1)</a> or <a href="git-init.html">git-init(1)</a> probe the filesystem | |
| to see if it handles the executable bit correctly | |
| and this variable is automatically set as necessary.</p></div> | |
| <div class="paragraph"><p>A repository, however, may be on a filesystem that handles | |
| the filemode correctly, and this variable is set to <em>true</em> | |
| when created, but later may be made accessible from another | |
| environment that loses the filemode (e.g. exporting ext4 via | |
| CIFS mount, visiting a Cygwin created repository with | |
| Git for Windows or Eclipse). | |
| In such a case it may be necessary to set this variable to <em>false</em>. | |
| See <a href="git-update-index.html">git-update-index(1)</a>.</p></div> | |
| <div class="paragraph"><p>The default is true (when core.filemode is not specified in the config file).</p></div> | |
| </dd> | |
| <dt class="hdlist1"> | |
| core.hideDotFiles | |
| </dt> | |
| <dd> | |
| <p> | |
| (Windows-only) If true, mark newly-created directories and files whose | |
| name starts with a dot as hidden. If <em>dotGitOnly</em>, only the <code>.git/</code> | |
| directory is hidden, but no other files starting with a dot. The | |
| default mode is <em>dotGitOnly</em>. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| core.ignoreCase | |
| </dt> | |
| <dd> | |
| <p> | |
| If true, this option enables various workarounds to enable | |
| Git to work better on filesystems that are not case sensitive, | |
| like FAT. For example, if a directory listing finds | |
| "makefile" when Git expects "Makefile", Git will assume | |
| it is really the same file, and continue to remember it as | |
| "Makefile". | |
| </p> | |
| <div class="paragraph"><p>The default is false, except <a href="git-clone.html">git-clone(1)</a> or <a href="git-init.html">git-init(1)</a> | |
| will probe and set core.ignoreCase true if appropriate when the repository | |
| is created.</p></div> | |
| </dd> | |
| <dt class="hdlist1"> | |
| core.precomposeUnicode | |
| </dt> | |
| <dd> | |
| <p> | |
| This option is only used by Mac OS implementation of Git. | |
| When core.precomposeUnicode=true, Git reverts the unicode decomposition | |
| of filenames done by Mac OS. This is useful when sharing a repository | |
| between Mac OS and Linux or Windows. | |
| (Git for Windows 1.7.10 or higher is needed, or Git under cygwin 1.7). | |
| When false, file names are handled fully transparent by Git, | |
| which is backward compatible with older versions of Git. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| core.protectHFS | |
| </dt> | |
| <dd> | |
| <p> | |
| If set to true, do not allow checkout of paths that would | |
| be considered equivalent to <code>.git</code> on an HFS+ filesystem. | |
| Defaults to <code>true</code> on Mac OS, and <code>false</code> elsewhere. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| core.protectNTFS | |
| </dt> | |
| <dd> | |
| <p> | |
| If set to true, do not allow checkout of paths that would | |
| cause problems with the NTFS filesystem, e.g. conflict with | |
| 8.3 "short" names. | |
| Defaults to <code>true</code> on Windows, and <code>false</code> elsewhere. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| core.trustctime | |
| </dt> | |
| <dd> | |
| <p> | |
| If false, the ctime differences between the index and the | |
| working tree are ignored; useful when the inode change time | |
| is regularly modified by something outside Git (file system | |
| crawlers and some backup systems). | |
| See <a href="git-update-index.html">git-update-index(1)</a>. True by default. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| core.untrackedCache | |
| </dt> | |
| <dd> | |
| <p> | |
| Determines what to do about the untracked cache feature of the | |
| index. It will be kept, if this variable is unset or set to | |
| <code>keep</code>. It will automatically be added if set to <code>true</code>. And | |
| it will automatically be removed, if set to <code>false</code>. Before | |
| setting it to <code>true</code>, you should check that mtime is working | |
| properly on your system. | |
| See <a href="git-update-index.html">git-update-index(1)</a>. <code>keep</code> by default. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| core.checkStat | |
| </dt> | |
| <dd> | |
| <p> | |
| Determines which stat fields to match between the index | |
| and work tree. The user can set this to <em>default</em> or | |
| <em>minimal</em>. Default (or explicitly <em>default</em>), is to check | |
| all fields, including the sub-second part of mtime and ctime. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| core.quotePath | |
| </dt> | |
| <dd> | |
| <p> | |
| The commands that output paths (e.g. <em>ls-files</em>, | |
| <em>diff</em>), when not given the <code>-z</code> option, will quote | |
| "unusual" characters in the pathname by enclosing the | |
| pathname in a double-quote pair and with backslashes the | |
| same way strings in C source code are quoted. If this | |
| variable is set to false, the bytes higher than 0x80 are | |
| not quoted but output as verbatim. Note that double | |
| quote, backslash and control characters are always | |
| quoted without <code>-z</code> regardless of the setting of this | |
| variable. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| core.eol | |
| </dt> | |
| <dd> | |
| <p> | |
| Sets the line ending type to use in the working directory for | |
| files that have the <code>text</code> property set when core.autocrlf is false. | |
| Alternatives are <em>lf</em>, <em>crlf</em> and <em>native</em>, which uses the platform’s | |
| native line ending. The default value is <code>native</code>. See | |
| <a href="gitattributes.html">gitattributes(5)</a> for more information on end-of-line | |
| conversion. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| core.safecrlf | |
| </dt> | |
| <dd> | |
| <p> | |
| If true, makes Git check if converting <code>CRLF</code> is reversible when | |
| end-of-line conversion is active. Git will verify if a command | |
| modifies a file in the work tree either directly or indirectly. | |
| For example, committing a file followed by checking out the | |
| same file should yield the original file in the work tree. If | |
| this is not the case for the current setting of | |
| <code>core.autocrlf</code>, Git will reject the file. The variable can | |
| be set to "warn", in which case Git will only warn about an | |
| irreversible conversion but continue the operation. | |
| </p> | |
| <div class="paragraph"><p>CRLF conversion bears a slight chance of corrupting data. | |
| When it is enabled, Git will convert CRLF to LF during commit and LF to | |
| CRLF during checkout. A file that contains a mixture of LF and | |
| CRLF before the commit cannot be recreated by Git. For text | |
| files this is the right thing to do: it corrects line endings | |
| such that we have only LF line endings in the repository. | |
| But for binary files that are accidentally classified as text the | |
| conversion can corrupt data.</p></div> | |
| <div class="paragraph"><p>If you recognize such corruption early you can easily fix it by | |
| setting the conversion type explicitly in .gitattributes. Right | |
| after committing you still have the original file in your work | |
| tree and this file is not yet corrupted. You can explicitly tell | |
| Git that this file is binary and Git will handle the file | |
| appropriately.</p></div> | |
| <div class="paragraph"><p>Unfortunately, the desired effect of cleaning up text files with | |
| mixed line endings and the undesired effect of corrupting binary | |
| files cannot be distinguished. In both cases CRLFs are removed | |
| in an irreversible way. For text files this is the right thing | |
| to do because CRLFs are line endings, while for binary files | |
| converting CRLFs corrupts data.</p></div> | |
| <div class="paragraph"><p>Note, this safety check does not mean that a checkout will generate a | |
| file identical to the original file for a different setting of | |
| <code>core.eol</code> and <code>core.autocrlf</code>, but only for the current one. For | |
| example, a text file with <code>LF</code> would be accepted with <code>core.eol=lf</code> | |
| and could later be checked out with <code>core.eol=crlf</code>, in which case the | |
| resulting file would contain <code>CRLF</code>, although the original file | |
| contained <code>LF</code>. However, in both work trees the line endings would be | |
| consistent, that is either all <code>LF</code> or all <code>CRLF</code>, but never mixed. A | |
| file with mixed line endings would be reported by the <code>core.safecrlf</code> | |
| mechanism.</p></div> | |
| </dd> | |
| <dt class="hdlist1"> | |
| core.autocrlf | |
| </dt> | |
| <dd> | |
| <p> | |
| Setting this variable to "true" is the same as setting | |
| the <code>text</code> attribute to "auto" on all files and core.eol to "crlf". | |
| Set to true if you want to have <code>CRLF</code> line endings in your | |
| working directory and the repository has LF line endings. | |
| This variable can be set to <em>input</em>, | |
| in which case no output conversion is performed. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| core.symlinks | |
| </dt> | |
| <dd> | |
| <p> | |
| If false, symbolic links are checked out as small plain files that | |
| contain the link text. <a href="git-update-index.html">git-update-index(1)</a> and | |
| <a href="git-add.html">git-add(1)</a> will not change the recorded type to regular | |
| file. Useful on filesystems like FAT that do not support | |
| symbolic links. | |
| </p> | |
| <div class="paragraph"><p>The default is true, except <a href="git-clone.html">git-clone(1)</a> or <a href="git-init.html">git-init(1)</a> | |
| will probe and set core.symlinks false if appropriate when the repository | |
| is created.</p></div> | |
| </dd> | |
| <dt class="hdlist1"> | |
| core.gitProxy | |
| </dt> | |
| <dd> | |
| <p> | |
| A "proxy command" to execute (as <em>command host port</em>) instead | |
| of establishing direct connection to the remote server when | |
| using the Git protocol for fetching. If the variable value is | |
| in the "COMMAND for DOMAIN" format, the command is applied only | |
| on hostnames ending with the specified domain string. This variable | |
| may be set multiple times and is matched in the given order; | |
| the first match wins. | |
| </p> | |
| <div class="paragraph"><p>Can be overridden by the <code>GIT_PROXY_COMMAND</code> environment variable | |
| (which always applies universally, without the special "for" | |
| handling).</p></div> | |
| <div class="paragraph"><p>The special string <code>none</code> can be used as the proxy command to | |
| specify that no proxy be used for a given domain pattern. | |
| This is useful for excluding servers inside a firewall from | |
| proxy use, while defaulting to a common proxy for external domains.</p></div> | |
| </dd> | |
| <dt class="hdlist1"> | |
| core.sshCommand | |
| </dt> | |
| <dd> | |
| <p> | |
| If this variable is set, <code>git fetch</code> and <code>git push</code> will | |
| use the specified command instead of <code>ssh</code> when they need to | |
| connect to a remote system. The command is in the same form as | |
| the <code>GIT_SSH_COMMAND</code> environment variable and is overridden | |
| when the environment variable is set. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| core.ignoreStat | |
| </dt> | |
| <dd> | |
| <p> | |
| If true, Git will avoid using lstat() calls to detect if files have | |
| changed by setting the "assume-unchanged" bit for those tracked files | |
| which it has updated identically in both the index and working tree. | |
| </p> | |
| <div class="paragraph"><p>When files are modified outside of Git, the user will need to stage | |
| the modified files explicitly (e.g. see <em>Examples</em> section in | |
| <a href="git-update-index.html">git-update-index(1)</a>). | |
| Git will not normally detect changes to those files.</p></div> | |
| <div class="paragraph"><p>This is useful on systems where lstat() calls are very slow, such as | |
| CIFS/Microsoft Windows.</p></div> | |
| <div class="paragraph"><p>False by default.</p></div> | |
| </dd> | |
| <dt class="hdlist1"> | |
| core.preferSymlinkRefs | |
| </dt> | |
| <dd> | |
| <p> | |
| Instead of the default "symref" format for HEAD | |
| and other symbolic reference files, use symbolic links. | |
| This is sometimes needed to work with old scripts that | |
| expect HEAD to be a symbolic link. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| core.bare | |
| </dt> | |
| <dd> | |
| <p> | |
| If true this repository is assumed to be <em>bare</em> and has no | |
| working directory associated with it. If this is the case a | |
| number of commands that require a working directory will be | |
| disabled, such as <a href="git-add.html">git-add(1)</a> or <a href="git-merge.html">git-merge(1)</a>. | |
| </p> | |
| <div class="paragraph"><p>This setting is automatically guessed by <a href="git-clone.html">git-clone(1)</a> or | |
| <a href="git-init.html">git-init(1)</a> when the repository was created. By default a | |
| repository that ends in "/.git" is assumed to be not bare (bare = | |
| false), while all other repositories are assumed to be bare (bare | |
| = true).</p></div> | |
| </dd> | |
| <dt class="hdlist1"> | |
| core.worktree | |
| </dt> | |
| <dd> | |
| <p> | |
| Set the path to the root of the working tree. | |
| If <code>GIT_COMMON_DIR</code> environment variable is set, core.worktree | |
| is ignored and not used for determining the root of working tree. | |
| This can be overridden by the <code>GIT_WORK_TREE</code> environment | |
| variable and the <code>--work-tree</code> command-line option. | |
| The value can be an absolute path or relative to the path to | |
| the .git directory, which is either specified by --git-dir | |
| or GIT_DIR, or automatically discovered. | |
| If --git-dir or GIT_DIR is specified but none of | |
| --work-tree, GIT_WORK_TREE and core.worktree is specified, | |
| the current working directory is regarded as the top level | |
| of your working tree. | |
| </p> | |
| <div class="paragraph"><p>Note that this variable is honored even when set in a configuration | |
| file in a ".git" subdirectory of a directory and its value differs | |
| from the latter directory (e.g. "/path/to/.git/config" has | |
| core.worktree set to "/different/path"), which is most likely a | |
| misconfiguration. Running Git commands in the "/path/to" directory will | |
| still use "/different/path" as the root of the work tree and can cause | |
| confusion unless you know what you are doing (e.g. you are creating a | |
| read-only snapshot of the same index to a location different from the | |
| repository’s usual working tree).</p></div> | |
| </dd> | |
| <dt class="hdlist1"> | |
| core.logAllRefUpdates | |
| </dt> | |
| <dd> | |
| <p> | |
| Enable the reflog. Updates to a ref <ref> is logged to the file | |
| "<code>$GIT_DIR/logs/<ref></code>", by appending the new and old | |
| SHA-1, the date/time and the reason of the update, but | |
| only when the file exists. If this configuration | |
| variable is set to true, missing "<code>$GIT_DIR/logs/<ref></code>" | |
| file is automatically created for branch heads (i.e. under | |
| refs/heads/), remote refs (i.e. under refs/remotes/), | |
| note refs (i.e. under refs/notes/), and the symbolic ref HEAD. | |
| </p> | |
| <div class="paragraph"><p>This information can be used to determine what commit | |
| was the tip of a branch "2 days ago".</p></div> | |
| <div class="paragraph"><p>This value is true by default in a repository that has | |
| a working directory associated with it, and false by | |
| default in a bare repository.</p></div> | |
| </dd> | |
| <dt class="hdlist1"> | |
| core.repositoryFormatVersion | |
| </dt> | |
| <dd> | |
| <p> | |
| Internal variable identifying the repository format and layout | |
| version. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| core.sharedRepository | |
| </dt> | |
| <dd> | |
| <p> | |
| When <em>group</em> (or <em>true</em>), the repository is made shareable between | |
| several users in a group (making sure all the files and objects are | |
| group-writable). When <em>all</em> (or <em>world</em> or <em>everybody</em>), the | |
| repository will be readable by all users, additionally to being | |
| group-shareable. When <em>umask</em> (or <em>false</em>), Git will use permissions | |
| reported by umask(2). When <em>0xxx</em>, where <em>0xxx</em> is an octal number, | |
| files in the repository will have this mode value. <em>0xxx</em> will override | |
| user’s umask value (whereas the other options will only override | |
| requested parts of the user’s umask value). Examples: <em>0660</em> will make | |
| the repo read/write-able for the owner and group, but inaccessible to | |
| others (equivalent to <em>group</em> unless umask is e.g. <em>0022</em>). <em>0640</em> is a | |
| repository that is group-readable but not group-writable. | |
| See <a href="git-init.html">git-init(1)</a>. False by default. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| core.warnAmbiguousRefs | |
| </dt> | |
| <dd> | |
| <p> | |
| If true, Git will warn you if the ref name you passed it is ambiguous | |
| and might match multiple refs in the repository. True by default. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| core.compression | |
| </dt> | |
| <dd> | |
| <p> | |
| An integer -1..9, indicating a default compression level. | |
| -1 is the zlib default. 0 means no compression, | |
| and 1..9 are various speed/size tradeoffs, 9 being slowest. | |
| If set, this provides a default to other compression variables, | |
| such as <code>core.looseCompression</code> and <code>pack.compression</code>. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| core.looseCompression | |
| </dt> | |
| <dd> | |
| <p> | |
| An integer -1..9, indicating the compression level for objects that | |
| are not in a pack file. -1 is the zlib default. 0 means no | |
| compression, and 1..9 are various speed/size tradeoffs, 9 being | |
| slowest. If not set, defaults to core.compression. If that is | |
| not set, defaults to 1 (best speed). | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| core.packedGitWindowSize | |
| </dt> | |
| <dd> | |
| <p> | |
| Number of bytes of a pack file to map into memory in a | |
| single mapping operation. Larger window sizes may allow | |
| your system to process a smaller number of large pack files | |
| more quickly. Smaller window sizes will negatively affect | |
| performance due to increased calls to the operating system’s | |
| memory manager, but may improve performance when accessing | |
| a large number of large pack files. | |
| </p> | |
| <div class="paragraph"><p>Default is 1 MiB if NO_MMAP was set at compile time, otherwise 32 | |
| MiB on 32 bit platforms and 1 GiB on 64 bit platforms. This should | |
| be reasonable for all users/operating systems. You probably do | |
| not need to adjust this value.</p></div> | |
| <div class="paragraph"><p>Common unit suffixes of <em>k</em>, <em>m</em>, or <em>g</em> are supported.</p></div> | |
| </dd> | |
| <dt class="hdlist1"> | |
| core.packedGitLimit | |
| </dt> | |
| <dd> | |
| <p> | |
| Maximum number of bytes to map simultaneously into memory | |
| from pack files. If Git needs to access more than this many | |
| bytes at once to complete an operation it will unmap existing | |
| regions to reclaim virtual address space within the process. | |
| </p> | |
| <div class="paragraph"><p>Default is 256 MiB on 32 bit platforms and 8 GiB on 64 bit platforms. | |
| This should be reasonable for all users/operating systems, except on | |
| the largest projects. You probably do not need to adjust this value.</p></div> | |
| <div class="paragraph"><p>Common unit suffixes of <em>k</em>, <em>m</em>, or <em>g</em> are supported.</p></div> | |
| </dd> | |
| <dt class="hdlist1"> | |
| core.deltaBaseCacheLimit | |
| </dt> | |
| <dd> | |
| <p> | |
| Maximum number of bytes to reserve for caching base objects | |
| that may be referenced by multiple deltified objects. By storing the | |
| entire decompressed base objects in a cache Git is able | |
| to avoid unpacking and decompressing frequently used base | |
| objects multiple times. | |
| </p> | |
| <div class="paragraph"><p>Default is 96 MiB on all platforms. This should be reasonable | |
| for all users/operating systems, except on the largest projects. | |
| You probably do not need to adjust this value.</p></div> | |
| <div class="paragraph"><p>Common unit suffixes of <em>k</em>, <em>m</em>, or <em>g</em> are supported.</p></div> | |
| </dd> | |
| <dt class="hdlist1"> | |
| core.bigFileThreshold | |
| </dt> | |
| <dd> | |
| <p> | |
| Files larger than this size are stored deflated, without | |
| attempting delta compression. Storing large files without | |
| delta compression avoids excessive memory usage, at the | |
| slight expense of increased disk usage. Additionally files | |
| larger than this size are always treated as binary. | |
| </p> | |
| <div class="paragraph"><p>Default is 512 MiB on all platforms. This should be reasonable | |
| for most projects as source code and other text files can still | |
| be delta compressed, but larger binary media files won’t be.</p></div> | |
| <div class="paragraph"><p>Common unit suffixes of <em>k</em>, <em>m</em>, or <em>g</em> are supported.</p></div> | |
| </dd> | |
| <dt class="hdlist1"> | |
| core.excludesFile | |
| </dt> | |
| <dd> | |
| <p> | |
| Specifies the pathname to the file that contains patterns to | |
| describe paths that are not meant to be tracked, in addition | |
| to <em>.gitignore</em> (per-directory) and <em>.git/info/exclude</em>. | |
| Defaults to <code>$XDG_CONFIG_HOME/git/ignore</code>. | |
| If <code>$XDG_CONFIG_HOME</code> is either not set or empty, <code>$HOME/.config/git/ignore</code> | |
| is used instead. See <a href="gitignore.html">gitignore(5)</a>. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| core.askPass | |
| </dt> | |
| <dd> | |
| <p> | |
| Some commands (e.g. svn and http interfaces) that interactively | |
| ask for a password can be told to use an external program given | |
| via the value of this variable. Can be overridden by the <code>GIT_ASKPASS</code> | |
| environment variable. If not set, fall back to the value of the | |
| <code>SSH_ASKPASS</code> environment variable or, failing that, a simple password | |
| prompt. The external program shall be given a suitable prompt as | |
| command-line argument and write the password on its STDOUT. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| core.attributesFile | |
| </dt> | |
| <dd> | |
| <p> | |
| In addition to <em>.gitattributes</em> (per-directory) and | |
| <em>.git/info/attributes</em>, Git looks into this file for attributes | |
| (see <a href="gitattributes.html">gitattributes(5)</a>). Path expansions are made the same | |
| way as for <code>core.excludesFile</code>. Its default value is | |
| <code>$XDG_CONFIG_HOME/git/attributes</code>. If <code>$XDG_CONFIG_HOME</code> is either not | |
| set or empty, <code>$HOME/.config/git/attributes</code> is used instead. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| core.hooksPath | |
| </dt> | |
| <dd> | |
| <p> | |
| By default Git will look for your hooks in the | |
| <em>$GIT_DIR/hooks</em> directory. Set this to different path, | |
| e.g. <em>/etc/git/hooks</em>, and Git will try to find your hooks in | |
| that directory, e.g. <em>/etc/git/hooks/pre-receive</em> instead of | |
| in <em>$GIT_DIR/hooks/pre-receive</em>. | |
| </p> | |
| <div class="paragraph"><p>The path can be either absolute or relative. A relative path is | |
| taken as relative to the directory where the hooks are run (see | |
| the "DESCRIPTION" section of <a href="githooks.html">githooks(5)</a>).</p></div> | |
| <div class="paragraph"><p>This configuration variable is useful in cases where you’d like to | |
| centrally configure your Git hooks instead of configuring them on a | |
| per-repository basis, or as a more flexible and centralized | |
| alternative to having an <code>init.templateDir</code> where you’ve changed | |
| default hooks.</p></div> | |
| </dd> | |
| <dt class="hdlist1"> | |
| core.editor | |
| </dt> | |
| <dd> | |
| <p> | |
| Commands such as <code>commit</code> and <code>tag</code> that lets you edit | |
| messages by launching an editor uses the value of this | |
| variable when it is set, and the environment variable | |
| <code>GIT_EDITOR</code> is not set. See <a href="git-var.html">git-var(1)</a>. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| core.commentChar | |
| </dt> | |
| <dd> | |
| <p> | |
| Commands such as <code>commit</code> and <code>tag</code> that lets you edit | |
| messages consider a line that begins with this character | |
| commented, and removes them after the editor returns | |
| (default <em>#</em>). | |
| </p> | |
| <div class="paragraph"><p>If set to "auto", <code>git-commit</code> would select a character that is not | |
| the beginning character of any line in existing commit messages.</p></div> | |
| </dd> | |
| <dt class="hdlist1"> | |
| core.packedRefsTimeout | |
| </dt> | |
| <dd> | |
| <p> | |
| The length of time, in milliseconds, to retry when trying to | |
| lock the <code>packed-refs</code> file. Value 0 means not to retry at | |
| all; -1 means to try indefinitely. Default is 1000 (i.e., | |
| retry for 1 second). | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| sequence.editor | |
| </dt> | |
| <dd> | |
| <p> | |
| Text editor used by <code>git rebase -i</code> for editing the rebase instruction file. | |
| The value is meant to be interpreted by the shell when it is used. | |
| It can be overridden by the <code>GIT_SEQUENCE_EDITOR</code> environment variable. | |
| When not configured the default commit message editor is used instead. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| core.pager | |
| </dt> | |
| <dd> | |
| <p> | |
| Text viewer for use by Git commands (e.g., <em>less</em>). The value | |
| is meant to be interpreted by the shell. The order of preference | |
| is the <code>$GIT_PAGER</code> environment variable, then <code>core.pager</code> | |
| configuration, then <code>$PAGER</code>, and then the default chosen at | |
| compile time (usually <em>less</em>). | |
| </p> | |
| <div class="paragraph"><p>When the <code>LESS</code> environment variable is unset, Git sets it to <code>FRX</code> | |
| (if <code>LESS</code> environment variable is set, Git does not change it at | |
| all). If you want to selectively override Git’s default setting | |
| for <code>LESS</code>, you can set <code>core.pager</code> to e.g. <code>less -S</code>. This will | |
| be passed to the shell by Git, which will translate the final | |
| command to <code>LESS=FRX less -S</code>. The environment does not set the | |
| <code>S</code> option but the command line does, instructing less to truncate | |
| long lines. Similarly, setting <code>core.pager</code> to <code>less -+F</code> will | |
| deactivate the <code>F</code> option specified by the environment from the | |
| command-line, deactivating the "quit if one screen" behavior of | |
| <code>less</code>. One can specifically activate some flags for particular | |
| commands: for example, setting <code>pager.blame</code> to <code>less -S</code> enables | |
| line truncation only for <code>git blame</code>.</p></div> | |
| <div class="paragraph"><p>Likewise, when the <code>LV</code> environment variable is unset, Git sets it | |
| to <code>-c</code>. You can override this setting by exporting <code>LV</code> with | |
| another value or setting <code>core.pager</code> to <code>lv +c</code>.</p></div> | |
| </dd> | |
| <dt class="hdlist1"> | |
| core.whitespace | |
| </dt> | |
| <dd> | |
| <p> | |
| A comma separated list of common whitespace problems to | |
| notice. <em>git diff</em> will use <code>color.diff.whitespace</code> to | |
| highlight them, and <em>git apply --whitespace=error</em> will | |
| consider them as errors. You can prefix <code>-</code> to disable | |
| any of them (e.g. <code>-trailing-space</code>): | |
| </p> | |
| <div class="ulist"><ul> | |
| <li> | |
| <p> | |
| <code>blank-at-eol</code> treats trailing whitespaces at the end of the line | |
| as an error (enabled by default). | |
| </p> | |
| </li> | |
| <li> | |
| <p> | |
| <code>space-before-tab</code> treats a space character that appears immediately | |
| before a tab character in the initial indent part of the line as an | |
| error (enabled by default). | |
| </p> | |
| </li> | |
| <li> | |
| <p> | |
| <code>indent-with-non-tab</code> treats a line that is indented with space | |
| characters instead of the equivalent tabs as an error (not enabled by | |
| default). | |
| </p> | |
| </li> | |
| <li> | |
| <p> | |
| <code>tab-in-indent</code> treats a tab character in the initial indent part of | |
| the line as an error (not enabled by default). | |
| </p> | |
| </li> | |
| <li> | |
| <p> | |
| <code>blank-at-eof</code> treats blank lines added at the end of file as an error | |
| (enabled by default). | |
| </p> | |
| </li> | |
| <li> | |
| <p> | |
| <code>trailing-space</code> is a short-hand to cover both <code>blank-at-eol</code> and | |
| <code>blank-at-eof</code>. | |
| </p> | |
| </li> | |
| <li> | |
| <p> | |
| <code>cr-at-eol</code> treats a carriage-return at the end of line as | |
| part of the line terminator, i.e. with it, <code>trailing-space</code> | |
| does not trigger if the character before such a carriage-return | |
| is not a whitespace (not enabled by default). | |
| </p> | |
| </li> | |
| <li> | |
| <p> | |
| <code>tabwidth=<n></code> tells how many character positions a tab occupies; this | |
| is relevant for <code>indent-with-non-tab</code> and when Git fixes <code>tab-in-indent</code> | |
| errors. The default tab width is 8. Allowed values are 1 to 63. | |
| </p> | |
| </li> | |
| </ul></div> | |
| </dd> | |
| <dt class="hdlist1"> | |
| core.fsyncObjectFiles | |
| </dt> | |
| <dd> | |
| <p> | |
| This boolean will enable <em>fsync()</em> when writing object files. | |
| </p> | |
| <div class="paragraph"><p>This is a total waste of time and effort on a filesystem that orders | |
| data writes properly, but can be useful for filesystems that do not use | |
| journalling (traditional UNIX filesystems) or that only journal metadata | |
| and not file contents (OS X’s HFS+, or Linux ext3 with "data=writeback").</p></div> | |
| </dd> | |
| <dt class="hdlist1"> | |
| core.preloadIndex | |
| </dt> | |
| <dd> | |
| <p> | |
| Enable parallel index preload for operations like <em>git diff</em> | |
| </p> | |
| <div class="paragraph"><p>This can speed up operations like <em>git diff</em> and <em>git status</em> especially | |
| on filesystems like NFS that have weak caching semantics and thus | |
| relatively high IO latencies. When enabled, Git will do the | |
| index comparison to the filesystem data in parallel, allowing | |
| overlapping IO’s. Defaults to true.</p></div> | |
| </dd> | |
| <dt class="hdlist1"> | |
| core.createObject | |
| </dt> | |
| <dd> | |
| <p> | |
| You can set this to <em>link</em>, in which case a hardlink followed by | |
| a delete of the source are used to make sure that object creation | |
| will not overwrite existing objects. | |
| </p> | |
| <div class="paragraph"><p>On some file system/operating system combinations, this is unreliable. | |
| Set this config setting to <em>rename</em> there; However, This will remove the | |
| check that makes sure that existing object files will not get overwritten.</p></div> | |
| </dd> | |
| <dt class="hdlist1"> | |
| core.notesRef | |
| </dt> | |
| <dd> | |
| <p> | |
| When showing commit messages, also show notes which are stored in | |
| the given ref. The ref must be fully qualified. If the given | |
| ref does not exist, it is not an error but means that no | |
| notes should be printed. | |
| </p> | |
| <div class="paragraph"><p>This setting defaults to "refs/notes/commits", and it can be overridden by | |
| the <code>GIT_NOTES_REF</code> environment variable. See <a href="git-notes.html">git-notes(1)</a>.</p></div> | |
| </dd> | |
| <dt class="hdlist1"> | |
| core.sparseCheckout | |
| </dt> | |
| <dd> | |
| <p> | |
| Enable "sparse checkout" feature. See section "Sparse checkout" in | |
| <a href="git-read-tree.html">git-read-tree(1)</a> for more information. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| core.abbrev | |
| </dt> | |
| <dd> | |
| <p> | |
| Set the length object names are abbreviated to. If unspecified, | |
| many commands abbreviate to 7 hexdigits, which may not be enough | |
| for abbreviated object names to stay unique for sufficiently long | |
| time. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| add.ignoreErrors | |
| </dt> | |
| <dt class="hdlist1"> | |
| add.ignore-errors (deprecated) | |
| </dt> | |
| <dd> | |
| <p> | |
| Tells <em>git add</em> to continue adding files when some files cannot be | |
| added due to indexing errors. Equivalent to the <code>--ignore-errors</code> | |
| option of <a href="git-add.html">git-add(1)</a>. <code>add.ignore-errors</code> is deprecated, | |
| as it does not follow the usual naming convention for configuration | |
| variables. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| alias.* | |
| </dt> | |
| <dd> | |
| <p> | |
| Command aliases for the <a href="git.html">git(1)</a> command wrapper - e.g. | |
| after defining "alias.last = cat-file commit HEAD", the invocation | |
| "git last" is equivalent to "git cat-file commit HEAD". To avoid | |
| confusion and troubles with script usage, aliases that | |
| hide existing Git commands are ignored. Arguments are split by | |
| spaces, the usual shell quoting and escaping is supported. | |
| A quote pair or a backslash can be used to quote them. | |
| </p> | |
| <div class="paragraph"><p>If the alias expansion is prefixed with an exclamation point, | |
| it will be treated as a shell command. For example, defining | |
| "alias.new = !gitk --all --not ORIG_HEAD", the invocation | |
| "git new" is equivalent to running the shell command | |
| "gitk --all --not ORIG_HEAD". Note that shell commands will be | |
| executed from the top-level directory of a repository, which may | |
| not necessarily be the current directory. | |
| <code>GIT_PREFIX</code> is set as returned by running <em>git rev-parse --show-prefix</em> | |
| from the original current directory. See <a href="git-rev-parse.html">git-rev-parse(1)</a>.</p></div> | |
| </dd> | |
| <dt class="hdlist1"> | |
| am.keepcr | |
| </dt> | |
| <dd> | |
| <p> | |
| If true, git-am will call git-mailsplit for patches in mbox format | |
| with parameter <code>--keep-cr</code>. In this case git-mailsplit will | |
| not remove <code>\r</code> from lines ending with <code>\r\n</code>. Can be overridden | |
| by giving <code>--no-keep-cr</code> from the command line. | |
| See <a href="git-am.html">git-am(1)</a>, <a href="git-mailsplit.html">git-mailsplit(1)</a>. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| am.threeWay | |
| </dt> | |
| <dd> | |
| <p> | |
| By default, <code>git am</code> will fail if the patch does not apply cleanly. When | |
| set to true, this setting tells <code>git am</code> to fall back on 3-way merge if | |
| the patch records the identity of blobs it is supposed to apply to and | |
| we have those blobs available locally (equivalent to giving the <code>--3way</code> | |
| option from the command line). Defaults to <code>false</code>. | |
| See <a href="git-am.html">git-am(1)</a>. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| apply.ignoreWhitespace | |
| </dt> | |
| <dd> | |
| <p> | |
| When set to <em>change</em>, tells <em>git apply</em> to ignore changes in | |
| whitespace, in the same way as the <code>--ignore-space-change</code> | |
| option. | |
| When set to one of: no, none, never, false tells <em>git apply</em> to | |
| respect all whitespace differences. | |
| See <a href="git-apply.html">git-apply(1)</a>. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| apply.whitespace | |
| </dt> | |
| <dd> | |
| <p> | |
| Tells <em>git apply</em> how to handle whitespaces, in the same way | |
| as the <code>--whitespace</code> option. See <a href="git-apply.html">git-apply(1)</a>. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| branch.autoSetupMerge | |
| </dt> | |
| <dd> | |
| <p> | |
| Tells <em>git branch</em> and <em>git checkout</em> to set up new branches | |
| so that <a href="git-pull.html">git-pull(1)</a> will appropriately merge from the | |
| starting point branch. Note that even if this option is not set, | |
| this behavior can be chosen per-branch using the <code>--track</code> | |
| and <code>--no-track</code> options. The valid settings are: <code>false</code> — no | |
| automatic setup is done; <code>true</code> — automatic setup is done when the | |
| starting point is a remote-tracking branch; <code>always</code> —  automatic setup is done when the starting point is either a | |
| local branch or remote-tracking | |
| branch. This option defaults to true. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| branch.autoSetupRebase | |
| </dt> | |
| <dd> | |
| <p> | |
| When a new branch is created with <em>git branch</em> or <em>git checkout</em> | |
| that tracks another branch, this variable tells Git to set | |
| up pull to rebase instead of merge (see "branch.<name>.rebase"). | |
| When <code>never</code>, rebase is never automatically set to true. | |
| When <code>local</code>, rebase is set to true for tracked branches of | |
| other local branches. | |
| When <code>remote</code>, rebase is set to true for tracked branches of | |
| remote-tracking branches. | |
| When <code>always</code>, rebase will be set to true for all tracking | |
| branches. | |
| See "branch.autoSetupMerge" for details on how to set up a | |
| branch to track another branch. | |
| This option defaults to never. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| branch.<name>.remote | |
| </dt> | |
| <dd> | |
| <p> | |
| When on branch <name>, it tells <em>git fetch</em> and <em>git push</em> | |
| which remote to fetch from/push to. The remote to push to | |
| may be overridden with <code>remote.pushDefault</code> (for all branches). | |
| The remote to push to, for the current branch, may be further | |
| overridden by <code>branch.<name>.pushRemote</code>. If no remote is | |
| configured, or if you are not on any branch, it defaults to | |
| <code>origin</code> for fetching and <code>remote.pushDefault</code> for pushing. | |
| Additionally, <code>.</code> (a period) is the current local repository | |
| (a dot-repository), see <code>branch.<name>.merge</code>'s final note below. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| branch.<name>.pushRemote | |
| </dt> | |
| <dd> | |
| <p> | |
| When on branch <name>, it overrides <code>branch.<name>.remote</code> for | |
| pushing. It also overrides <code>remote.pushDefault</code> for pushing | |
| from branch <name>. When you pull from one place (e.g. your | |
| upstream) and push to another place (e.g. your own publishing | |
| repository), you would want to set <code>remote.pushDefault</code> to | |
| specify the remote to push to for all branches, and use this | |
| option to override it for a specific branch. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| branch.<name>.merge | |
| </dt> | |
| <dd> | |
| <p> | |
| Defines, together with branch.<name>.remote, the upstream branch | |
| for the given branch. It tells <em>git fetch</em>/<em>git pull</em>/<em>git rebase</em> which | |
| branch to merge and can also affect <em>git push</em> (see push.default). | |
| When in branch <name>, it tells <em>git fetch</em> the default | |
| refspec to be marked for merging in FETCH_HEAD. The value is | |
| handled like the remote part of a refspec, and must match a | |
| ref which is fetched from the remote given by | |
| "branch.<name>.remote". | |
| The merge information is used by <em>git pull</em> (which at first calls | |
| <em>git fetch</em>) to lookup the default branch for merging. Without | |
| this option, <em>git pull</em> defaults to merge the first refspec fetched. | |
| Specify multiple values to get an octopus merge. | |
| If you wish to setup <em>git pull</em> so that it merges into <name> from | |
| another branch in the local repository, you can point | |
| branch.<name>.merge to the desired branch, and use the relative path | |
| setting <code>.</code> (a period) for branch.<name>.remote. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| branch.<name>.mergeOptions | |
| </dt> | |
| <dd> | |
| <p> | |
| Sets default options for merging into branch <name>. The syntax and | |
| supported options are the same as those of <a href="git-merge.html">git-merge(1)</a>, but | |
| option values containing whitespace characters are currently not | |
| supported. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| branch.<name>.rebase | |
| </dt> | |
| <dd> | |
| <p> | |
| When true, rebase the branch <name> on top of the fetched branch, | |
| instead of merging the default branch from the default remote when | |
| "git pull" is run. See "pull.rebase" for doing this in a non | |
| branch-specific manner. | |
| </p> | |
| <div class="paragraph"><p>When preserve, also pass <code>--preserve-merges</code> along to <em>git rebase</em> | |
| so that locally committed merge commits will not be flattened | |
| by running <em>git pull</em>.</p></div> | |
| <div class="paragraph"><p>When the value is <code>interactive</code>, the rebase is run in interactive mode.</p></div> | |
| <div class="paragraph"><p><strong>NOTE</strong>: this is a possibly dangerous operation; do <strong>not</strong> use | |
| it unless you understand the implications (see <a href="git-rebase.html">git-rebase(1)</a> | |
| for details).</p></div> | |
| </dd> | |
| <dt class="hdlist1"> | |
| branch.<name>.description | |
| </dt> | |
| <dd> | |
| <p> | |
| Branch description, can be edited with | |
| <code>git branch --edit-description</code>. Branch description is | |
| automatically added in the format-patch cover letter or | |
| request-pull summary. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| browser.<tool>.cmd | |
| </dt> | |
| <dd> | |
| <p> | |
| Specify the command to invoke the specified browser. The | |
| specified command is evaluated in shell with the URLs passed | |
| as arguments. (See <a href="git-web--browse.html">git-web--browse(1)</a>.) | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| browser.<tool>.path | |
| </dt> | |
| <dd> | |
| <p> | |
| Override the path for the given tool that may be used to | |
| browse HTML help (see <code>-w</code> option in <a href="git-help.html">git-help(1)</a>) or a | |
| working repository in gitweb (see <a href="git-instaweb.html">git-instaweb(1)</a>). | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| clean.requireForce | |
| </dt> | |
| <dd> | |
| <p> | |
| A boolean to make git-clean do nothing unless given -f, | |
| -i or -n. Defaults to true. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| color.branch | |
| </dt> | |
| <dd> | |
| <p> | |
| A boolean to enable/disable color in the output of | |
| <a href="git-branch.html">git-branch(1)</a>. May be set to <code>always</code>, | |
| <code>false</code> (or <code>never</code>) or <code>auto</code> (or <code>true</code>), in which case colors are used | |
| only when the output is to a terminal. Defaults to false. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| color.branch.<slot> | |
| </dt> | |
| <dd> | |
| <p> | |
| Use customized color for branch coloration. <code><slot></code> is one of | |
| <code>current</code> (the current branch), <code>local</code> (a local branch), | |
| <code>remote</code> (a remote-tracking branch in refs/remotes/), | |
| <code>upstream</code> (upstream tracking branch), <code>plain</code> (other | |
| refs). | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| color.diff | |
| </dt> | |
| <dd> | |
| <p> | |
| Whether to use ANSI escape sequences to add color to patches. | |
| If this is set to <code>always</code>, <a href="git-diff.html">git-diff(1)</a>, | |
| <a href="git-log.html">git-log(1)</a>, and <a href="git-show.html">git-show(1)</a> will use color | |
| for all patches. If it is set to <code>true</code> or <code>auto</code>, those | |
| commands will only use color when output is to the terminal. | |
| Defaults to false. | |
| </p> | |
| <div class="paragraph"><p>This does not affect <a href="git-format-patch.html">git-format-patch(1)</a> or the | |
| <em>git-diff-*</em> plumbing commands. Can be overridden on the | |
| command line with the <code>--color[=<when>]</code> option.</p></div> | |
| </dd> | |
| <dt class="hdlist1"> | |
| color.diff.<slot> | |
| </dt> | |
| <dd> | |
| <p> | |
| Use customized color for diff colorization. <code><slot></code> specifies | |
| which part of the patch to use the specified color, and is one | |
| of <code>context</code> (context text - <code>plain</code> is a historical synonym), | |
| <code>meta</code> (metainformation), <code>frag</code> | |
| (hunk header), <em>func</em> (function in hunk header), <code>old</code> (removed lines), | |
| <code>new</code> (added lines), <code>commit</code> (commit headers), or <code>whitespace</code> | |
| (highlighting whitespace errors). | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| color.decorate.<slot> | |
| </dt> | |
| <dd> | |
| <p> | |
| Use customized color for <em>git log --decorate</em> output. <code><slot></code> is one | |
| of <code>branch</code>, <code>remoteBranch</code>, <code>tag</code>, <code>stash</code> or <code>HEAD</code> for local | |
| branches, remote-tracking branches, tags, stash and HEAD, respectively. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| color.grep | |
| </dt> | |
| <dd> | |
| <p> | |
| When set to <code>always</code>, always highlight matches. When <code>false</code> (or | |
| <code>never</code>), never. When set to <code>true</code> or <code>auto</code>, use color only | |
| when the output is written to the terminal. Defaults to <code>false</code>. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| color.grep.<slot> | |
| </dt> | |
| <dd> | |
| <p> | |
| Use customized color for grep colorization. <code><slot></code> specifies which | |
| part of the line to use the specified color, and is one of | |
| </p> | |
| <div class="openblock"> | |
| <div class="content"> | |
| <div class="dlist"><dl> | |
| <dt class="hdlist1"> | |
| <code>context</code> | |
| </dt> | |
| <dd> | |
| <p> | |
| non-matching text in context lines (when using <code>-A</code>, <code>-B</code>, or <code>-C</code>) | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| <code>filename</code> | |
| </dt> | |
| <dd> | |
| <p> | |
| filename prefix (when not using <code>-h</code>) | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| <code>function</code> | |
| </dt> | |
| <dd> | |
| <p> | |
| function name lines (when using <code>-p</code>) | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| <code>linenumber</code> | |
| </dt> | |
| <dd> | |
| <p> | |
| line number prefix (when using <code>-n</code>) | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| <code>match</code> | |
| </dt> | |
| <dd> | |
| <p> | |
| matching text (same as setting <code>matchContext</code> and <code>matchSelected</code>) | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| <code>matchContext</code> | |
| </dt> | |
| <dd> | |
| <p> | |
| matching text in context lines | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| <code>matchSelected</code> | |
| </dt> | |
| <dd> | |
| <p> | |
| matching text in selected lines | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| <code>selected</code> | |
| </dt> | |
| <dd> | |
| <p> | |
| non-matching text in selected lines | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| <code>separator</code> | |
| </dt> | |
| <dd> | |
| <p> | |
| separators between fields on a line (<code>:</code>, <code>-</code>, and <code>=</code>) | |
| and between hunks (<code>--</code>) | |
| </p> | |
| </dd> | |
| </dl></div> | |
| </div></div> | |
| </dd> | |
| <dt class="hdlist1"> | |
| color.interactive | |
| </dt> | |
| <dd> | |
| <p> | |
| When set to <code>always</code>, always use colors for interactive prompts | |
| and displays (such as those used by "git-add --interactive" and | |
| "git-clean --interactive"). When false (or <code>never</code>), never. | |
| When set to <code>true</code> or <code>auto</code>, use colors only when the output is | |
| to the terminal. Defaults to false. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| color.interactive.<slot> | |
| </dt> | |
| <dd> | |
| <p> | |
| Use customized color for <em>git add --interactive</em> and <em>git clean | |
| --interactive</em> output. <code><slot></code> may be <code>prompt</code>, <code>header</code>, <code>help</code> | |
| or <code>error</code>, for four distinct types of normal output from | |
| interactive commands. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| color.pager | |
| </dt> | |
| <dd> | |
| <p> | |
| A boolean to enable/disable colored output when the pager is in | |
| use (default is true). | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| color.showBranch | |
| </dt> | |
| <dd> | |
| <p> | |
| A boolean to enable/disable color in the output of | |
| <a href="git-show-branch.html">git-show-branch(1)</a>. May be set to <code>always</code>, | |
| <code>false</code> (or <code>never</code>) or <code>auto</code> (or <code>true</code>), in which case colors are used | |
| only when the output is to a terminal. Defaults to false. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| color.status | |
| </dt> | |
| <dd> | |
| <p> | |
| A boolean to enable/disable color in the output of | |
| <a href="git-status.html">git-status(1)</a>. May be set to <code>always</code>, | |
| <code>false</code> (or <code>never</code>) or <code>auto</code> (or <code>true</code>), in which case colors are used | |
| only when the output is to a terminal. Defaults to false. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| color.status.<slot> | |
| </dt> | |
| <dd> | |
| <p> | |
| Use customized color for status colorization. <code><slot></code> is | |
| one of <code>header</code> (the header text of the status message), | |
| <code>added</code> or <code>updated</code> (files which are added but not committed), | |
| <code>changed</code> (files which are changed but not added in the index), | |
| <code>untracked</code> (files which are not tracked by Git), | |
| <code>branch</code> (the current branch), | |
| <code>nobranch</code> (the color the <em>no branch</em> warning is shown in, defaulting | |
| to red), or | |
| <code>unmerged</code> (files which have unmerged changes). | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| color.ui | |
| </dt> | |
| <dd> | |
| <p> | |
| This variable determines the default value for variables such | |
| as <code>color.diff</code> and <code>color.grep</code> that control the use of color | |
| per command family. Its scope will expand as more commands learn | |
| configuration to set a default for the <code>--color</code> option. Set it | |
| to <code>false</code> or <code>never</code> if you prefer Git commands not to use | |
| color unless enabled explicitly with some other configuration | |
| or the <code>--color</code> option. Set it to <code>always</code> if you want all | |
| output not intended for machine consumption to use color, to | |
| <code>true</code> or <code>auto</code> (this is the default since Git 1.8.4) if you | |
| want such output to use color when written to the terminal. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| column.ui | |
| </dt> | |
| <dd> | |
| <p> | |
| Specify whether supported commands should output in columns. | |
| This variable consists of a list of tokens separated by spaces | |
| or commas: | |
| </p> | |
| <div class="paragraph"><p>These options control when the feature should be enabled | |
| (defaults to <em>never</em>):</p></div> | |
| <div class="openblock"> | |
| <div class="content"> | |
| <div class="dlist"><dl> | |
| <dt class="hdlist1"> | |
| <code>always</code> | |
| </dt> | |
| <dd> | |
| <p> | |
| always show in columns | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| <code>never</code> | |
| </dt> | |
| <dd> | |
| <p> | |
| never show in columns | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| <code>auto</code> | |
| </dt> | |
| <dd> | |
| <p> | |
| show in columns if the output is to the terminal | |
| </p> | |
| </dd> | |
| </dl></div> | |
| </div></div> | |
| <div class="paragraph"><p>These options control layout (defaults to <em>column</em>). Setting any | |
| of these implies <em>always</em> if none of <em>always</em>, <em>never</em>, or <em>auto</em> are | |
| specified.</p></div> | |
| <div class="openblock"> | |
| <div class="content"> | |
| <div class="dlist"><dl> | |
| <dt class="hdlist1"> | |
| <code>column</code> | |
| </dt> | |
| <dd> | |
| <p> | |
| fill columns before rows | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| <code>row</code> | |
| </dt> | |
| <dd> | |
| <p> | |
| fill rows before columns | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| <code>plain</code> | |
| </dt> | |
| <dd> | |
| <p> | |
| show in one column | |
| </p> | |
| </dd> | |
| </dl></div> | |
| </div></div> | |
| <div class="paragraph"><p>Finally, these options can be combined with a layout option (defaults | |
| to <em>nodense</em>):</p></div> | |
| <div class="openblock"> | |
| <div class="content"> | |
| <div class="dlist"><dl> | |
| <dt class="hdlist1"> | |
| <code>dense</code> | |
| </dt> | |
| <dd> | |
| <p> | |
| make unequal size columns to utilize more space | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| <code>nodense</code> | |
| </dt> | |
| <dd> | |
| <p> | |
| make equal size columns | |
| </p> | |
| </dd> | |
| </dl></div> | |
| </div></div> | |
| </dd> | |
| <dt class="hdlist1"> | |
| column.branch | |
| </dt> | |
| <dd> | |
| <p> | |
| Specify whether to output branch listing in <code>git branch</code> in columns. | |
| See <code>column.ui</code> for details. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| column.clean | |
| </dt> | |
| <dd> | |
| <p> | |
| Specify the layout when list items in <code>git clean -i</code>, which always | |
| shows files and directories in columns. See <code>column.ui</code> for details. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| column.status | |
| </dt> | |
| <dd> | |
| <p> | |
| Specify whether to output untracked files in <code>git status</code> in columns. | |
| See <code>column.ui</code> for details. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| column.tag | |
| </dt> | |
| <dd> | |
| <p> | |
| Specify whether to output tag listing in <code>git tag</code> in columns. | |
| See <code>column.ui</code> for details. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| commit.cleanup | |
| </dt> | |
| <dd> | |
| <p> | |
| This setting overrides the default of the <code>--cleanup</code> option in | |
| <code>git commit</code>. See <a href="git-commit.html">git-commit(1)</a> for details. Changing the | |
| default can be useful when you always want to keep lines that begin | |
| with comment character <code>#</code> in your log message, in which case you | |
| would do <code>git config commit.cleanup whitespace</code> (note that you will | |
| have to remove the help lines that begin with <code>#</code> in the commit log | |
| template yourself, if you do this). | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| commit.gpgSign | |
| </dt> | |
| <dd> | |
| <p> | |
| A boolean to specify whether all commits should be GPG signed. | |
| Use of this option when doing operations such as rebase can | |
| result in a large number of commits being signed. It may be | |
| convenient to use an agent to avoid typing your GPG passphrase | |
| several times. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| commit.status | |
| </dt> | |
| <dd> | |
| <p> | |
| A boolean to enable/disable inclusion of status information in the | |
| commit message template when using an editor to prepare the commit | |
| message. Defaults to true. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| commit.template | |
| </dt> | |
| <dd> | |
| <p> | |
| Specify the pathname of a file to use as the template for | |
| new commit messages. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| commit.verbose | |
| </dt> | |
| <dd> | |
| <p> | |
| A boolean or int to specify the level of verbose with <code>git commit</code>. | |
| See <a href="git-commit.html">git-commit(1)</a>. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| credential.helper | |
| </dt> | |
| <dd> | |
| <p> | |
| Specify an external helper to be called when a username or | |
| password credential is needed; the helper may consult external | |
| storage to avoid prompting the user for the credentials. Note | |
| that multiple helpers may be defined. See <a href="gitcredentials.html">gitcredentials(7)</a> | |
| for details. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| credential.useHttpPath | |
| </dt> | |
| <dd> | |
| <p> | |
| When acquiring credentials, consider the "path" component of an http | |
| or https URL to be important. Defaults to false. See | |
| <a href="gitcredentials.html">gitcredentials(7)</a> for more information. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| credential.username | |
| </dt> | |
| <dd> | |
| <p> | |
| If no username is set for a network authentication, use this username | |
| by default. See credential.<context>.* below, and | |
| <a href="gitcredentials.html">gitcredentials(7)</a>. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| credential.<url>.* | |
| </dt> | |
| <dd> | |
| <p> | |
| Any of the credential.* options above can be applied selectively to | |
| some credentials. For example "credential.https://example.com.username" | |
| would set the default username only for https connections to | |
| example.com. See <a href="gitcredentials.html">gitcredentials(7)</a> for details on how URLs are | |
| matched. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| credentialCache.ignoreSIGHUP | |
| </dt> | |
| <dd> | |
| <p> | |
| Tell git-credential-cache—daemon to ignore SIGHUP, instead of quitting. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| diff.autoRefreshIndex | |
| </dt> | |
| <dd> | |
| <p> | |
| When using <em>git diff</em> to compare with work tree | |
| files, do not consider stat-only change as changed. | |
| Instead, silently run <code>git update-index --refresh</code> to | |
| update the cached stat information for paths whose | |
| contents in the work tree match the contents in the | |
| index. This option defaults to true. Note that this | |
| affects only <em>git diff</em> Porcelain, and not lower level | |
| <em>diff</em> commands such as <em>git diff-files</em>. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| diff.dirstat | |
| </dt> | |
| <dd> | |
| <p> | |
| A comma separated list of <code>--dirstat</code> parameters specifying the | |
| default behavior of the <code>--dirstat</code> option to <a href="git-diff.html">git-diff(1)</a>` | |
| and friends. The defaults can be overridden on the command line | |
| (using <code>--dirstat=<param1,param2,...></code>). The fallback defaults | |
| (when not changed by <code>diff.dirstat</code>) are <code>changes,noncumulative,3</code>. | |
| The following parameters are available: | |
| </p> | |
| <div class="openblock"> | |
| <div class="content"> | |
| <div class="dlist"><dl> | |
| <dt class="hdlist1"> | |
| <code>changes</code> | |
| </dt> | |
| <dd> | |
| <p> | |
| Compute the dirstat numbers by counting the lines that have been | |
| removed from the source, or added to the destination. This ignores | |
| the amount of pure code movements within a file. In other words, | |
| rearranging lines in a file is not counted as much as other changes. | |
| This is the default behavior when no parameter is given. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| <code>lines</code> | |
| </dt> | |
| <dd> | |
| <p> | |
| Compute the dirstat numbers by doing the regular line-based diff | |
| analysis, and summing the removed/added line counts. (For binary | |
| files, count 64-byte chunks instead, since binary files have no | |
| natural concept of lines). This is a more expensive <code>--dirstat</code> | |
| behavior than the <code>changes</code> behavior, but it does count rearranged | |
| lines within a file as much as other changes. The resulting output | |
| is consistent with what you get from the other <code>--*stat</code> options. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| <code>files</code> | |
| </dt> | |
| <dd> | |
| <p> | |
| Compute the dirstat numbers by counting the number of files changed. | |
| Each changed file counts equally in the dirstat analysis. This is | |
| the computationally cheapest <code>--dirstat</code> behavior, since it does | |
| not have to look at the file contents at all. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| <code>cumulative</code> | |
| </dt> | |
| <dd> | |
| <p> | |
| Count changes in a child directory for the parent directory as well. | |
| Note that when using <code>cumulative</code>, the sum of the percentages | |
| reported may exceed 100%. The default (non-cumulative) behavior can | |
| be specified with the <code>noncumulative</code> parameter. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| <limit> | |
| </dt> | |
| <dd> | |
| <p> | |
| An integer parameter specifies a cut-off percent (3% by default). | |
| Directories contributing less than this percentage of the changes | |
| are not shown in the output. | |
| </p> | |
| </dd> | |
| </dl></div> | |
| </div></div> | |
| <div class="paragraph"><p>Example: The following will count changed files, while ignoring | |
| directories with less than 10% of the total amount of changed files, | |
| and accumulating child directory counts in the parent directories: | |
| <code>files,10,cumulative</code>.</p></div> | |
| </dd> | |
| <dt class="hdlist1"> | |
| diff.statGraphWidth | |
| </dt> | |
| <dd> | |
| <p> | |
| Limit the width of the graph part in --stat output. If set, applies | |
| to all commands generating --stat output except format-patch. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| diff.context | |
| </dt> | |
| <dd> | |
| <p> | |
| Generate diffs with <n> lines of context instead of the default | |
| of 3. This value is overridden by the -U option. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| diff.external | |
| </dt> | |
| <dd> | |
| <p> | |
| If this config variable is set, diff generation is not | |
| performed using the internal diff machinery, but using the | |
| given command. Can be overridden with the ‘GIT_EXTERNAL_DIFF’ | |
| environment variable. The command is called with parameters | |
| as described under "git Diffs" in <a href="git.html">git(1)</a>. Note: if | |
| you want to use an external diff program only on a subset of | |
| your files, you might want to use <a href="gitattributes.html">gitattributes(5)</a> instead. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| diff.ignoreSubmodules | |
| </dt> | |
| <dd> | |
| <p> | |
| Sets the default value of --ignore-submodules. Note that this | |
| affects only <em>git diff</em> Porcelain, and not lower level <em>diff</em> | |
| commands such as <em>git diff-files</em>. <em>git checkout</em> also honors | |
| this setting when reporting uncommitted changes. Setting it to | |
| <em>all</em> disables the submodule summary normally shown by <em>git commit</em> | |
| and <em>git status</em> when <code>status.submoduleSummary</code> is set unless it is | |
| overridden by using the --ignore-submodules command-line option. | |
| The <em>git submodule</em> commands are not affected by this setting. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| diff.mnemonicPrefix | |
| </dt> | |
| <dd> | |
| <p> | |
| If set, <em>git diff</em> uses a prefix pair that is different from the | |
| standard "a/" and "b/" depending on what is being compared. When | |
| this configuration is in effect, reverse diff output also swaps | |
| the order of the prefixes: | |
| </p> | |
| <div class="dlist"><dl> | |
| <dt class="hdlist1"> | |
| <code>git diff</code> | |
| </dt> | |
| <dd> | |
| <p> | |
| compares the (i)ndex and the (w)ork tree; | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| <code>git diff HEAD</code> | |
| </dt> | |
| <dd> | |
| <p> | |
| compares a (c)ommit and the (w)ork tree; | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| <code>git diff --cached</code> | |
| </dt> | |
| <dd> | |
| <p> | |
| compares a (c)ommit and the (i)ndex; | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| <code>git diff HEAD:file1 file2</code> | |
| </dt> | |
| <dd> | |
| <p> | |
| compares an (o)bject and a (w)ork tree entity; | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| <code>git diff --no-index a b</code> | |
| </dt> | |
| <dd> | |
| <p> | |
| compares two non-git things (1) and (2). | |
| </p> | |
| </dd> | |
| </dl></div> | |
| </dd> | |
| <dt class="hdlist1"> | |
| diff.noprefix | |
| </dt> | |
| <dd> | |
| <p> | |
| If set, <em>git diff</em> does not show any source or destination prefix. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| diff.orderFile | |
| </dt> | |
| <dd> | |
| <p> | |
| File indicating how to order files within a diff, using | |
| one shell glob pattern per line. | |
| Can be overridden by the <em>-O</em> option to <a href="git-diff.html">git-diff(1)</a>. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| diff.renameLimit | |
| </dt> | |
| <dd> | |
| <p> | |
| The number of files to consider when performing the copy/rename | |
| detection; equivalent to the <em>git diff</em> option <code>-l</code>. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| diff.renames | |
| </dt> | |
| <dd> | |
| <p> | |
| Whether and how Git detects renames. If set to "false", | |
| rename detection is disabled. If set to "true", basic rename | |
| detection is enabled. If set to "copies" or "copy", Git will | |
| detect copies, as well. Defaults to true. Note that this | |
| affects only <em>git diff</em> Porcelain like <a href="git-diff.html">git-diff(1)</a> and | |
| <a href="git-log.html">git-log(1)</a>, and not lower level commands such as | |
| <a href="git-diff-files.html">git-diff-files(1)</a>. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| diff.suppressBlankEmpty | |
| </dt> | |
| <dd> | |
| <p> | |
| A boolean to inhibit the standard behavior of printing a space | |
| before each empty output line. Defaults to false. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| diff.submodule | |
| </dt> | |
| <dd> | |
| <p> | |
| Specify the format in which differences in submodules are | |
| shown. The "log" format lists the commits in the range like | |
| <a href="git-submodule.html">git-submodule(1)</a> <code>summary</code> does. The "short" format | |
| format just shows the names of the commits at the beginning | |
| and end of the range. Defaults to short. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| diff.wordRegex | |
| </dt> | |
| <dd> | |
| <p> | |
| A POSIX Extended Regular Expression used to determine what is a "word" | |
| when performing word-by-word difference calculations. Character | |
| sequences that match the regular expression are "words", all other | |
| characters are <strong>ignorable</strong> whitespace. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| diff.<driver>.command | |
| </dt> | |
| <dd> | |
| <p> | |
| The custom diff driver command. See <a href="gitattributes.html">gitattributes(5)</a> | |
| for details. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| diff.<driver>.xfuncname | |
| </dt> | |
| <dd> | |
| <p> | |
| The regular expression that the diff driver should use to | |
| recognize the hunk header. A built-in pattern may also be used. | |
| See <a href="gitattributes.html">gitattributes(5)</a> for details. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| diff.<driver>.binary | |
| </dt> | |
| <dd> | |
| <p> | |
| Set this option to true to make the diff driver treat files as | |
| binary. See <a href="gitattributes.html">gitattributes(5)</a> for details. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| diff.<driver>.textconv | |
| </dt> | |
| <dd> | |
| <p> | |
| The command that the diff driver should call to generate the | |
| text-converted version of a file. The result of the | |
| conversion is used to generate a human-readable diff. See | |
| <a href="gitattributes.html">gitattributes(5)</a> for details. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| diff.<driver>.wordRegex | |
| </dt> | |
| <dd> | |
| <p> | |
| The regular expression that the diff driver should use to | |
| split words in a line. See <a href="gitattributes.html">gitattributes(5)</a> for | |
| details. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| diff.<driver>.cachetextconv | |
| </dt> | |
| <dd> | |
| <p> | |
| Set this option to true to make the diff driver cache the text | |
| conversion outputs. See <a href="gitattributes.html">gitattributes(5)</a> for details. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| diff.tool | |
| </dt> | |
| <dd> | |
| <p> | |
| Controls which diff tool is used by <a href="git-difftool.html">git-difftool(1)</a>. | |
| This variable overrides the value configured in <code>merge.tool</code>. | |
| The list below shows the valid built-in values. | |
| Any other value is treated as a custom diff tool and requires | |
| that a corresponding difftool.<tool>.cmd variable is defined. | |
| </p> | |
| <div class="ulist"><ul> | |
| <li> | |
| <p> | |
| araxis | |
| </p> | |
| </li> | |
| <li> | |
| <p> | |
| bc | |
| </p> | |
| </li> | |
| <li> | |
| <p> | |
| bc3 | |
| </p> | |
| </li> | |
| <li> | |
| <p> | |
| codecompare | |
| </p> | |
| </li> | |
| <li> | |
| <p> | |
| deltawalker | |
| </p> | |
| </li> | |
| <li> | |
| <p> | |
| diffmerge | |
| </p> | |
| </li> | |
| <li> | |
| <p> | |
| diffuse | |
| </p> | |
| </li> | |
| <li> | |
| <p> | |
| ecmerge | |
| </p> | |
| </li> | |
| <li> | |
| <p> | |
| emerge | |
| </p> | |
| </li> | |
| <li> | |
| <p> | |
| examdiff | |
| </p> | |
| </li> | |
| <li> | |
| <p> | |
| gvimdiff | |
| </p> | |
| </li> | |
| <li> | |
| <p> | |
| gvimdiff2 | |
| </p> | |
| </li> | |
| <li> | |
| <p> | |
| gvimdiff3 | |
| </p> | |
| </li> | |
| <li> | |
| <p> | |
| kdiff3 | |
| </p> | |
| </li> | |
| <li> | |
| <p> | |
| kompare | |
| </p> | |
| </li> | |
| <li> | |
| <p> | |
| meld | |
| </p> | |
| </li> | |
| <li> | |
| <p> | |
| opendiff | |
| </p> | |
| </li> | |
| <li> | |
| <p> | |
| p4merge | |
| </p> | |
| </li> | |
| <li> | |
| <p> | |
| tkdiff | |
| </p> | |
| </li> | |
| <li> | |
| <p> | |
| vimdiff | |
| </p> | |
| </li> | |
| <li> | |
| <p> | |
| vimdiff2 | |
| </p> | |
| </li> | |
| <li> | |
| <p> | |
| vimdiff3 | |
| </p> | |
| </li> | |
| <li> | |
| <p> | |
| winmerge | |
| </p> | |
| </li> | |
| <li> | |
| <p> | |
| xxdiff | |
| </p> | |
| </li> | |
| </ul></div> | |
| </dd> | |
| <dt class="hdlist1"> | |
| diff.compactionHeuristic | |
| </dt> | |
| <dd> | |
| <p> | |
| Set this option to <code>true</code> to enable an experimental heuristic that | |
| shifts the hunk boundary in an attempt to make the resulting | |
| patch easier to read. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| diff.algorithm | |
| </dt> | |
| <dd> | |
| <p> | |
| Choose a diff algorithm. The variants are as follows: | |
| </p> | |
| <div class="openblock"> | |
| <div class="content"> | |
| <div class="dlist"><dl> | |
| <dt class="hdlist1"> | |
| <code>default</code>, <code>myers</code> | |
| </dt> | |
| <dd> | |
| <p> | |
| The basic greedy diff algorithm. Currently, this is the default. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| <code>minimal</code> | |
| </dt> | |
| <dd> | |
| <p> | |
| Spend extra time to make sure the smallest possible diff is | |
| produced. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| <code>patience</code> | |
| </dt> | |
| <dd> | |
| <p> | |
| Use "patience diff" algorithm when generating patches. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| <code>histogram</code> | |
| </dt> | |
| <dd> | |
| <p> | |
| This algorithm extends the patience algorithm to "support | |
| low-occurrence common elements". | |
| </p> | |
| </dd> | |
| </dl></div> | |
| </div></div> | |
| </dd> | |
| <dt class="hdlist1"> | |
| difftool.<tool>.path | |
| </dt> | |
| <dd> | |
| <p> | |
| Override the path for the given tool. This is useful in case | |
| your tool is not in the PATH. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| difftool.<tool>.cmd | |
| </dt> | |
| <dd> | |
| <p> | |
| Specify the command to invoke the specified diff tool. | |
| The specified command is evaluated in shell with the following | |
| variables available: <em>LOCAL</em> is set to the name of the temporary | |
| file containing the contents of the diff pre-image and <em>REMOTE</em> | |
| is set to the name of the temporary file containing the contents | |
| of the diff post-image. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| difftool.prompt | |
| </dt> | |
| <dd> | |
| <p> | |
| Prompt before each invocation of the diff tool. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| fastimport.unpackLimit | |
| </dt> | |
| <dd> | |
| <p> | |
| If the number of objects imported by <a href="git-fast-import.html">git-fast-import(1)</a> | |
| is below this limit, then the objects will be unpacked into | |
| loose object files. However if the number of imported objects | |
| equals or exceeds this limit then the pack will be stored as a | |
| pack. Storing the pack from a fast-import can make the import | |
| operation complete faster, especially on slow filesystems. If | |
| not set, the value of <code>transfer.unpackLimit</code> is used instead. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| fetch.recurseSubmodules | |
| </dt> | |
| <dd> | |
| <p> | |
| This option can be either set to a boolean value or to <em>on-demand</em>. | |
| Setting it to a boolean changes the behavior of fetch and pull to | |
| unconditionally recurse into submodules when set to true or to not | |
| recurse at all when set to false. When set to <em>on-demand</em> (the default | |
| value), fetch and pull will only recurse into a populated submodule | |
| when its superproject retrieves a commit that updates the submodule’s | |
| reference. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| fetch.fsckObjects | |
| </dt> | |
| <dd> | |
| <p> | |
| If it is set to true, git-fetch-pack will check all fetched | |
| objects. It will abort in the case of a malformed object or a | |
| broken link. The result of an abort are only dangling objects. | |
| Defaults to false. If not set, the value of <code>transfer.fsckObjects</code> | |
| is used instead. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| fetch.unpackLimit | |
| </dt> | |
| <dd> | |
| <p> | |
| If the number of objects fetched over the Git native | |
| transfer is below this | |
| limit, then the objects will be unpacked into loose object | |
| files. However if the number of received objects equals or | |
| exceeds this limit then the received pack will be stored as | |
| a pack, after adding any missing delta bases. Storing the | |
| pack from a push can make the push operation complete faster, | |
| especially on slow filesystems. If not set, the value of | |
| <code>transfer.unpackLimit</code> is used instead. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| fetch.prune | |
| </dt> | |
| <dd> | |
| <p> | |
| If true, fetch will automatically behave as if the <code>--prune</code> | |
| option was given on the command line. See also <code>remote.<name>.prune</code>. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| fetch.output | |
| </dt> | |
| <dd> | |
| <p> | |
| Control how ref update status is printed. Valid values are | |
| <code>full</code> and <code>compact</code>. Default value is <code>full</code>. See section | |
| OUTPUT in <a href="git-fetch.html">git-fetch(1)</a> for detail. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| format.attach | |
| </dt> | |
| <dd> | |
| <p> | |
| Enable multipart/mixed attachments as the default for | |
| <em>format-patch</em>. The value can also be a double quoted string | |
| which will enable attachments as the default and set the | |
| value as the boundary. See the --attach option in | |
| <a href="git-format-patch.html">git-format-patch(1)</a>. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| format.from | |
| </dt> | |
| <dd> | |
| <p> | |
| Provides the default value for the <code>--from</code> option to format-patch. | |
| Accepts a boolean value, or a name and email address. If false, | |
| format-patch defaults to <code>--no-from</code>, using commit authors directly in | |
| the "From:" field of patch mails. If true, format-patch defaults to | |
| <code>--from</code>, using your committer identity in the "From:" field of patch | |
| mails and including a "From:" field in the body of the patch mail if | |
| different. If set to a non-boolean value, format-patch uses that | |
| value instead of your committer identity. Defaults to false. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| format.numbered | |
| </dt> | |
| <dd> | |
| <p> | |
| A boolean which can enable or disable sequence numbers in patch | |
| subjects. It defaults to "auto" which enables it only if there | |
| is more than one patch. It can be enabled or disabled for all | |
| messages by setting it to "true" or "false". See --numbered | |
| option in <a href="git-format-patch.html">git-format-patch(1)</a>. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| format.headers | |
| </dt> | |
| <dd> | |
| <p> | |
| Additional email headers to include in a patch to be submitted | |
| by mail. See <a href="git-format-patch.html">git-format-patch(1)</a>. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| format.to | |
| </dt> | |
| <dt class="hdlist1"> | |
| format.cc | |
| </dt> | |
| <dd> | |
| <p> | |
| Additional recipients to include in a patch to be submitted | |
| by mail. See the --to and --cc options in | |
| <a href="git-format-patch.html">git-format-patch(1)</a>. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| format.subjectPrefix | |
| </dt> | |
| <dd> | |
| <p> | |
| The default for format-patch is to output files with the <em>[PATCH]</em> | |
| subject prefix. Use this variable to change that prefix. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| format.signature | |
| </dt> | |
| <dd> | |
| <p> | |
| The default for format-patch is to output a signature containing | |
| the Git version number. Use this variable to change that default. | |
| Set this variable to the empty string ("") to suppress | |
| signature generation. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| format.signatureFile | |
| </dt> | |
| <dd> | |
| <p> | |
| Works just like format.signature except the contents of the | |
| file specified by this variable will be used as the signature. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| format.suffix | |
| </dt> | |
| <dd> | |
| <p> | |
| The default for format-patch is to output files with the suffix | |
| <code>.patch</code>. Use this variable to change that suffix (make sure to | |
| include the dot if you want it). | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| format.pretty | |
| </dt> | |
| <dd> | |
| <p> | |
| The default pretty format for log/show/whatchanged command, | |
| See <a href="git-log.html">git-log(1)</a>, <a href="git-show.html">git-show(1)</a>, | |
| <a href="git-whatchanged.html">git-whatchanged(1)</a>. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| format.thread | |
| </dt> | |
| <dd> | |
| <p> | |
| The default threading style for <em>git format-patch</em>. Can be | |
| a boolean value, or <code>shallow</code> or <code>deep</code>. <code>shallow</code> threading | |
| makes every mail a reply to the head of the series, | |
| where the head is chosen from the cover letter, the | |
| <code>--in-reply-to</code>, and the first patch mail, in this order. | |
| <code>deep</code> threading makes every mail a reply to the previous one. | |
| A true boolean value is the same as <code>shallow</code>, and a false | |
| value disables threading. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| format.signOff | |
| </dt> | |
| <dd> | |
| <p> | |
| A boolean value which lets you enable the <code>-s/--signoff</code> option of | |
| format-patch by default. <strong>Note:</strong> Adding the Signed-off-by: line to a | |
| patch should be a conscious act and means that you certify you have | |
| the rights to submit this work under the same open source license. | |
| Please see the <em>SubmittingPatches</em> document for further discussion. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| format.coverLetter | |
| </dt> | |
| <dd> | |
| <p> | |
| A boolean that controls whether to generate a cover-letter when | |
| format-patch is invoked, but in addition can be set to "auto", to | |
| generate a cover-letter only when there’s more than one patch. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| format.outputDirectory | |
| </dt> | |
| <dd> | |
| <p> | |
| Set a custom directory to store the resulting files instead of the | |
| current working directory. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| format.useAutoBase | |
| </dt> | |
| <dd> | |
| <p> | |
| A boolean value which lets you enable the <code>--base=auto</code> option of | |
| format-patch by default. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| filter.<driver>.clean | |
| </dt> | |
| <dd> | |
| <p> | |
| The command which is used to convert the content of a worktree | |
| file to a blob upon checkin. See <a href="gitattributes.html">gitattributes(5)</a> for | |
| details. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| filter.<driver>.smudge | |
| </dt> | |
| <dd> | |
| <p> | |
| The command which is used to convert the content of a blob | |
| object to a worktree file upon checkout. See | |
| <a href="gitattributes.html">gitattributes(5)</a> for details. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| fsck.<msg-id> | |
| </dt> | |
| <dd> | |
| <p> | |
| Allows overriding the message type (error, warn or ignore) of a | |
| specific message ID such as <code>missingEmail</code>. | |
| </p> | |
| <div class="paragraph"><p>For convenience, fsck prefixes the error/warning with the message ID, | |
| e.g. "missingEmail: invalid author/committer line - missing email" means | |
| that setting <code>fsck.missingEmail = ignore</code> will hide that issue.</p></div> | |
| <div class="paragraph"><p>This feature is intended to support working with legacy repositories | |
| which cannot be repaired without disruptive changes.</p></div> | |
| </dd> | |
| <dt class="hdlist1"> | |
| fsck.skipList | |
| </dt> | |
| <dd> | |
| <p> | |
| The path to a sorted list of object names (i.e. one SHA-1 per | |
| line) that are known to be broken in a non-fatal way and should | |
| be ignored. This feature is useful when an established project | |
| should be accepted despite early commits containing errors that | |
| can be safely ignored such as invalid committer email addresses. | |
| Note: corrupt objects cannot be skipped with this setting. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| gc.aggressiveDepth | |
| </dt> | |
| <dd> | |
| <p> | |
| The depth parameter used in the delta compression | |
| algorithm used by <em>git gc --aggressive</em>. This defaults | |
| to 250. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| gc.aggressiveWindow | |
| </dt> | |
| <dd> | |
| <p> | |
| The window size parameter used in the delta compression | |
| algorithm used by <em>git gc --aggressive</em>. This defaults | |
| to 250. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| gc.auto | |
| </dt> | |
| <dd> | |
| <p> | |
| When there are approximately more than this many loose | |
| objects in the repository, <code>git gc --auto</code> will pack them. | |
| Some Porcelain commands use this command to perform a | |
| light-weight garbage collection from time to time. The | |
| default value is 6700. Setting this to 0 disables it. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| gc.autoPackLimit | |
| </dt> | |
| <dd> | |
| <p> | |
| When there are more than this many packs that are not | |
| marked with <code>*.keep</code> file in the repository, <code>git gc | |
| --auto</code> consolidates them into one larger pack. The | |
| default value is 50. Setting this to 0 disables it. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| gc.autoDetach | |
| </dt> | |
| <dd> | |
| <p> | |
| Make <code>git gc --auto</code> return immediately and run in background | |
| if the system supports it. Default is true. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| gc.packRefs | |
| </dt> | |
| <dd> | |
| <p> | |
| Running <code>git pack-refs</code> in a repository renders it | |
| unclonable by Git versions prior to 1.5.1.2 over dumb | |
| transports such as HTTP. This variable determines whether | |
| <em>git gc</em> runs <code>git pack-refs</code>. This can be set to <code>notbare</code> | |
| to enable it within all non-bare repos or it can be set to a | |
| boolean value. The default is <code>true</code>. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| gc.pruneExpire | |
| </dt> | |
| <dd> | |
| <p> | |
| When <em>git gc</em> is run, it will call <em>prune --expire 2.weeks.ago</em>. | |
| Override the grace period with this config variable. The value | |
| "now" may be used to disable this grace period and always prune | |
| unreachable objects immediately, or "never" may be used to | |
| suppress pruning. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| gc.worktreePruneExpire | |
| </dt> | |
| <dd> | |
| <p> | |
| When <em>git gc</em> is run, it calls | |
| <em>git worktree prune --expire 3.months.ago</em>. | |
| This config variable can be used to set a different grace | |
| period. The value "now" may be used to disable the grace | |
| period and prune <code>$GIT_DIR/worktrees</code> immediately, or "never" | |
| may be used to suppress pruning. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| gc.reflogExpire | |
| </dt> | |
| <dt class="hdlist1"> | |
| gc.<pattern>.reflogExpire | |
| </dt> | |
| <dd> | |
| <p> | |
| <em>git reflog expire</em> removes reflog entries older than | |
| this time; defaults to 90 days. The value "now" expires all | |
| entries immediately, and "never" suppresses expiration | |
| altogether. With "<pattern>" (e.g. | |
| "refs/stash") in the middle the setting applies only to | |
| the refs that match the <pattern>. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| gc.reflogExpireUnreachable | |
| </dt> | |
| <dt class="hdlist1"> | |
| gc.<pattern>.reflogExpireUnreachable | |
| </dt> | |
| <dd> | |
| <p> | |
| <em>git reflog expire</em> removes reflog entries older than | |
| this time and are not reachable from the current tip; | |
| defaults to 30 days. The value "now" expires all entries | |
| immediately, and "never" suppresses expiration altogether. | |
| With "<pattern>" (e.g. "refs/stash") | |
| in the middle, the setting applies only to the refs that | |
| match the <pattern>. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| gc.rerereResolved | |
| </dt> | |
| <dd> | |
| <p> | |
| Records of conflicted merge you resolved earlier are | |
| kept for this many days when <em>git rerere gc</em> is run. | |
| The default is 60 days. See <a href="git-rerere.html">git-rerere(1)</a>. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| gc.rerereUnresolved | |
| </dt> | |
| <dd> | |
| <p> | |
| Records of conflicted merge you have not resolved are | |
| kept for this many days when <em>git rerere gc</em> is run. | |
| The default is 15 days. See <a href="git-rerere.html">git-rerere(1)</a>. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| gitcvs.commitMsgAnnotation | |
| </dt> | |
| <dd> | |
| <p> | |
| Append this string to each commit message. Set to empty string | |
| to disable this feature. Defaults to "via git-CVS emulator". | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| gitcvs.enabled | |
| </dt> | |
| <dd> | |
| <p> | |
| Whether the CVS server interface is enabled for this repository. | |
| See <a href="git-cvsserver.html">git-cvsserver(1)</a>. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| gitcvs.logFile | |
| </dt> | |
| <dd> | |
| <p> | |
| Path to a log file where the CVS server interface well… logs | |
| various stuff. See <a href="git-cvsserver.html">git-cvsserver(1)</a>. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| gitcvs.usecrlfattr | |
| </dt> | |
| <dd> | |
| <p> | |
| If true, the server will look up the end-of-line conversion | |
| attributes for files to determine the <code>-k</code> modes to use. If | |
| the attributes force Git to treat a file as text, | |
| the <code>-k</code> mode will be left blank so CVS clients will | |
| treat it as text. If they suppress text conversion, the file | |
| will be set with <em>-kb</em> mode, which suppresses any newline munging | |
| the client might otherwise do. If the attributes do not allow | |
| the file type to be determined, then <code>gitcvs.allBinary</code> is | |
| used. See <a href="gitattributes.html">gitattributes(5)</a>. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| gitcvs.allBinary | |
| </dt> | |
| <dd> | |
| <p> | |
| This is used if <code>gitcvs.usecrlfattr</code> does not resolve | |
| the correct <em>-kb</em> mode to use. If true, all | |
| unresolved files are sent to the client in | |
| mode <em>-kb</em>. This causes the client to treat them | |
| as binary files, which suppresses any newline munging it | |
| otherwise might do. Alternatively, if it is set to "guess", | |
| then the contents of the file are examined to decide if | |
| it is binary, similar to <code>core.autocrlf</code>. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| gitcvs.dbName | |
| </dt> | |
| <dd> | |
| <p> | |
| Database used by git-cvsserver to cache revision information | |
| derived from the Git repository. The exact meaning depends on the | |
| used database driver, for SQLite (which is the default driver) this | |
| is a filename. Supports variable substitution (see | |
| <a href="git-cvsserver.html">git-cvsserver(1)</a> for details). May not contain semicolons (<code>;</code>). | |
| Default: <em>%Ggitcvs.%m.sqlite</em> | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| gitcvs.dbDriver | |
| </dt> | |
| <dd> | |
| <p> | |
| Used Perl DBI driver. You can specify any available driver | |
| for this here, but it might not work. git-cvsserver is tested | |
| with <em>DBD::SQLite</em>, reported to work with <em>DBD::Pg</em>, and | |
| reported <strong>not</strong> to work with <em>DBD::mysql</em>. Experimental feature. | |
| May not contain double colons (<code>:</code>). Default: <em>SQLite</em>. | |
| See <a href="git-cvsserver.html">git-cvsserver(1)</a>. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| gitcvs.dbUser, gitcvs.dbPass | |
| </dt> | |
| <dd> | |
| <p> | |
| Database user and password. Only useful if setting <code>gitcvs.dbDriver</code>, | |
| since SQLite has no concept of database users and/or passwords. | |
| <em>gitcvs.dbUser</em> supports variable substitution (see | |
| <a href="git-cvsserver.html">git-cvsserver(1)</a> for details). | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| gitcvs.dbTableNamePrefix | |
| </dt> | |
| <dd> | |
| <p> | |
| Database table name prefix. Prepended to the names of any | |
| database tables used, allowing a single database to be used | |
| for several repositories. Supports variable substitution (see | |
| <a href="git-cvsserver.html">git-cvsserver(1)</a> for details). Any non-alphabetic | |
| characters will be replaced with underscores. | |
| </p> | |
| </dd> | |
| </dl></div> | |
| <div class="paragraph"><p>All gitcvs variables except for <code>gitcvs.usecrlfattr</code> and | |
| <code>gitcvs.allBinary</code> can also be specified as | |
| <em>gitcvs.<access_method>.<varname></em> (where <em>access_method</em> | |
| is one of "ext" and "pserver") to make them apply only for the given | |
| access method.</p></div> | |
| <div class="dlist"><dl> | |
| <dt class="hdlist1"> | |
| gitweb.category | |
| </dt> | |
| <dt class="hdlist1"> | |
| gitweb.description | |
| </dt> | |
| <dt class="hdlist1"> | |
| gitweb.owner | |
| </dt> | |
| <dt class="hdlist1"> | |
| gitweb.url | |
| </dt> | |
| <dd> | |
| <p> | |
| See <a href="gitweb.html">gitweb(1)</a> for description. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| gitweb.avatar | |
| </dt> | |
| <dt class="hdlist1"> | |
| gitweb.blame | |
| </dt> | |
| <dt class="hdlist1"> | |
| gitweb.grep | |
| </dt> | |
| <dt class="hdlist1"> | |
| gitweb.highlight | |
| </dt> | |
| <dt class="hdlist1"> | |
| gitweb.patches | |
| </dt> | |
| <dt class="hdlist1"> | |
| gitweb.pickaxe | |
| </dt> | |
| <dt class="hdlist1"> | |
| gitweb.remote_heads | |
| </dt> | |
| <dt class="hdlist1"> | |
| gitweb.showSizes | |
| </dt> | |
| <dt class="hdlist1"> | |
| gitweb.snapshot | |
| </dt> | |
| <dd> | |
| <p> | |
| See <a href="gitweb.conf.html">gitweb.conf(5)</a> for description. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| grep.lineNumber | |
| </dt> | |
| <dd> | |
| <p> | |
| If set to true, enable <code>-n</code> option by default. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| grep.patternType | |
| </dt> | |
| <dd> | |
| <p> | |
| Set the default matching behavior. Using a value of <em>basic</em>, <em>extended</em>, | |
| <em>fixed</em>, or <em>perl</em> will enable the <code>--basic-regexp</code>, <code>--extended-regexp</code>, | |
| <code>--fixed-strings</code>, or <code>--perl-regexp</code> option accordingly, while the | |
| value <em>default</em> will return to the default matching behavior. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| grep.extendedRegexp | |
| </dt> | |
| <dd> | |
| <p> | |
| If set to true, enable <code>--extended-regexp</code> option by default. This | |
| option is ignored when the <code>grep.patternType</code> option is set to a value | |
| other than <em>default</em>. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| grep.threads | |
| </dt> | |
| <dd> | |
| <p> | |
| Number of grep worker threads to use. | |
| See <code>grep.threads</code> in <a href="git-grep.html">git-grep(1)</a> for more information. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| grep.fallbackToNoIndex | |
| </dt> | |
| <dd> | |
| <p> | |
| If set to true, fall back to git grep --no-index if git grep | |
| is executed outside of a git repository. Defaults to false. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| gpg.program | |
| </dt> | |
| <dd> | |
| <p> | |
| Use this custom program instead of "<code>gpg</code>" found on <code>$PATH</code> when | |
| making or verifying a PGP signature. The program must support the | |
| same command-line interface as GPG, namely, to verify a detached | |
| signature, "<code>gpg --verify $file - <$signature</code>" is run, and the | |
| program is expected to signal a good signature by exiting with | |
| code 0, and to generate an ASCII-armored detached signature, the | |
| standard input of "<code>gpg -bsau $key</code>" is fed with the contents to be | |
| signed, and the program is expected to send the result to its | |
| standard output. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| gui.commitMsgWidth | |
| </dt> | |
| <dd> | |
| <p> | |
| Defines how wide the commit message window is in the | |
| <a href="git-gui.html">git-gui(1)</a>. "75" is the default. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| gui.diffContext | |
| </dt> | |
| <dd> | |
| <p> | |
| Specifies how many context lines should be used in calls to diff | |
| made by the <a href="git-gui.html">git-gui(1)</a>. The default is "5". | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| gui.displayUntracked | |
| </dt> | |
| <dd> | |
| <p> | |
| Determines if <a href="git-gui.html">git-gui(1)</a> shows untracked files | |
| in the file list. The default is "true". | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| gui.encoding | |
| </dt> | |
| <dd> | |
| <p> | |
| Specifies the default encoding to use for displaying of | |
| file contents in <a href="git-gui.html">git-gui(1)</a> and <a href="gitk.html">gitk(1)</a>. | |
| It can be overridden by setting the <em>encoding</em> attribute | |
| for relevant files (see <a href="gitattributes.html">gitattributes(5)</a>). | |
| If this option is not set, the tools default to the | |
| locale encoding. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| gui.matchTrackingBranch | |
| </dt> | |
| <dd> | |
| <p> | |
| Determines if new branches created with <a href="git-gui.html">git-gui(1)</a> should | |
| default to tracking remote branches with matching names or | |
| not. Default: "false". | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| gui.newBranchTemplate | |
| </dt> | |
| <dd> | |
| <p> | |
| Is used as suggested name when creating new branches using the | |
| <a href="git-gui.html">git-gui(1)</a>. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| gui.pruneDuringFetch | |
| </dt> | |
| <dd> | |
| <p> | |
| "true" if <a href="git-gui.html">git-gui(1)</a> should prune remote-tracking branches when | |
| performing a fetch. The default value is "false". | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| gui.trustmtime | |
| </dt> | |
| <dd> | |
| <p> | |
| Determines if <a href="git-gui.html">git-gui(1)</a> should trust the file modification | |
| timestamp or not. By default the timestamps are not trusted. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| gui.spellingDictionary | |
| </dt> | |
| <dd> | |
| <p> | |
| Specifies the dictionary used for spell checking commit messages in | |
| the <a href="git-gui.html">git-gui(1)</a>. When set to "none" spell checking is turned | |
| off. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| gui.fastCopyBlame | |
| </dt> | |
| <dd> | |
| <p> | |
| If true, <em>git gui blame</em> uses <code>-C</code> instead of <code>-C -C</code> for original | |
| location detection. It makes blame significantly faster on huge | |
| repositories at the expense of less thorough copy detection. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| gui.copyBlameThreshold | |
| </dt> | |
| <dd> | |
| <p> | |
| Specifies the threshold to use in <em>git gui blame</em> original location | |
| detection, measured in alphanumeric characters. See the | |
| <a href="git-blame.html">git-blame(1)</a> manual for more information on copy detection. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| gui.blamehistoryctx | |
| </dt> | |
| <dd> | |
| <p> | |
| Specifies the radius of history context in days to show in | |
| <a href="gitk.html">gitk(1)</a> for the selected commit, when the <code>Show History | |
| Context</code> menu item is invoked from <em>git gui blame</em>. If this | |
| variable is set to zero, the whole history is shown. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| guitool.<name>.cmd | |
| </dt> | |
| <dd> | |
| <p> | |
| Specifies the shell command line to execute when the corresponding item | |
| of the <a href="git-gui.html">git-gui(1)</a> <code>Tools</code> menu is invoked. This option is | |
| mandatory for every tool. The command is executed from the root of | |
| the working directory, and in the environment it receives the name of | |
| the tool as <code>GIT_GUITOOL</code>, the name of the currently selected file as | |
| <em>FILENAME</em>, and the name of the current branch as <em>CUR_BRANCH</em> (if | |
| the head is detached, <em>CUR_BRANCH</em> is empty). | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| guitool.<name>.needsFile | |
| </dt> | |
| <dd> | |
| <p> | |
| Run the tool only if a diff is selected in the GUI. It guarantees | |
| that <em>FILENAME</em> is not empty. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| guitool.<name>.noConsole | |
| </dt> | |
| <dd> | |
| <p> | |
| Run the command silently, without creating a window to display its | |
| output. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| guitool.<name>.noRescan | |
| </dt> | |
| <dd> | |
| <p> | |
| Don’t rescan the working directory for changes after the tool | |
| finishes execution. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| guitool.<name>.confirm | |
| </dt> | |
| <dd> | |
| <p> | |
| Show a confirmation dialog before actually running the tool. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| guitool.<name>.argPrompt | |
| </dt> | |
| <dd> | |
| <p> | |
| Request a string argument from the user, and pass it to the tool | |
| through the <code>ARGS</code> environment variable. Since requesting an | |
| argument implies confirmation, the <em>confirm</em> option has no effect | |
| if this is enabled. If the option is set to <em>true</em>, <em>yes</em>, or <em>1</em>, | |
| the dialog uses a built-in generic prompt; otherwise the exact | |
| value of the variable is used. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| guitool.<name>.revPrompt | |
| </dt> | |
| <dd> | |
| <p> | |
| Request a single valid revision from the user, and set the | |
| <code>REVISION</code> environment variable. In other aspects this option | |
| is similar to <em>argPrompt</em>, and can be used together with it. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| guitool.<name>.revUnmerged | |
| </dt> | |
| <dd> | |
| <p> | |
| Show only unmerged branches in the <em>revPrompt</em> subdialog. | |
| This is useful for tools similar to merge or rebase, but not | |
| for things like checkout or reset. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| guitool.<name>.title | |
| </dt> | |
| <dd> | |
| <p> | |
| Specifies the title to use for the prompt dialog. The default | |
| is the tool name. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| guitool.<name>.prompt | |
| </dt> | |
| <dd> | |
| <p> | |
| Specifies the general prompt string to display at the top of | |
| the dialog, before subsections for <em>argPrompt</em> and <em>revPrompt</em>. | |
| The default value includes the actual command. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| help.browser | |
| </dt> | |
| <dd> | |
| <p> | |
| Specify the browser that will be used to display help in the | |
| <em>web</em> format. See <a href="git-help.html">git-help(1)</a>. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| help.format | |
| </dt> | |
| <dd> | |
| <p> | |
| Override the default help format used by <a href="git-help.html">git-help(1)</a>. | |
| Values <em>man</em>, <em>info</em>, <em>web</em> and <em>html</em> are supported. <em>man</em> is | |
| the default. <em>web</em> and <em>html</em> are the same. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| help.autoCorrect | |
| </dt> | |
| <dd> | |
| <p> | |
| Automatically correct and execute mistyped commands after | |
| waiting for the given number of deciseconds (0.1 sec). If more | |
| than one command can be deduced from the entered text, nothing | |
| will be executed. If the value of this option is negative, | |
| the corrected command will be executed immediately. If the | |
| value is 0 - the command will be just shown but not executed. | |
| This is the default. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| help.htmlPath | |
| </dt> | |
| <dd> | |
| <p> | |
| Specify the path where the HTML documentation resides. File system paths | |
| and URLs are supported. HTML pages will be prefixed with this path when | |
| help is displayed in the <em>web</em> format. This defaults to the documentation | |
| path of your Git installation. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| http.proxy | |
| </dt> | |
| <dd> | |
| <p> | |
| Override the HTTP proxy, normally configured using the <em>http_proxy</em>, | |
| <em>https_proxy</em>, and <em>all_proxy</em> environment variables (see <code>curl(1)</code>). In | |
| addition to the syntax understood by curl, it is possible to specify a | |
| proxy string with a user name but no password, in which case git will | |
| attempt to acquire one in the same way it does for other credentials. See | |
| <a href="gitcredentials.html">gitcredentials(7)</a> for more information. The syntax thus is | |
| <em>[protocol://][user[:password]@]proxyhost[:port]</em>. This can be overridden | |
| on a per-remote basis; see remote.<name>.proxy | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| http.proxyAuthMethod | |
| </dt> | |
| <dd> | |
| <p> | |
| Set the method with which to authenticate against the HTTP proxy. This | |
| only takes effect if the configured proxy string contains a user name part | |
| (i.e. is of the form <em>user@host</em> or <em>user@host:port</em>). This can be | |
| overridden on a per-remote basis; see <code>remote.<name>.proxyAuthMethod</code>. | |
| Both can be overridden by the <code>GIT_HTTP_PROXY_AUTHMETHOD</code> environment | |
| variable. Possible values are: | |
| </p> | |
| <div class="openblock"> | |
| <div class="content"> | |
| <div class="ulist"><ul> | |
| <li> | |
| <p> | |
| <code>anyauth</code> - Automatically pick a suitable authentication method. It is | |
| assumed that the proxy answers an unauthenticated request with a 407 | |
| status code and one or more Proxy-authenticate headers with supported | |
| authentication methods. This is the default. | |
| </p> | |
| </li> | |
| <li> | |
| <p> | |
| <code>basic</code> - HTTP Basic authentication | |
| </p> | |
| </li> | |
| <li> | |
| <p> | |
| <code>digest</code> - HTTP Digest authentication; this prevents the password from being | |
| transmitted to the proxy in clear text | |
| </p> | |
| </li> | |
| <li> | |
| <p> | |
| <code>negotiate</code> - GSS-Negotiate authentication (compare the --negotiate option | |
| of <code>curl(1)</code>) | |
| </p> | |
| </li> | |
| <li> | |
| <p> | |
| <code>ntlm</code> - NTLM authentication (compare the --ntlm option of <code>curl(1)</code>) | |
| </p> | |
| </li> | |
| </ul></div> | |
| </div></div> | |
| </dd> | |
| <dt class="hdlist1"> | |
| http.emptyAuth | |
| </dt> | |
| <dd> | |
| <p> | |
| Attempt authentication without seeking a username or password. This | |
| can be used to attempt GSS-Negotiate authentication without specifying | |
| a username in the URL, as libcurl normally requires a username for | |
| authentication. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| http.extraHeader | |
| </dt> | |
| <dd> | |
| <p> | |
| Pass an additional HTTP header when communicating with a server. If | |
| more than one such entry exists, all of them are added as extra | |
| headers. To allow overriding the settings inherited from the system | |
| config, an empty value will reset the extra headers to the empty list. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| http.cookieFile | |
| </dt> | |
| <dd> | |
| <p> | |
| The pathname of a file containing previously stored cookie lines, | |
| which should be used | |
| in the Git http session, if they match the server. The file format | |
| of the file to read cookies from should be plain HTTP headers or | |
| the Netscape/Mozilla cookie file format (see <code>curl(1)</code>). | |
| NOTE that the file specified with http.cookieFile is used only as | |
| input unless http.saveCookies is set. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| http.saveCookies | |
| </dt> | |
| <dd> | |
| <p> | |
| If set, store cookies received during requests to the file specified by | |
| http.cookieFile. Has no effect if http.cookieFile is unset. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| http.sslVersion | |
| </dt> | |
| <dd> | |
| <p> | |
| The SSL version to use when negotiating an SSL connection, if you | |
| want to force the default. The available and default version | |
| depend on whether libcurl was built against NSS or OpenSSL and the | |
| particular configuration of the crypto library in use. Internally | |
| this sets the <em>CURLOPT_SSL_VERSION</em> option; see the libcurl | |
| documentation for more details on the format of this option and | |
| for the ssl version supported. Actually the possible values of | |
| this option are: | |
| </p> | |
| <div class="ulist"><ul> | |
| <li> | |
| <p> | |
| sslv2 | |
| </p> | |
| </li> | |
| <li> | |
| <p> | |
| sslv3 | |
| </p> | |
| </li> | |
| <li> | |
| <p> | |
| tlsv1 | |
| </p> | |
| </li> | |
| <li> | |
| <p> | |
| tlsv1.0 | |
| </p> | |
| </li> | |
| <li> | |
| <p> | |
| tlsv1.1 | |
| </p> | |
| </li> | |
| <li> | |
| <p> | |
| tlsv1.2 | |
| </p> | |
| </li> | |
| </ul></div> | |
| <div class="paragraph"><p>Can be overridden by the <code>GIT_SSL_VERSION</code> environment variable. | |
| To force git to use libcurl’s default ssl version and ignore any | |
| explicit http.sslversion option, set <code>GIT_SSL_VERSION</code> to the | |
| empty string.</p></div> | |
| </dd> | |
| <dt class="hdlist1"> | |
| http.sslCipherList | |
| </dt> | |
| <dd> | |
| <p> | |
| A list of SSL ciphers to use when negotiating an SSL connection. | |
| The available ciphers depend on whether libcurl was built against | |
| NSS or OpenSSL and the particular configuration of the crypto | |
| library in use. Internally this sets the <em>CURLOPT_SSL_CIPHER_LIST</em> | |
| option; see the libcurl documentation for more details on the format | |
| of this list. | |
| </p> | |
| <div class="paragraph"><p>Can be overridden by the <code>GIT_SSL_CIPHER_LIST</code> environment variable. | |
| To force git to use libcurl’s default cipher list and ignore any | |
| explicit http.sslCipherList option, set <code>GIT_SSL_CIPHER_LIST</code> to the | |
| empty string.</p></div> | |
| </dd> | |
| <dt class="hdlist1"> | |
| http.sslVerify | |
| </dt> | |
| <dd> | |
| <p> | |
| Whether to verify the SSL certificate when fetching or pushing | |
| over HTTPS. Can be overridden by the <code>GIT_SSL_NO_VERIFY</code> environment | |
| variable. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| http.sslCert | |
| </dt> | |
| <dd> | |
| <p> | |
| File containing the SSL certificate when fetching or pushing | |
| over HTTPS. Can be overridden by the <code>GIT_SSL_CERT</code> environment | |
| variable. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| http.sslKey | |
| </dt> | |
| <dd> | |
| <p> | |
| File containing the SSL private key when fetching or pushing | |
| over HTTPS. Can be overridden by the <code>GIT_SSL_KEY</code> environment | |
| variable. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| http.sslCertPasswordProtected | |
| </dt> | |
| <dd> | |
| <p> | |
| Enable Git’s password prompt for the SSL certificate. Otherwise | |
| OpenSSL will prompt the user, possibly many times, if the | |
| certificate or private key is encrypted. Can be overridden by the | |
| <code>GIT_SSL_CERT_PASSWORD_PROTECTED</code> environment variable. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| http.sslCAInfo | |
| </dt> | |
| <dd> | |
| <p> | |
| File containing the certificates to verify the peer with when | |
| fetching or pushing over HTTPS. Can be overridden by the | |
| <code>GIT_SSL_CAINFO</code> environment variable. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| http.sslCAPath | |
| </dt> | |
| <dd> | |
| <p> | |
| Path containing files with the CA certificates to verify the peer | |
| with when fetching or pushing over HTTPS. Can be overridden | |
| by the <code>GIT_SSL_CAPATH</code> environment variable. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| http.pinnedpubkey | |
| </dt> | |
| <dd> | |
| <p> | |
| Public key of the https service. It may either be the filename of | |
| a PEM or DER encoded public key file or a string starting with | |
| <em>sha256//</em> followed by the base64 encoded sha256 hash of the | |
| public key. See also libcurl <em>CURLOPT_PINNEDPUBLICKEY</em>. git will | |
| exit with an error if this option is set but not supported by | |
| cURL. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| http.sslTry | |
| </dt> | |
| <dd> | |
| <p> | |
| Attempt to use AUTH SSL/TLS and encrypted data transfers | |
| when connecting via regular FTP protocol. This might be needed | |
| if the FTP server requires it for security reasons or you wish | |
| to connect securely whenever remote FTP server supports it. | |
| Default is false since it might trigger certificate verification | |
| errors on misconfigured servers. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| http.maxRequests | |
| </dt> | |
| <dd> | |
| <p> | |
| How many HTTP requests to launch in parallel. Can be overridden | |
| by the <code>GIT_HTTP_MAX_REQUESTS</code> environment variable. Default is 5. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| http.minSessions | |
| </dt> | |
| <dd> | |
| <p> | |
| The number of curl sessions (counted across slots) to be kept across | |
| requests. They will not be ended with curl_easy_cleanup() until | |
| http_cleanup() is invoked. If USE_CURL_MULTI is not defined, this | |
| value will be capped at 1. Defaults to 1. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| http.postBuffer | |
| </dt> | |
| <dd> | |
| <p> | |
| Maximum size in bytes of the buffer used by smart HTTP | |
| transports when POSTing data to the remote system. | |
| For requests larger than this buffer size, HTTP/1.1 and | |
| Transfer-Encoding: chunked is used to avoid creating a | |
| massive pack file locally. Default is 1 MiB, which is | |
| sufficient for most requests. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| http.lowSpeedLimit, http.lowSpeedTime | |
| </dt> | |
| <dd> | |
| <p> | |
| If the HTTP transfer speed is less than <em>http.lowSpeedLimit</em> | |
| for longer than <em>http.lowSpeedTime</em> seconds, the transfer is aborted. | |
| Can be overridden by the <code>GIT_HTTP_LOW_SPEED_LIMIT</code> and | |
| <code>GIT_HTTP_LOW_SPEED_TIME</code> environment variables. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| http.noEPSV | |
| </dt> | |
| <dd> | |
| <p> | |
| A boolean which disables using of EPSV ftp command by curl. | |
| This can helpful with some "poor" ftp servers which don’t | |
| support EPSV mode. Can be overridden by the <code>GIT_CURL_FTP_NO_EPSV</code> | |
| environment variable. Default is false (curl will use EPSV). | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| http.userAgent | |
| </dt> | |
| <dd> | |
| <p> | |
| The HTTP USER_AGENT string presented to an HTTP server. The default | |
| value represents the version of the client Git such as git/1.7.1. | |
| This option allows you to override this value to a more common value | |
| such as Mozilla/4.0. This may be necessary, for instance, if | |
| connecting through a firewall that restricts HTTP connections to a set | |
| of common USER_AGENT strings (but not including those like git/1.7.1). | |
| Can be overridden by the <code>GIT_HTTP_USER_AGENT</code> environment variable. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| http.<url>.* | |
| </dt> | |
| <dd> | |
| <p> | |
| Any of the http.* options above can be applied selectively to some URLs. | |
| For a config key to match a URL, each element of the config key is | |
| compared to that of the URL, in the following order: | |
| </p> | |
| <div class="openblock"> | |
| <div class="content"> | |
| <div class="olist arabic"><ol class="arabic"> | |
| <li> | |
| <p> | |
| Scheme (e.g., <code>https</code> in <code>https://example.com/</code>). This field | |
| must match exactly between the config key and the URL. | |
| </p> | |
| </li> | |
| <li> | |
| <p> | |
| Host/domain name (e.g., <code>example.com</code> in <code>https://example.com/</code>). | |
| This field must match exactly between the config key and the URL. | |
| </p> | |
| </li> | |
| <li> | |
| <p> | |
| Port number (e.g., <code>8080</code> in <code>http://example.com:8080/</code>). | |
| This field must match exactly between the config key and the URL. | |
| Omitted port numbers are automatically converted to the correct | |
| default for the scheme before matching. | |
| </p> | |
| </li> | |
| <li> | |
| <p> | |
| Path (e.g., <code>repo.git</code> in <code>https://example.com/repo.git</code>). The | |
| path field of the config key must match the path field of the URL | |
| either exactly or as a prefix of slash-delimited path elements. This means | |
| a config key with path <code>foo/</code> matches URL path <code>foo/bar</code>. A prefix can only | |
| match on a slash (<code>/</code>) boundary. Longer matches take precedence (so a config | |
| key with path <code>foo/bar</code> is a better match to URL path <code>foo/bar</code> than a config | |
| key with just path <code>foo/</code>). | |
| </p> | |
| </li> | |
| <li> | |
| <p> | |
| User name (e.g., <code>user</code> in <code>https://user@example.com/repo.git</code>). If | |
| the config key has a user name it must match the user name in the | |
| URL exactly. If the config key does not have a user name, that | |
| config key will match a URL with any user name (including none), | |
| but at a lower precedence than a config key with a user name. | |
| </p> | |
| </li> | |
| </ol></div> | |
| </div></div> | |
| <div class="paragraph"><p>The list above is ordered by decreasing precedence; a URL that matches | |
| a config key’s path is preferred to one that matches its user name. For example, | |
| if the URL is <code>https://user@example.com/foo/bar</code> a config key match of | |
| <code>https://example.com/foo</code> will be preferred over a config key match of | |
| <code>https://user@example.com</code>.</p></div> | |
| <div class="paragraph"><p>All URLs are normalized before attempting any matching (the password part, | |
| if embedded in the URL, is always ignored for matching purposes) so that | |
| equivalent URLs that are simply spelled differently will match properly. | |
| Environment variable settings always override any matches. The URLs that are | |
| matched against are those given directly to Git commands. This means any URLs | |
| visited as a result of a redirection do not participate in matching.</p></div> | |
| </dd> | |
| <dt class="hdlist1"> | |
| i18n.commitEncoding | |
| </dt> | |
| <dd> | |
| <p> | |
| Character encoding the commit messages are stored in; Git itself | |
| does not care per se, but this information is necessary e.g. when | |
| importing commits from emails or in the gitk graphical history | |
| browser (and possibly at other places in the future or in other | |
| porcelains). See e.g. <a href="git-mailinfo.html">git-mailinfo(1)</a>. Defaults to <em>utf-8</em>. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| i18n.logOutputEncoding | |
| </dt> | |
| <dd> | |
| <p> | |
| Character encoding the commit messages are converted to when | |
| running <em>git log</em> and friends. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| imap | |
| </dt> | |
| <dd> | |
| <p> | |
| The configuration variables in the <em>imap</em> section are described | |
| in <a href="git-imap-send.html">git-imap-send(1)</a>. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| index.version | |
| </dt> | |
| <dd> | |
| <p> | |
| Specify the version with which new index files should be | |
| initialized. This does not affect existing repositories. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| init.templateDir | |
| </dt> | |
| <dd> | |
| <p> | |
| Specify the directory from which templates will be copied. | |
| (See the "TEMPLATE DIRECTORY" section of <a href="git-init.html">git-init(1)</a>.) | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| instaweb.browser | |
| </dt> | |
| <dd> | |
| <p> | |
| Specify the program that will be used to browse your working | |
| repository in gitweb. See <a href="git-instaweb.html">git-instaweb(1)</a>. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| instaweb.httpd | |
| </dt> | |
| <dd> | |
| <p> | |
| The HTTP daemon command-line to start gitweb on your working | |
| repository. See <a href="git-instaweb.html">git-instaweb(1)</a>. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| instaweb.local | |
| </dt> | |
| <dd> | |
| <p> | |
| If true the web server started by <a href="git-instaweb.html">git-instaweb(1)</a> will | |
| be bound to the local IP (127.0.0.1). | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| instaweb.modulePath | |
| </dt> | |
| <dd> | |
| <p> | |
| The default module path for <a href="git-instaweb.html">git-instaweb(1)</a> to use | |
| instead of /usr/lib/apache2/modules. Only used if httpd | |
| is Apache. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| instaweb.port | |
| </dt> | |
| <dd> | |
| <p> | |
| The port number to bind the gitweb httpd to. See | |
| <a href="git-instaweb.html">git-instaweb(1)</a>. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| interactive.singleKey | |
| </dt> | |
| <dd> | |
| <p> | |
| In interactive commands, allow the user to provide one-letter | |
| input with a single key (i.e., without hitting enter). | |
| Currently this is used by the <code>--patch</code> mode of | |
| <a href="git-add.html">git-add(1)</a>, <a href="git-checkout.html">git-checkout(1)</a>, <a href="git-commit.html">git-commit(1)</a>, | |
| <a href="git-reset.html">git-reset(1)</a>, and <a href="git-stash.html">git-stash(1)</a>. Note that this | |
| setting is silently ignored if portable keystroke input | |
| is not available; requires the Perl module Term::ReadKey. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| interactive.diffFilter | |
| </dt> | |
| <dd> | |
| <p> | |
| When an interactive command (such as <code>git add --patch</code>) shows | |
| a colorized diff, git will pipe the diff through the shell | |
| command defined by this configuration variable. The command may | |
| mark up the diff further for human consumption, provided that it | |
| retains a one-to-one correspondence with the lines in the | |
| original diff. Defaults to disabled (no filtering). | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| log.abbrevCommit | |
| </dt> | |
| <dd> | |
| <p> | |
| If true, makes <a href="git-log.html">git-log(1)</a>, <a href="git-show.html">git-show(1)</a>, and | |
| <a href="git-whatchanged.html">git-whatchanged(1)</a> assume <code>--abbrev-commit</code>. You may | |
| override this option with <code>--no-abbrev-commit</code>. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| log.date | |
| </dt> | |
| <dd> | |
| <p> | |
| Set the default date-time mode for the <em>log</em> command. | |
| Setting a value for log.date is similar to using <em>git log</em>'s | |
| <code>--date</code> option. See <a href="git-log.html">git-log(1)</a> for details. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| log.decorate | |
| </dt> | |
| <dd> | |
| <p> | |
| Print out the ref names of any commits that are shown by the log | |
| command. If <em>short</em> is specified, the ref name prefixes <em>refs/heads/</em>, | |
| <em>refs/tags/</em> and <em>refs/remotes/</em> will not be printed. If <em>full</em> is | |
| specified, the full ref name (including prefix) will be printed. | |
| If <em>auto</em> is specified, then if the output is going to a terminal, | |
| the ref names are shown as if <em>short</em> were given, otherwise no ref | |
| names are shown. This is the same as the <code>--decorate</code> option | |
| of the <code>git log</code>. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| log.follow | |
| </dt> | |
| <dd> | |
| <p> | |
| If <code>true</code>, <code>git log</code> will act as if the <code>--follow</code> option was used when | |
| a single <path> is given. This has the same limitations as <code>--follow</code>, | |
| i.e. it cannot be used to follow multiple files and does not work well | |
| on non-linear history. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| log.showRoot | |
| </dt> | |
| <dd> | |
| <p> | |
| If true, the initial commit will be shown as a big creation event. | |
| This is equivalent to a diff against an empty tree. | |
| Tools like <a href="git-log.html">git-log(1)</a> or <a href="git-whatchanged.html">git-whatchanged(1)</a>, which | |
| normally hide the root commit will now show it. True by default. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| log.mailmap | |
| </dt> | |
| <dd> | |
| <p> | |
| If true, makes <a href="git-log.html">git-log(1)</a>, <a href="git-show.html">git-show(1)</a>, and | |
| <a href="git-whatchanged.html">git-whatchanged(1)</a> assume <code>--use-mailmap</code>. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| mailinfo.scissors | |
| </dt> | |
| <dd> | |
| <p> | |
| If true, makes <a href="git-mailinfo.html">git-mailinfo(1)</a> (and therefore | |
| <a href="git-am.html">git-am(1)</a>) act by default as if the --scissors option | |
| was provided on the command-line. When active, this features | |
| removes everything from the message body before a scissors | |
| line (i.e. consisting mainly of ">8", "8<" and "-"). | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| mailmap.file | |
| </dt> | |
| <dd> | |
| <p> | |
| The location of an augmenting mailmap file. The default | |
| mailmap, located in the root of the repository, is loaded | |
| first, then the mailmap file pointed to by this variable. | |
| The location of the mailmap file may be in a repository | |
| subdirectory, or somewhere outside of the repository itself. | |
| See <a href="git-shortlog.html">git-shortlog(1)</a> and <a href="git-blame.html">git-blame(1)</a>. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| mailmap.blob | |
| </dt> | |
| <dd> | |
| <p> | |
| Like <code>mailmap.file</code>, but consider the value as a reference to a | |
| blob in the repository. If both <code>mailmap.file</code> and | |
| <code>mailmap.blob</code> are given, both are parsed, with entries from | |
| <code>mailmap.file</code> taking precedence. In a bare repository, this | |
| defaults to <code>HEAD:.mailmap</code>. In a non-bare repository, it | |
| defaults to empty. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| man.viewer | |
| </dt> | |
| <dd> | |
| <p> | |
| Specify the programs that may be used to display help in the | |
| <em>man</em> format. See <a href="git-help.html">git-help(1)</a>. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| man.<tool>.cmd | |
| </dt> | |
| <dd> | |
| <p> | |
| Specify the command to invoke the specified man viewer. The | |
| specified command is evaluated in shell with the man page | |
| passed as argument. (See <a href="git-help.html">git-help(1)</a>.) | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| man.<tool>.path | |
| </dt> | |
| <dd> | |
| <p> | |
| Override the path for the given tool that may be used to | |
| display help in the <em>man</em> format. See <a href="git-help.html">git-help(1)</a>. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| merge.conflictStyle | |
| </dt> | |
| <dd> | |
| <p> | |
| Specify the style in which conflicted hunks are written out to | |
| working tree files upon merge. The default is "merge", which | |
| shows a <code><<<<<<<</code> conflict marker, changes made by one side, | |
| a <code>=======</code> marker, changes made by the other side, and then | |
| a <code>>>>>>>></code> marker. An alternate style, "diff3", adds a <code>|||||||</code> | |
| marker and the original text before the <code>=======</code> marker. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| merge.defaultToUpstream | |
| </dt> | |
| <dd> | |
| <p> | |
| If merge is called without any commit argument, merge the upstream | |
| branches configured for the current branch by using their last | |
| observed values stored in their remote-tracking branches. | |
| The values of the <code>branch.<current branch>.merge</code> that name the | |
| branches at the remote named by <code>branch.<current branch>.remote</code> | |
| are consulted, and then they are mapped via <code>remote.<remote>.fetch</code> | |
| to their corresponding remote-tracking branches, and the tips of | |
| these tracking branches are merged. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| merge.ff | |
| </dt> | |
| <dd> | |
| <p> | |
| By default, Git does not create an extra merge commit when merging | |
| a commit that is a descendant of the current commit. Instead, the | |
| tip of the current branch is fast-forwarded. When set to <code>false</code>, | |
| this variable tells Git to create an extra merge commit in such | |
| a case (equivalent to giving the <code>--no-ff</code> option from the command | |
| line). When set to <code>only</code>, only such fast-forward merges are | |
| allowed (equivalent to giving the <code>--ff-only</code> option from the | |
| command line). | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| merge.branchdesc | |
| </dt> | |
| <dd> | |
| <p> | |
| In addition to branch names, populate the log message with | |
| the branch description text associated with them. Defaults | |
| to false. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| merge.log | |
| </dt> | |
| <dd> | |
| <p> | |
| In addition to branch names, populate the log message with at | |
| most the specified number of one-line descriptions from the | |
| actual commits that are being merged. Defaults to false, and | |
| true is a synonym for 20. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| merge.renameLimit | |
| </dt> | |
| <dd> | |
| <p> | |
| The number of files to consider when performing rename detection | |
| during a merge; if not specified, defaults to the value of | |
| diff.renameLimit. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| merge.renormalize | |
| </dt> | |
| <dd> | |
| <p> | |
| Tell Git that canonical representation of files in the | |
| repository has changed over time (e.g. earlier commits record | |
| text files with CRLF line endings, but recent ones use LF line | |
| endings). In such a repository, Git can convert the data | |
| recorded in commits to a canonical form before performing a | |
| merge to reduce unnecessary conflicts. For more information, | |
| see section "Merging branches with differing checkin/checkout | |
| attributes" in <a href="gitattributes.html">gitattributes(5)</a>. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| merge.stat | |
| </dt> | |
| <dd> | |
| <p> | |
| Whether to print the diffstat between ORIG_HEAD and the merge result | |
| at the end of the merge. True by default. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| merge.tool | |
| </dt> | |
| <dd> | |
| <p> | |
| Controls which merge tool is used by <a href="git-mergetool.html">git-mergetool(1)</a>. | |
| The list below shows the valid built-in values. | |
| Any other value is treated as a custom merge tool and requires | |
| that a corresponding mergetool.<tool>.cmd variable is defined. | |
| </p> | |
| <div class="ulist"><ul> | |
| <li> | |
| <p> | |
| araxis | |
| </p> | |
| </li> | |
| <li> | |
| <p> | |
| bc | |
| </p> | |
| </li> | |
| <li> | |
| <p> | |
| bc3 | |
| </p> | |
| </li> | |
| <li> | |
| <p> | |
| codecompare | |
| </p> | |
| </li> | |
| <li> | |
| <p> | |
| deltawalker | |
| </p> | |
| </li> | |
| <li> | |
| <p> | |
| diffmerge | |
| </p> | |
| </li> | |
| <li> | |
| <p> | |
| diffuse | |
| </p> | |
| </li> | |
| <li> | |
| <p> | |
| ecmerge | |
| </p> | |
| </li> | |
| <li> | |
| <p> | |
| emerge | |
| </p> | |
| </li> | |
| <li> | |
| <p> | |
| examdiff | |
| </p> | |
| </li> | |
| <li> | |
| <p> | |
| gvimdiff | |
| </p> | |
| </li> | |
| <li> | |
| <p> | |
| gvimdiff2 | |
| </p> | |
| </li> | |
| <li> | |
| <p> | |
| gvimdiff3 | |
| </p> | |
| </li> | |
| <li> | |
| <p> | |
| kdiff3 | |
| </p> | |
| </li> | |
| <li> | |
| <p> | |
| meld | |
| </p> | |
| </li> | |
| <li> | |
| <p> | |
| opendiff | |
| </p> | |
| </li> | |
| <li> | |
| <p> | |
| p4merge | |
| </p> | |
| </li> | |
| <li> | |
| <p> | |
| tkdiff | |
| </p> | |
| </li> | |
| <li> | |
| <p> | |
| tortoisemerge | |
| </p> | |
| </li> | |
| <li> | |
| <p> | |
| vimdiff | |
| </p> | |
| </li> | |
| <li> | |
| <p> | |
| vimdiff2 | |
| </p> | |
| </li> | |
| <li> | |
| <p> | |
| vimdiff3 | |
| </p> | |
| </li> | |
| <li> | |
| <p> | |
| winmerge | |
| </p> | |
| </li> | |
| <li> | |
| <p> | |
| xxdiff | |
| </p> | |
| </li> | |
| </ul></div> | |
| </dd> | |
| <dt class="hdlist1"> | |
| merge.verbosity | |
| </dt> | |
| <dd> | |
| <p> | |
| Controls the amount of output shown by the recursive merge | |
| strategy. Level 0 outputs nothing except a final error | |
| message if conflicts were detected. Level 1 outputs only | |
| conflicts, 2 outputs conflicts and file changes. Level 5 and | |
| above outputs debugging information. The default is level 2. | |
| Can be overridden by the <code>GIT_MERGE_VERBOSITY</code> environment variable. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| merge.<driver>.name | |
| </dt> | |
| <dd> | |
| <p> | |
| Defines a human-readable name for a custom low-level | |
| merge driver. See <a href="gitattributes.html">gitattributes(5)</a> for details. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| merge.<driver>.driver | |
| </dt> | |
| <dd> | |
| <p> | |
| Defines the command that implements a custom low-level | |
| merge driver. See <a href="gitattributes.html">gitattributes(5)</a> for details. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| merge.<driver>.recursive | |
| </dt> | |
| <dd> | |
| <p> | |
| Names a low-level merge driver to be used when | |
| performing an internal merge between common ancestors. | |
| See <a href="gitattributes.html">gitattributes(5)</a> for details. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| mergetool.<tool>.path | |
| </dt> | |
| <dd> | |
| <p> | |
| Override the path for the given tool. This is useful in case | |
| your tool is not in the PATH. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| mergetool.<tool>.cmd | |
| </dt> | |
| <dd> | |
| <p> | |
| Specify the command to invoke the specified merge tool. The | |
| specified command is evaluated in shell with the following | |
| variables available: <em>BASE</em> is the name of a temporary file | |
| containing the common base of the files to be merged, if available; | |
| <em>LOCAL</em> is the name of a temporary file containing the contents of | |
| the file on the current branch; <em>REMOTE</em> is the name of a temporary | |
| file containing the contents of the file from the branch being | |
| merged; <em>MERGED</em> contains the name of the file to which the merge | |
| tool should write the results of a successful merge. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| mergetool.<tool>.trustExitCode | |
| </dt> | |
| <dd> | |
| <p> | |
| For a custom merge command, specify whether the exit code of | |
| the merge command can be used to determine whether the merge was | |
| successful. If this is not set to true then the merge target file | |
| timestamp is checked and the merge assumed to have been successful | |
| if the file has been updated, otherwise the user is prompted to | |
| indicate the success of the merge. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| mergetool.meld.hasOutput | |
| </dt> | |
| <dd> | |
| <p> | |
| Older versions of <code>meld</code> do not support the <code>--output</code> option. | |
| Git will attempt to detect whether <code>meld</code> supports <code>--output</code> | |
| by inspecting the output of <code>meld --help</code>. Configuring | |
| <code>mergetool.meld.hasOutput</code> will make Git skip these checks and | |
| use the configured value instead. Setting <code>mergetool.meld.hasOutput</code> | |
| to <code>true</code> tells Git to unconditionally use the <code>--output</code> option, | |
| and <code>false</code> avoids using <code>--output</code>. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| mergetool.keepBackup | |
| </dt> | |
| <dd> | |
| <p> | |
| After performing a merge, the original file with conflict markers | |
| can be saved as a file with a <code>.orig</code> extension. If this variable | |
| is set to <code>false</code> then this file is not preserved. Defaults to | |
| <code>true</code> (i.e. keep the backup files). | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| mergetool.keepTemporaries | |
| </dt> | |
| <dd> | |
| <p> | |
| When invoking a custom merge tool, Git uses a set of temporary | |
| files to pass to the tool. If the tool returns an error and this | |
| variable is set to <code>true</code>, then these temporary files will be | |
| preserved, otherwise they will be removed after the tool has | |
| exited. Defaults to <code>false</code>. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| mergetool.writeToTemp | |
| </dt> | |
| <dd> | |
| <p> | |
| Git writes temporary <em>BASE</em>, <em>LOCAL</em>, and <em>REMOTE</em> versions of | |
| conflicting files in the worktree by default. Git will attempt | |
| to use a temporary directory for these files when set <code>true</code>. | |
| Defaults to <code>false</code>. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| mergetool.prompt | |
| </dt> | |
| <dd> | |
| <p> | |
| Prompt before each invocation of the merge resolution program. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| notes.mergeStrategy | |
| </dt> | |
| <dd> | |
| <p> | |
| Which merge strategy to choose by default when resolving notes | |
| conflicts. Must be one of <code>manual</code>, <code>ours</code>, <code>theirs</code>, <code>union</code>, or | |
| <code>cat_sort_uniq</code>. Defaults to <code>manual</code>. See "NOTES MERGE STRATEGIES" | |
| section of <a href="git-notes.html">git-notes(1)</a> for more information on each strategy. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| notes.<name>.mergeStrategy | |
| </dt> | |
| <dd> | |
| <p> | |
| Which merge strategy to choose when doing a notes merge into | |
| refs/notes/<name>. This overrides the more general | |
| "notes.mergeStrategy". See the "NOTES MERGE STRATEGIES" section in | |
| <a href="git-notes.html">git-notes(1)</a> for more information on the available strategies. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| notes.displayRef | |
| </dt> | |
| <dd> | |
| <p> | |
| The (fully qualified) refname from which to show notes when | |
| showing commit messages. The value of this variable can be set | |
| to a glob, in which case notes from all matching refs will be | |
| shown. You may also specify this configuration variable | |
| several times. A warning will be issued for refs that do not | |
| exist, but a glob that does not match any refs is silently | |
| ignored. | |
| </p> | |
| <div class="paragraph"><p>This setting can be overridden with the <code>GIT_NOTES_DISPLAY_REF</code> | |
| environment variable, which must be a colon separated list of refs or | |
| globs.</p></div> | |
| <div class="paragraph"><p>The effective value of "core.notesRef" (possibly overridden by | |
| GIT_NOTES_REF) is also implicitly added to the list of refs to be | |
| displayed.</p></div> | |
| </dd> | |
| <dt class="hdlist1"> | |
| notes.rewrite.<command> | |
| </dt> | |
| <dd> | |
| <p> | |
| When rewriting commits with <command> (currently <code>amend</code> or | |
| <code>rebase</code>) and this variable is set to <code>true</code>, Git | |
| automatically copies your notes from the original to the | |
| rewritten commit. Defaults to <code>true</code>, but see | |
| "notes.rewriteRef" below. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| notes.rewriteMode | |
| </dt> | |
| <dd> | |
| <p> | |
| When copying notes during a rewrite (see the | |
| "notes.rewrite.<command>" option), determines what to do if | |
| the target commit already has a note. Must be one of | |
| <code>overwrite</code>, <code>concatenate</code>, <code>cat_sort_uniq</code>, or <code>ignore</code>. | |
| Defaults to <code>concatenate</code>. | |
| </p> | |
| <div class="paragraph"><p>This setting can be overridden with the <code>GIT_NOTES_REWRITE_MODE</code> | |
| environment variable.</p></div> | |
| </dd> | |
| <dt class="hdlist1"> | |
| notes.rewriteRef | |
| </dt> | |
| <dd> | |
| <p> | |
| When copying notes during a rewrite, specifies the (fully | |
| qualified) ref whose notes should be copied. The ref may be a | |
| glob, in which case notes in all matching refs will be copied. | |
| You may also specify this configuration several times. | |
| </p> | |
| <div class="paragraph"><p>Does not have a default value; you must configure this variable to | |
| enable note rewriting. Set it to <code>refs/notes/commits</code> to enable | |
| rewriting for the default commit notes.</p></div> | |
| <div class="paragraph"><p>This setting can be overridden with the <code>GIT_NOTES_REWRITE_REF</code> | |
| environment variable, which must be a colon separated list of refs or | |
| globs.</p></div> | |
| </dd> | |
| <dt class="hdlist1"> | |
| pack.window | |
| </dt> | |
| <dd> | |
| <p> | |
| The size of the window used by <a href="git-pack-objects.html">git-pack-objects(1)</a> when no | |
| window size is given on the command line. Defaults to 10. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| pack.depth | |
| </dt> | |
| <dd> | |
| <p> | |
| The maximum delta depth used by <a href="git-pack-objects.html">git-pack-objects(1)</a> when no | |
| maximum depth is given on the command line. Defaults to 50. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| pack.windowMemory | |
| </dt> | |
| <dd> | |
| <p> | |
| The maximum size of memory that is consumed by each thread | |
| in <a href="git-pack-objects.html">git-pack-objects(1)</a> for pack window memory when | |
| no limit is given on the command line. The value can be | |
| suffixed with "k", "m", or "g". When left unconfigured (or | |
| set explicitly to 0), there will be no limit. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| pack.compression | |
| </dt> | |
| <dd> | |
| <p> | |
| An integer -1..9, indicating the compression level for objects | |
| in a pack file. -1 is the zlib default. 0 means no | |
| compression, and 1..9 are various speed/size tradeoffs, 9 being | |
| slowest. If not set, defaults to core.compression. If that is | |
| not set, defaults to -1, the zlib default, which is "a default | |
| compromise between speed and compression (currently equivalent | |
| to level 6)." | |
| </p> | |
| <div class="paragraph"><p>Note that changing the compression level will not automatically recompress | |
| all existing objects. You can force recompression by passing the -F option | |
| to <a href="git-repack.html">git-repack(1)</a>.</p></div> | |
| </dd> | |
| <dt class="hdlist1"> | |
| pack.deltaCacheSize | |
| </dt> | |
| <dd> | |
| <p> | |
| The maximum memory in bytes used for caching deltas in | |
| <a href="git-pack-objects.html">git-pack-objects(1)</a> before writing them out to a pack. | |
| This cache is used to speed up the writing object phase by not | |
| having to recompute the final delta result once the best match | |
| for all objects is found. Repacking large repositories on machines | |
| which are tight with memory might be badly impacted by this though, | |
| especially if this cache pushes the system into swapping. | |
| A value of 0 means no limit. The smallest size of 1 byte may be | |
| used to virtually disable this cache. Defaults to 256 MiB. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| pack.deltaCacheLimit | |
| </dt> | |
| <dd> | |
| <p> | |
| The maximum size of a delta, that is cached in | |
| <a href="git-pack-objects.html">git-pack-objects(1)</a>. This cache is used to speed up the | |
| writing object phase by not having to recompute the final delta | |
| result once the best match for all objects is found. Defaults to 1000. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| pack.threads | |
| </dt> | |
| <dd> | |
| <p> | |
| Specifies the number of threads to spawn when searching for best | |
| delta matches. This requires that <a href="git-pack-objects.html">git-pack-objects(1)</a> | |
| be compiled with pthreads otherwise this option is ignored with a | |
| warning. This is meant to reduce packing time on multiprocessor | |
| machines. The required amount of memory for the delta search window | |
| is however multiplied by the number of threads. | |
| Specifying 0 will cause Git to auto-detect the number of CPU’s | |
| and set the number of threads accordingly. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| pack.indexVersion | |
| </dt> | |
| <dd> | |
| <p> | |
| Specify the default pack index version. Valid values are 1 for | |
| legacy pack index used by Git versions prior to 1.5.2, and 2 for | |
| the new pack index with capabilities for packs larger than 4 GB | |
| as well as proper protection against the repacking of corrupted | |
| packs. Version 2 is the default. Note that version 2 is enforced | |
| and this config option ignored whenever the corresponding pack is | |
| larger than 2 GB. | |
| </p> | |
| <div class="paragraph"><p>If you have an old Git that does not understand the version 2 <code>*.idx</code> file, | |
| cloning or fetching over a non native protocol (e.g. "http") | |
| that will copy both <code>*.pack</code> file and corresponding <code>*.idx</code> file from the | |
| other side may give you a repository that cannot be accessed with your | |
| older version of Git. If the <code>*.pack</code> file is smaller than 2 GB, however, | |
| you can use <a href="git-index-pack.html">git-index-pack(1)</a> on the *.pack file to regenerate | |
| the <code>*.idx</code> file.</p></div> | |
| </dd> | |
| <dt class="hdlist1"> | |
| pack.packSizeLimit | |
| </dt> | |
| <dd> | |
| <p> | |
| The maximum size of a pack. This setting only affects | |
| packing to a file when repacking, i.e. the git:// protocol | |
| is unaffected. It can be overridden by the <code>--max-pack-size</code> | |
| option of <a href="git-repack.html">git-repack(1)</a>. Reaching this limit results | |
| in the creation of multiple packfiles; which in turn prevents | |
| bitmaps from being created. | |
| The minimum size allowed is limited to 1 MiB. | |
| The default is unlimited. | |
| Common unit suffixes of <em>k</em>, <em>m</em>, or <em>g</em> are | |
| supported. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| pack.useBitmaps | |
| </dt> | |
| <dd> | |
| <p> | |
| When true, git will use pack bitmaps (if available) when packing | |
| to stdout (e.g., during the server side of a fetch). Defaults to | |
| true. You should not generally need to turn this off unless | |
| you are debugging pack bitmaps. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| pack.writeBitmaps (deprecated) | |
| </dt> | |
| <dd> | |
| <p> | |
| This is a deprecated synonym for <code>repack.writeBitmaps</code>. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| pack.writeBitmapHashCache | |
| </dt> | |
| <dd> | |
| <p> | |
| When true, git will include a "hash cache" section in the bitmap | |
| index (if one is written). This cache can be used to feed git’s | |
| delta heuristics, potentially leading to better deltas between | |
| bitmapped and non-bitmapped objects (e.g., when serving a fetch | |
| between an older, bitmapped pack and objects that have been | |
| pushed since the last gc). The downside is that it consumes 4 | |
| bytes per object of disk space, and that JGit’s bitmap | |
| implementation does not understand it, causing it to complain if | |
| Git and JGit are used on the same repository. Defaults to false. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| pager.<cmd> | |
| </dt> | |
| <dd> | |
| <p> | |
| If the value is boolean, turns on or off pagination of the | |
| output of a particular Git subcommand when writing to a tty. | |
| Otherwise, turns on pagination for the subcommand using the | |
| pager specified by the value of <code>pager.<cmd></code>. If <code>--paginate</code> | |
| or <code>--no-pager</code> is specified on the command line, it takes | |
| precedence over this option. To disable pagination for all | |
| commands, set <code>core.pager</code> or <code>GIT_PAGER</code> to <code>cat</code>. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| pretty.<name> | |
| </dt> | |
| <dd> | |
| <p> | |
| Alias for a --pretty= format string, as specified in | |
| <a href="git-log.html">git-log(1)</a>. Any aliases defined here can be used just | |
| as the built-in pretty formats could. For example, | |
| running <code>git config pretty.changelog "format:* %H %s"</code> | |
| would cause the invocation <code>git log --pretty=changelog</code> | |
| to be equivalent to running <code>git log "--pretty=format:* %H %s"</code>. | |
| Note that an alias with the same name as a built-in format | |
| will be silently ignored. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| pull.ff | |
| </dt> | |
| <dd> | |
| <p> | |
| By default, Git does not create an extra merge commit when merging | |
| a commit that is a descendant of the current commit. Instead, the | |
| tip of the current branch is fast-forwarded. When set to <code>false</code>, | |
| this variable tells Git to create an extra merge commit in such | |
| a case (equivalent to giving the <code>--no-ff</code> option from the command | |
| line). When set to <code>only</code>, only such fast-forward merges are | |
| allowed (equivalent to giving the <code>--ff-only</code> option from the | |
| command line). This setting overrides <code>merge.ff</code> when pulling. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| pull.rebase | |
| </dt> | |
| <dd> | |
| <p> | |
| When true, rebase branches on top of the fetched branch, instead | |
| of merging the default branch from the default remote when "git | |
| pull" is run. See "branch.<name>.rebase" for setting this on a | |
| per-branch basis. | |
| </p> | |
| <div class="paragraph"><p>When preserve, also pass <code>--preserve-merges</code> along to <em>git rebase</em> | |
| so that locally committed merge commits will not be flattened | |
| by running <em>git pull</em>.</p></div> | |
| <div class="paragraph"><p>When the value is <code>interactive</code>, the rebase is run in interactive mode.</p></div> | |
| <div class="paragraph"><p><strong>NOTE</strong>: this is a possibly dangerous operation; do <strong>not</strong> use | |
| it unless you understand the implications (see <a href="git-rebase.html">git-rebase(1)</a> | |
| for details).</p></div> | |
| </dd> | |
| <dt class="hdlist1"> | |
| pull.octopus | |
| </dt> | |
| <dd> | |
| <p> | |
| The default merge strategy to use when pulling multiple branches | |
| at once. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| pull.twohead | |
| </dt> | |
| <dd> | |
| <p> | |
| The default merge strategy to use when pulling a single branch. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| push.default | |
| </dt> | |
| <dd> | |
| <p> | |
| Defines the action <code>git push</code> should take if no refspec is | |
| explicitly given. Different values are well-suited for | |
| specific workflows; for instance, in a purely central workflow | |
| (i.e. the fetch source is equal to the push destination), | |
| <code>upstream</code> is probably what you want. Possible values are: | |
| </p> | |
| <div class="openblock"> | |
| <div class="content"> | |
| <div class="ulist"><ul> | |
| <li> | |
| <p> | |
| <code>nothing</code> - do not push anything (error out) unless a refspec is | |
| explicitly given. This is primarily meant for people who want to | |
| avoid mistakes by always being explicit. | |
| </p> | |
| </li> | |
| <li> | |
| <p> | |
| <code>current</code> - push the current branch to update a branch with the same | |
| name on the receiving end. Works in both central and non-central | |
| workflows. | |
| </p> | |
| </li> | |
| <li> | |
| <p> | |
| <code>upstream</code> - push the current branch back to the branch whose | |
| changes are usually integrated into the current branch (which is | |
| called <code>@{upstream}</code>). This mode only makes sense if you are | |
| pushing to the same repository you would normally pull from | |
| (i.e. central workflow). | |
| </p> | |
| </li> | |
| <li> | |
| <p> | |
| <code>simple</code> - in centralized workflow, work like <code>upstream</code> with an | |
| added safety to refuse to push if the upstream branch’s name is | |
| different from the local one. | |
| </p> | |
| <div class="paragraph"><p>When pushing to a remote that is different from the remote you normally | |
| pull from, work as <code>current</code>. This is the safest option and is suited | |
| for beginners.</p></div> | |
| <div class="paragraph"><p>This mode has become the default in Git 2.0.</p></div> | |
| </li> | |
| <li> | |
| <p> | |
| <code>matching</code> - push all branches having the same name on both ends. | |
| This makes the repository you are pushing to remember the set of | |
| branches that will be pushed out (e.g. if you always push <em>maint</em> | |
| and <em>master</em> there and no other branches, the repository you push | |
| to will have these two branches, and your local <em>maint</em> and | |
| <em>master</em> will be pushed there). | |
| </p> | |
| <div class="paragraph"><p>To use this mode effectively, you have to make sure <em>all</em> the | |
| branches you would push out are ready to be pushed out before | |
| running <em>git push</em>, as the whole point of this mode is to allow you | |
| to push all of the branches in one go. If you usually finish work | |
| on only one branch and push out the result, while other branches are | |
| unfinished, this mode is not for you. Also this mode is not | |
| suitable for pushing into a shared central repository, as other | |
| people may add new branches there, or update the tip of existing | |
| branches outside your control.</p></div> | |
| <div class="paragraph"><p>This used to be the default, but not since Git 2.0 (<code>simple</code> is the | |
| new default).</p></div> | |
| </li> | |
| </ul></div> | |
| </div></div> | |
| </dd> | |
| <dt class="hdlist1"> | |
| push.followTags | |
| </dt> | |
| <dd> | |
| <p> | |
| If set to true enable <code>--follow-tags</code> option by default. You | |
| may override this configuration at time of push by specifying | |
| <code>--no-follow-tags</code>. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| push.gpgSign | |
| </dt> | |
| <dd> | |
| <p> | |
| May be set to a boolean value, or the string <em>if-asked</em>. A true | |
| value causes all pushes to be GPG signed, as if <code>--signed</code> is | |
| passed to <a href="git-push.html">git-push(1)</a>. The string <em>if-asked</em> causes | |
| pushes to be signed if the server supports it, as if | |
| <code>--signed=if-asked</code> is passed to <em>git push</em>. A false value may | |
| override a value from a lower-priority config file. An explicit | |
| command-line flag always overrides this config option. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| push.recurseSubmodules | |
| </dt> | |
| <dd> | |
| <p> | |
| Make sure all submodule commits used by the revisions to be pushed | |
| are available on a remote-tracking branch. If the value is <em>check</em> | |
| then Git will verify that all submodule commits that changed in the | |
| revisions to be pushed are available on at least one remote of the | |
| submodule. If any commits are missing, the push will be aborted and | |
| exit with non-zero status. If the value is <em>on-demand</em> then all | |
| submodules that changed in the revisions to be pushed will be | |
| pushed. If on-demand was not able to push all necessary revisions | |
| it will also be aborted and exit with non-zero status. If the value | |
| is <em>no</em> then default behavior of ignoring submodules when pushing | |
| is retained. You may override this configuration at time of push by | |
| specifying <em>--recurse-submodules=check|on-demand|no</em>. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| rebase.stat | |
| </dt> | |
| <dd> | |
| <p> | |
| Whether to show a diffstat of what changed upstream since the last | |
| rebase. False by default. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| rebase.autoSquash | |
| </dt> | |
| <dd> | |
| <p> | |
| If set to true enable <code>--autosquash</code> option by default. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| rebase.autoStash | |
| </dt> | |
| <dd> | |
| <p> | |
| When set to true, automatically create a temporary stash | |
| before the operation begins, and apply it after the operation | |
| ends. This means that you can run rebase on a dirty worktree. | |
| However, use with care: the final stash application after a | |
| successful rebase might result in non-trivial conflicts. | |
| Defaults to false. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| rebase.missingCommitsCheck | |
| </dt> | |
| <dd> | |
| <p> | |
| If set to "warn", git rebase -i will print a warning if some | |
| commits are removed (e.g. a line was deleted), however the | |
| rebase will still proceed. If set to "error", it will print | |
| the previous warning and stop the rebase, <em>git rebase | |
| --edit-todo</em> can then be used to correct the error. If set to | |
| "ignore", no checking is done. | |
| To drop a commit without warning or error, use the <code>drop</code> | |
| command in the todo-list. | |
| Defaults to "ignore". | |
| </p> | |
| </dd> | |
| </dl></div> | |
| <div class="paragraph"><p>rebase.instructionFormat | |
| A format string, as specified in <a href="git-log.html">git-log(1)</a>, to be used for | |
| the instruction list during an interactive rebase. The format will automatically | |
| have the long commit hash prepended to the format.</p></div> | |
| <div class="dlist"><dl> | |
| <dt class="hdlist1"> | |
| receive.advertiseAtomic | |
| </dt> | |
| <dd> | |
| <p> | |
| By default, git-receive-pack will advertise the atomic push | |
| capability to its clients. If you don’t want to advertise this | |
| capability, set this variable to false. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| receive.advertisePushOptions | |
| </dt> | |
| <dd> | |
| <p> | |
| By default, git-receive-pack will advertise the push options | |
| capability to its clients. If you don’t want to advertise this | |
| capability, set this variable to false. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| receive.autogc | |
| </dt> | |
| <dd> | |
| <p> | |
| By default, git-receive-pack will run "git-gc --auto" after | |
| receiving data from git-push and updating refs. You can stop | |
| it by setting this variable to false. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| receive.certNonceSeed | |
| </dt> | |
| <dd> | |
| <p> | |
| By setting this variable to a string, <code>git receive-pack</code> | |
| will accept a <code>git push --signed</code> and verifies it by using | |
| a "nonce" protected by HMAC using this string as a secret | |
| key. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| receive.certNonceSlop | |
| </dt> | |
| <dd> | |
| <p> | |
| When a <code>git push --signed</code> sent a push certificate with a | |
| "nonce" that was issued by a receive-pack serving the same | |
| repository within this many seconds, export the "nonce" | |
| found in the certificate to <code>GIT_PUSH_CERT_NONCE</code> to the | |
| hooks (instead of what the receive-pack asked the sending | |
| side to include). This may allow writing checks in | |
| <code>pre-receive</code> and <code>post-receive</code> a bit easier. Instead of | |
| checking <code>GIT_PUSH_CERT_NONCE_SLOP</code> environment variable | |
| that records by how many seconds the nonce is stale to | |
| decide if they want to accept the certificate, they only | |
| can check <code>GIT_PUSH_CERT_NONCE_STATUS</code> is <code>OK</code>. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| receive.fsckObjects | |
| </dt> | |
| <dd> | |
| <p> | |
| If it is set to true, git-receive-pack will check all received | |
| objects. It will abort in the case of a malformed object or a | |
| broken link. The result of an abort are only dangling objects. | |
| Defaults to false. If not set, the value of <code>transfer.fsckObjects</code> | |
| is used instead. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| receive.fsck.<msg-id> | |
| </dt> | |
| <dd> | |
| <p> | |
| When <code>receive.fsckObjects</code> is set to true, errors can be switched | |
| to warnings and vice versa by configuring the <code>receive.fsck.<msg-id></code> | |
| setting where the <code><msg-id></code> is the fsck message ID and the value | |
| is one of <code>error</code>, <code>warn</code> or <code>ignore</code>. For convenience, fsck prefixes | |
| the error/warning with the message ID, e.g. "missingEmail: invalid | |
| author/committer line - missing email" means that setting | |
| <code>receive.fsck.missingEmail = ignore</code> will hide that issue. | |
| </p> | |
| <div class="paragraph"><p>This feature is intended to support working with legacy repositories | |
| which would not pass pushing when <code>receive.fsckObjects = true</code>, allowing | |
| the host to accept repositories with certain known issues but still catch | |
| other issues.</p></div> | |
| </dd> | |
| <dt class="hdlist1"> | |
| receive.fsck.skipList | |
| </dt> | |
| <dd> | |
| <p> | |
| The path to a sorted list of object names (i.e. one SHA-1 per | |
| line) that are known to be broken in a non-fatal way and should | |
| be ignored. This feature is useful when an established project | |
| should be accepted despite early commits containing errors that | |
| can be safely ignored such as invalid committer email addresses. | |
| Note: corrupt objects cannot be skipped with this setting. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| receive.keepAlive | |
| </dt> | |
| <dd> | |
| <p> | |
| After receiving the pack from the client, <code>receive-pack</code> may | |
| produce no output (if <code>--quiet</code> was specified) while processing | |
| the pack, causing some networks to drop the TCP connection. | |
| With this option set, if <code>receive-pack</code> does not transmit | |
| any data in this phase for <code>receive.keepAlive</code> seconds, it will | |
| send a short keepalive packet. The default is 5 seconds; set | |
| to 0 to disable keepalives entirely. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| receive.unpackLimit | |
| </dt> | |
| <dd> | |
| <p> | |
| If the number of objects received in a push is below this | |
| limit then the objects will be unpacked into loose object | |
| files. However if the number of received objects equals or | |
| exceeds this limit then the received pack will be stored as | |
| a pack, after adding any missing delta bases. Storing the | |
| pack from a push can make the push operation complete faster, | |
| especially on slow filesystems. If not set, the value of | |
| <code>transfer.unpackLimit</code> is used instead. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| receive.denyDeletes | |
| </dt> | |
| <dd> | |
| <p> | |
| If set to true, git-receive-pack will deny a ref update that deletes | |
| the ref. Use this to prevent such a ref deletion via a push. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| receive.denyDeleteCurrent | |
| </dt> | |
| <dd> | |
| <p> | |
| If set to true, git-receive-pack will deny a ref update that | |
| deletes the currently checked out branch of a non-bare repository. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| receive.denyCurrentBranch | |
| </dt> | |
| <dd> | |
| <p> | |
| If set to true or "refuse", git-receive-pack will deny a ref update | |
| to the currently checked out branch of a non-bare repository. | |
| Such a push is potentially dangerous because it brings the HEAD | |
| out of sync with the index and working tree. If set to "warn", | |
| print a warning of such a push to stderr, but allow the push to | |
| proceed. If set to false or "ignore", allow such pushes with no | |
| message. Defaults to "refuse". | |
| </p> | |
| <div class="paragraph"><p>Another option is "updateInstead" which will update the working | |
| tree if pushing into the current branch. This option is | |
| intended for synchronizing working directories when one side is not easily | |
| accessible via interactive ssh (e.g. a live web site, hence the requirement | |
| that the working directory be clean). This mode also comes in handy when | |
| developing inside a VM to test and fix code on different Operating Systems.</p></div> | |
| <div class="paragraph"><p>By default, "updateInstead" will refuse the push if the working tree or | |
| the index have any difference from the HEAD, but the <code>push-to-checkout</code> | |
| hook can be used to customize this. See <a href="githooks.html">githooks(5)</a>.</p></div> | |
| </dd> | |
| <dt class="hdlist1"> | |
| receive.denyNonFastForwards | |
| </dt> | |
| <dd> | |
| <p> | |
| If set to true, git-receive-pack will deny a ref update which is | |
| not a fast-forward. Use this to prevent such an update via a push, | |
| even if that push is forced. This configuration variable is | |
| set when initializing a shared repository. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| receive.hideRefs | |
| </dt> | |
| <dd> | |
| <p> | |
| This variable is the same as <code>transfer.hideRefs</code>, but applies | |
| only to <code>receive-pack</code> (and so affects pushes, but not fetches). | |
| An attempt to update or delete a hidden ref by <code>git push</code> is | |
| rejected. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| receive.updateServerInfo | |
| </dt> | |
| <dd> | |
| <p> | |
| If set to true, git-receive-pack will run git-update-server-info | |
| after receiving data from git-push and updating refs. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| receive.shallowUpdate | |
| </dt> | |
| <dd> | |
| <p> | |
| If set to true, .git/shallow can be updated when new refs | |
| require new shallow roots. Otherwise those refs are rejected. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| remote.pushDefault | |
| </dt> | |
| <dd> | |
| <p> | |
| The remote to push to by default. Overrides | |
| <code>branch.<name>.remote</code> for all branches, and is overridden by | |
| <code>branch.<name>.pushRemote</code> for specific branches. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| remote.<name>.url | |
| </dt> | |
| <dd> | |
| <p> | |
| The URL of a remote repository. See <a href="git-fetch.html">git-fetch(1)</a> or | |
| <a href="git-push.html">git-push(1)</a>. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| remote.<name>.pushurl | |
| </dt> | |
| <dd> | |
| <p> | |
| The push URL of a remote repository. See <a href="git-push.html">git-push(1)</a>. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| remote.<name>.proxy | |
| </dt> | |
| <dd> | |
| <p> | |
| For remotes that require curl (http, https and ftp), the URL to | |
| the proxy to use for that remote. Set to the empty string to | |
| disable proxying for that remote. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| remote.<name>.proxyAuthMethod | |
| </dt> | |
| <dd> | |
| <p> | |
| For remotes that require curl (http, https and ftp), the method to use for | |
| authenticating against the proxy in use (probably set in | |
| <code>remote.<name>.proxy</code>). See <code>http.proxyAuthMethod</code>. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| remote.<name>.fetch | |
| </dt> | |
| <dd> | |
| <p> | |
| The default set of "refspec" for <a href="git-fetch.html">git-fetch(1)</a>. See | |
| <a href="git-fetch.html">git-fetch(1)</a>. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| remote.<name>.push | |
| </dt> | |
| <dd> | |
| <p> | |
| The default set of "refspec" for <a href="git-push.html">git-push(1)</a>. See | |
| <a href="git-push.html">git-push(1)</a>. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| remote.<name>.mirror | |
| </dt> | |
| <dd> | |
| <p> | |
| If true, pushing to this remote will automatically behave | |
| as if the <code>--mirror</code> option was given on the command line. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| remote.<name>.skipDefaultUpdate | |
| </dt> | |
| <dd> | |
| <p> | |
| If true, this remote will be skipped by default when updating | |
| using <a href="git-fetch.html">git-fetch(1)</a> or the <code>update</code> subcommand of | |
| <a href="git-remote.html">git-remote(1)</a>. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| remote.<name>.skipFetchAll | |
| </dt> | |
| <dd> | |
| <p> | |
| If true, this remote will be skipped by default when updating | |
| using <a href="git-fetch.html">git-fetch(1)</a> or the <code>update</code> subcommand of | |
| <a href="git-remote.html">git-remote(1)</a>. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| remote.<name>.receivepack | |
| </dt> | |
| <dd> | |
| <p> | |
| The default program to execute on the remote side when pushing. See | |
| option --receive-pack of <a href="git-push.html">git-push(1)</a>. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| remote.<name>.uploadpack | |
| </dt> | |
| <dd> | |
| <p> | |
| The default program to execute on the remote side when fetching. See | |
| option --upload-pack of <a href="git-fetch-pack.html">git-fetch-pack(1)</a>. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| remote.<name>.tagOpt | |
| </dt> | |
| <dd> | |
| <p> | |
| Setting this value to --no-tags disables automatic tag following when | |
| fetching from remote <name>. Setting it to --tags will fetch every | |
| tag from remote <name>, even if they are not reachable from remote | |
| branch heads. Passing these flags directly to <a href="git-fetch.html">git-fetch(1)</a> can | |
| override this setting. See options --tags and --no-tags of | |
| <a href="git-fetch.html">git-fetch(1)</a>. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| remote.<name>.vcs | |
| </dt> | |
| <dd> | |
| <p> | |
| Setting this to a value <vcs> will cause Git to interact with | |
| the remote with the git-remote-<vcs> helper. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| remote.<name>.prune | |
| </dt> | |
| <dd> | |
| <p> | |
| When set to true, fetching from this remote by default will also | |
| remove any remote-tracking references that no longer exist on the | |
| remote (as if the <code>--prune</code> option was given on the command line). | |
| Overrides <code>fetch.prune</code> settings, if any. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| remotes.<group> | |
| </dt> | |
| <dd> | |
| <p> | |
| The list of remotes which are fetched by "git remote update | |
| <group>". See <a href="git-remote.html">git-remote(1)</a>. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| repack.useDeltaBaseOffset | |
| </dt> | |
| <dd> | |
| <p> | |
| By default, <a href="git-repack.html">git-repack(1)</a> creates packs that use | |
| delta-base offset. If you need to share your repository with | |
| Git older than version 1.4.4, either directly or via a dumb | |
| protocol such as http, then you need to set this option to | |
| "false" and repack. Access from old Git versions over the | |
| native protocol are unaffected by this option. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| repack.packKeptObjects | |
| </dt> | |
| <dd> | |
| <p> | |
| If set to true, makes <code>git repack</code> act as if | |
| <code>--pack-kept-objects</code> was passed. See <a href="git-repack.html">git-repack(1)</a> for | |
| details. Defaults to <code>false</code> normally, but <code>true</code> if a bitmap | |
| index is being written (either via <code>--write-bitmap-index</code> or | |
| <code>repack.writeBitmaps</code>). | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| repack.writeBitmaps | |
| </dt> | |
| <dd> | |
| <p> | |
| When true, git will write a bitmap index when packing all | |
| objects to disk (e.g., when <code>git repack -a</code> is run). This | |
| index can speed up the "counting objects" phase of subsequent | |
| packs created for clones and fetches, at the cost of some disk | |
| space and extra time spent on the initial repack. This has | |
| no effect if multiple packfiles are created. | |
| Defaults to false. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| rerere.autoUpdate | |
| </dt> | |
| <dd> | |
| <p> | |
| When set to true, <code>git-rerere</code> updates the index with the | |
| resulting contents after it cleanly resolves conflicts using | |
| previously recorded resolution. Defaults to false. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| rerere.enabled | |
| </dt> | |
| <dd> | |
| <p> | |
| Activate recording of resolved conflicts, so that identical | |
| conflict hunks can be resolved automatically, should they be | |
| encountered again. By default, <a href="git-rerere.html">git-rerere(1)</a> is | |
| enabled if there is an <code>rr-cache</code> directory under the | |
| <code>$GIT_DIR</code>, e.g. if "rerere" was previously used in the | |
| repository. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| sendemail.identity | |
| </dt> | |
| <dd> | |
| <p> | |
| A configuration identity. When given, causes values in the | |
| <em>sendemail.<identity></em> subsection to take precedence over | |
| values in the <em>sendemail</em> section. The default identity is | |
| the value of <code>sendemail.identity</code>. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| sendemail.smtpEncryption | |
| </dt> | |
| <dd> | |
| <p> | |
| See <a href="git-send-email.html">git-send-email(1)</a> for description. Note that this | |
| setting is not subject to the <em>identity</em> mechanism. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| sendemail.smtpssl (deprecated) | |
| </dt> | |
| <dd> | |
| <p> | |
| Deprecated alias for <em>sendemail.smtpEncryption = ssl</em>. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| sendemail.smtpsslcertpath | |
| </dt> | |
| <dd> | |
| <p> | |
| Path to ca-certificates (either a directory or a single file). | |
| Set it to an empty string to disable certificate verification. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| sendemail.<identity>.* | |
| </dt> | |
| <dd> | |
| <p> | |
| Identity-specific versions of the <em>sendemail.*</em> parameters | |
| found below, taking precedence over those when the this | |
| identity is selected, through command-line or | |
| <code>sendemail.identity</code>. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| sendemail.aliasesFile | |
| </dt> | |
| <dt class="hdlist1"> | |
| sendemail.aliasFileType | |
| </dt> | |
| <dt class="hdlist1"> | |
| sendemail.annotate | |
| </dt> | |
| <dt class="hdlist1"> | |
| sendemail.bcc | |
| </dt> | |
| <dt class="hdlist1"> | |
| sendemail.cc | |
| </dt> | |
| <dt class="hdlist1"> | |
| sendemail.ccCmd | |
| </dt> | |
| <dt class="hdlist1"> | |
| sendemail.chainReplyTo | |
| </dt> | |
| <dt class="hdlist1"> | |
| sendemail.confirm | |
| </dt> | |
| <dt class="hdlist1"> | |
| sendemail.envelopeSender | |
| </dt> | |
| <dt class="hdlist1"> | |
| sendemail.from | |
| </dt> | |
| <dt class="hdlist1"> | |
| sendemail.multiEdit | |
| </dt> | |
| <dt class="hdlist1"> | |
| sendemail.signedoffbycc | |
| </dt> | |
| <dt class="hdlist1"> | |
| sendemail.smtpPass | |
| </dt> | |
| <dt class="hdlist1"> | |
| sendemail.suppresscc | |
| </dt> | |
| <dt class="hdlist1"> | |
| sendemail.suppressFrom | |
| </dt> | |
| <dt class="hdlist1"> | |
| sendemail.to | |
| </dt> | |
| <dt class="hdlist1"> | |
| sendemail.smtpDomain | |
| </dt> | |
| <dt class="hdlist1"> | |
| sendemail.smtpServer | |
| </dt> | |
| <dt class="hdlist1"> | |
| sendemail.smtpServerPort | |
| </dt> | |
| <dt class="hdlist1"> | |
| sendemail.smtpServerOption | |
| </dt> | |
| <dt class="hdlist1"> | |
| sendemail.smtpUser | |
| </dt> | |
| <dt class="hdlist1"> | |
| sendemail.thread | |
| </dt> | |
| <dt class="hdlist1"> | |
| sendemail.transferEncoding | |
| </dt> | |
| <dt class="hdlist1"> | |
| sendemail.validate | |
| </dt> | |
| <dt class="hdlist1"> | |
| sendemail.xmailer | |
| </dt> | |
| <dd> | |
| <p> | |
| See <a href="git-send-email.html">git-send-email(1)</a> for description. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| sendemail.signedoffcc (deprecated) | |
| </dt> | |
| <dd> | |
| <p> | |
| Deprecated alias for <code>sendemail.signedoffbycc</code>. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| showbranch.default | |
| </dt> | |
| <dd> | |
| <p> | |
| The default set of branches for <a href="git-show-branch.html">git-show-branch(1)</a>. | |
| See <a href="git-show-branch.html">git-show-branch(1)</a>. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| status.relativePaths | |
| </dt> | |
| <dd> | |
| <p> | |
| By default, <a href="git-status.html">git-status(1)</a> shows paths relative to the | |
| current directory. Setting this variable to <code>false</code> shows paths | |
| relative to the repository root (this was the default for Git | |
| prior to v1.5.4). | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| status.short | |
| </dt> | |
| <dd> | |
| <p> | |
| Set to true to enable --short by default in <a href="git-status.html">git-status(1)</a>. | |
| The option --no-short takes precedence over this variable. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| status.branch | |
| </dt> | |
| <dd> | |
| <p> | |
| Set to true to enable --branch by default in <a href="git-status.html">git-status(1)</a>. | |
| The option --no-branch takes precedence over this variable. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| status.displayCommentPrefix | |
| </dt> | |
| <dd> | |
| <p> | |
| If set to true, <a href="git-status.html">git-status(1)</a> will insert a comment | |
| prefix before each output line (starting with | |
| <code>core.commentChar</code>, i.e. <code>#</code> by default). This was the | |
| behavior of <a href="git-status.html">git-status(1)</a> in Git 1.8.4 and previous. | |
| Defaults to false. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| status.showUntrackedFiles | |
| </dt> | |
| <dd> | |
| <p> | |
| By default, <a href="git-status.html">git-status(1)</a> and <a href="git-commit.html">git-commit(1)</a> show | |
| files which are not currently tracked by Git. Directories which | |
| contain only untracked files, are shown with the directory name | |
| only. Showing untracked files means that Git needs to lstat() all | |
| the files in the whole repository, which might be slow on some | |
| systems. So, this variable controls how the commands displays | |
| the untracked files. Possible values are: | |
| </p> | |
| <div class="openblock"> | |
| <div class="content"> | |
| <div class="ulist"><ul> | |
| <li> | |
| <p> | |
| <code>no</code> - Show no untracked files. | |
| </p> | |
| </li> | |
| <li> | |
| <p> | |
| <code>normal</code> - Show untracked files and directories. | |
| </p> | |
| </li> | |
| <li> | |
| <p> | |
| <code>all</code> - Show also individual files in untracked directories. | |
| </p> | |
| </li> | |
| </ul></div> | |
| </div></div> | |
| <div class="paragraph"><p>If this variable is not specified, it defaults to <em>normal</em>. | |
| This variable can be overridden with the -u|--untracked-files option | |
| of <a href="git-status.html">git-status(1)</a> and <a href="git-commit.html">git-commit(1)</a>.</p></div> | |
| </dd> | |
| <dt class="hdlist1"> | |
| status.submoduleSummary | |
| </dt> | |
| <dd> | |
| <p> | |
| Defaults to false. | |
| If this is set to a non zero number or true (identical to -1 or an | |
| unlimited number), the submodule summary will be enabled and a | |
| summary of commits for modified submodules will be shown (see | |
| --summary-limit option of <a href="git-submodule.html">git-submodule(1)</a>). Please note | |
| that the summary output command will be suppressed for all | |
| submodules when <code>diff.ignoreSubmodules</code> is set to <em>all</em> or only | |
| for those submodules where <code>submodule.<name>.ignore=all</code>. The only | |
| exception to that rule is that status and commit will show staged | |
| submodule changes. To | |
| also view the summary for ignored submodules you can either use | |
| the --ignore-submodules=dirty command-line option or the <em>git | |
| submodule summary</em> command, which shows a similar output but does | |
| not honor these settings. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| stash.showPatch | |
| </dt> | |
| <dd> | |
| <p> | |
| If this is set to true, the <code>git stash show</code> command without an | |
| option will show the stash in patch form. Defaults to false. | |
| See description of <em>show</em> command in <a href="git-stash.html">git-stash(1)</a>. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| stash.showStat | |
| </dt> | |
| <dd> | |
| <p> | |
| If this is set to true, the <code>git stash show</code> command without an | |
| option will show diffstat of the stash. Defaults to true. | |
| See description of <em>show</em> command in <a href="git-stash.html">git-stash(1)</a>. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| submodule.<name>.path | |
| </dt> | |
| <dt class="hdlist1"> | |
| submodule.<name>.url | |
| </dt> | |
| <dd> | |
| <p> | |
| The path within this project and URL for a submodule. These | |
| variables are initially populated by <em>git submodule init</em>. See | |
| <a href="git-submodule.html">git-submodule(1)</a> and <a href="gitmodules.html">gitmodules(5)</a> for | |
| details. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| submodule.<name>.update | |
| </dt> | |
| <dd> | |
| <p> | |
| The default update procedure for a submodule. This variable | |
| is populated by <code>git submodule init</code> from the | |
| <a href="gitmodules.html">gitmodules(5)</a> file. See description of <em>update</em> | |
| command in <a href="git-submodule.html">git-submodule(1)</a>. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| submodule.<name>.branch | |
| </dt> | |
| <dd> | |
| <p> | |
| The remote branch name for a submodule, used by <code>git submodule | |
| update --remote</code>. Set this option to override the value found in | |
| the <code>.gitmodules</code> file. See <a href="git-submodule.html">git-submodule(1)</a> and | |
| <a href="gitmodules.html">gitmodules(5)</a> for details. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| submodule.<name>.fetchRecurseSubmodules | |
| </dt> | |
| <dd> | |
| <p> | |
| This option can be used to control recursive fetching of this | |
| submodule. It can be overridden by using the --[no-]recurse-submodules | |
| command-line option to "git fetch" and "git pull". | |
| This setting will override that from in the <a href="gitmodules.html">gitmodules(5)</a> | |
| file. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| submodule.<name>.ignore | |
| </dt> | |
| <dd> | |
| <p> | |
| Defines under what circumstances "git status" and the diff family show | |
| a submodule as modified. When set to "all", it will never be considered | |
| modified (but it will nonetheless show up in the output of status and | |
| commit when it has been staged), "dirty" will ignore all changes | |
| to the submodules work tree and | |
| takes only differences between the HEAD of the submodule and the commit | |
| recorded in the superproject into account. "untracked" will additionally | |
| let submodules with modified tracked files in their work tree show up. | |
| Using "none" (the default when this option is not set) also shows | |
| submodules that have untracked files in their work tree as changed. | |
| This setting overrides any setting made in .gitmodules for this submodule, | |
| both settings can be overridden on the command line by using the | |
| "--ignore-submodules" option. The <em>git submodule</em> commands are not | |
| affected by this setting. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| submodule.fetchJobs | |
| </dt> | |
| <dd> | |
| <p> | |
| Specifies how many submodules are fetched/cloned at the same time. | |
| A positive integer allows up to that number of submodules fetched | |
| in parallel. A value of 0 will give some reasonable default. | |
| If unset, it defaults to 1. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| tag.forceSignAnnotated | |
| </dt> | |
| <dd> | |
| <p> | |
| A boolean to specify whether annotated tags created should be GPG signed. | |
| If <code>--annotate</code> is specified on the command line, it takes | |
| precedence over this option. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| tag.sort | |
| </dt> | |
| <dd> | |
| <p> | |
| This variable controls the sort ordering of tags when displayed by | |
| <a href="git-tag.html">git-tag(1)</a>. Without the "--sort=<value>" option provided, the | |
| value of this variable will be used as the default. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| tar.umask | |
| </dt> | |
| <dd> | |
| <p> | |
| This variable can be used to restrict the permission bits of | |
| tar archive entries. The default is 0002, which turns off the | |
| world write bit. The special value "user" indicates that the | |
| archiving user’s umask will be used instead. See umask(2) and | |
| <a href="git-archive.html">git-archive(1)</a>. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| transfer.fsckObjects | |
| </dt> | |
| <dd> | |
| <p> | |
| When <code>fetch.fsckObjects</code> or <code>receive.fsckObjects</code> are | |
| not set, the value of this variable is used instead. | |
| Defaults to false. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| transfer.hideRefs | |
| </dt> | |
| <dd> | |
| <p> | |
| String(s) <code>receive-pack</code> and <code>upload-pack</code> use to decide which | |
| refs to omit from their initial advertisements. Use more than | |
| one definition to specify multiple prefix strings. A ref that is | |
| under the hierarchies listed in the value of this variable is | |
| excluded, and is hidden when responding to <code>git push</code> or <code>git | |
| fetch</code>. See <code>receive.hideRefs</code> and <code>uploadpack.hideRefs</code> for | |
| program-specific versions of this config. | |
| </p> | |
| <div class="paragraph"><p>You may also include a <code>!</code> in front of the ref name to negate the entry, | |
| explicitly exposing it, even if an earlier entry marked it as hidden. | |
| If you have multiple hideRefs values, later entries override earlier ones | |
| (and entries in more-specific config files override less-specific ones).</p></div> | |
| <div class="paragraph"><p>If a namespace is in use, the namespace prefix is stripped from each | |
| reference before it is matched against <code>transfer.hiderefs</code> patterns. | |
| For example, if <code>refs/heads/master</code> is specified in <code>transfer.hideRefs</code> and | |
| the current namespace is <code>foo</code>, then <code>refs/namespaces/foo/refs/heads/master</code> | |
| is omitted from the advertisements but <code>refs/heads/master</code> and | |
| <code>refs/namespaces/bar/refs/heads/master</code> are still advertised as so-called | |
| "have" lines. In order to match refs before stripping, add a <code>^</code> in front of | |
| the ref name. If you combine <code>!</code> and <code>^</code>, <code>!</code> must be specified first.</p></div> | |
| </dd> | |
| <dt class="hdlist1"> | |
| transfer.unpackLimit | |
| </dt> | |
| <dd> | |
| <p> | |
| When <code>fetch.unpackLimit</code> or <code>receive.unpackLimit</code> are | |
| not set, the value of this variable is used instead. | |
| The default value is 100. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| uploadarchive.allowUnreachable | |
| </dt> | |
| <dd> | |
| <p> | |
| If true, allow clients to use <code>git archive --remote</code> to request | |
| any tree, whether reachable from the ref tips or not. See the | |
| discussion in the <code>SECURITY</code> section of | |
| <a href="git-upload-archive.html">git-upload-archive(1)</a> for more details. Defaults to | |
| <code>false</code>. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| uploadpack.hideRefs | |
| </dt> | |
| <dd> | |
| <p> | |
| This variable is the same as <code>transfer.hideRefs</code>, but applies | |
| only to <code>upload-pack</code> (and so affects only fetches, not pushes). | |
| An attempt to fetch a hidden ref by <code>git fetch</code> will fail. See | |
| also <code>uploadpack.allowTipSHA1InWant</code>. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| uploadpack.allowTipSHA1InWant | |
| </dt> | |
| <dd> | |
| <p> | |
| When <code>uploadpack.hideRefs</code> is in effect, allow <code>upload-pack</code> | |
| to accept a fetch request that asks for an object at the tip | |
| of a hidden ref (by default, such a request is rejected). | |
| see also <code>uploadpack.hideRefs</code>. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| uploadpack.allowReachableSHA1InWant | |
| </dt> | |
| <dd> | |
| <p> | |
| Allow <code>upload-pack</code> to accept a fetch request that asks for an | |
| object that is reachable from any ref tip. However, note that | |
| calculating object reachability is computationally expensive. | |
| Defaults to <code>false</code>. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| uploadpack.keepAlive | |
| </dt> | |
| <dd> | |
| <p> | |
| When <code>upload-pack</code> has started <code>pack-objects</code>, there may be a | |
| quiet period while <code>pack-objects</code> prepares the pack. Normally | |
| it would output progress information, but if <code>--quiet</code> was used | |
| for the fetch, <code>pack-objects</code> will output nothing at all until | |
| the pack data begins. Some clients and networks may consider | |
| the server to be hung and give up. Setting this option instructs | |
| <code>upload-pack</code> to send an empty keepalive packet every | |
| <code>uploadpack.keepAlive</code> seconds. Setting this option to 0 | |
| disables keepalive packets entirely. The default is 5 seconds. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| uploadpack.packObjectsHook | |
| </dt> | |
| <dd> | |
| <p> | |
| If this option is set, when <code>upload-pack</code> would run | |
| <code>git pack-objects</code> to create a packfile for a client, it will | |
| run this shell command instead. The <code>pack-objects</code> command and | |
| arguments it <em>would</em> have run (including the <code>git pack-objects</code> | |
| at the beginning) are appended to the shell command. The stdin | |
| and stdout of the hook are treated as if <code>pack-objects</code> itself | |
| was run. I.e., <code>upload-pack</code> will feed input intended for | |
| <code>pack-objects</code> to the hook, and expects a completed packfile on | |
| stdout. | |
| </p> | |
| <div class="paragraph"><p>Note that this configuration variable is ignored if it is seen in the | |
| repository-level config (this is a safety measure against fetching from | |
| untrusted repositories).</p></div> | |
| </dd> | |
| <dt class="hdlist1"> | |
| url.<base>.insteadOf | |
| </dt> | |
| <dd> | |
| <p> | |
| Any URL that starts with this value will be rewritten to | |
| start, instead, with <base>. In cases where some site serves a | |
| large number of repositories, and serves them with multiple | |
| access methods, and some users need to use different access | |
| methods, this feature allows people to specify any of the | |
| equivalent URLs and have Git automatically rewrite the URL to | |
| the best alternative for the particular user, even for a | |
| never-before-seen repository on the site. When more than one | |
| insteadOf strings match a given URL, the longest match is used. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| url.<base>.pushInsteadOf | |
| </dt> | |
| <dd> | |
| <p> | |
| Any URL that starts with this value will not be pushed to; | |
| instead, it will be rewritten to start with <base>, and the | |
| resulting URL will be pushed to. In cases where some site serves | |
| a large number of repositories, and serves them with multiple | |
| access methods, some of which do not allow push, this feature | |
| allows people to specify a pull-only URL and have Git | |
| automatically use an appropriate URL to push, even for a | |
| never-before-seen repository on the site. When more than one | |
| pushInsteadOf strings match a given URL, the longest match is | |
| used. If a remote has an explicit pushurl, Git will ignore this | |
| setting for that remote. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| user.email | |
| </dt> | |
| <dd> | |
| <p> | |
| Your email address to be recorded in any newly created commits. | |
| Can be overridden by the <code>GIT_AUTHOR_EMAIL</code>, <code>GIT_COMMITTER_EMAIL</code>, and | |
| <code>EMAIL</code> environment variables. See <a href="git-commit-tree.html">git-commit-tree(1)</a>. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| user.name | |
| </dt> | |
| <dd> | |
| <p> | |
| Your full name to be recorded in any newly created commits. | |
| Can be overridden by the <code>GIT_AUTHOR_NAME</code> and <code>GIT_COMMITTER_NAME</code> | |
| environment variables. See <a href="git-commit-tree.html">git-commit-tree(1)</a>. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| user.useConfigOnly | |
| </dt> | |
| <dd> | |
| <p> | |
| Instruct Git to avoid trying to guess defaults for <code>user.email</code> | |
| and <code>user.name</code>, and instead retrieve the values only from the | |
| configuration. For example, if you have multiple email addresses | |
| and would like to use a different one for each repository, then | |
| with this configuration option set to <code>true</code> in the global config | |
| along with a name, Git will prompt you to set up an email before | |
| making new commits in a newly cloned repository. | |
| Defaults to <code>false</code>. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| user.signingKey | |
| </dt> | |
| <dd> | |
| <p> | |
| If <a href="git-tag.html">git-tag(1)</a> or <a href="git-commit.html">git-commit(1)</a> is not selecting the | |
| key you want it to automatically when creating a signed tag or | |
| commit, you can override the default selection with this variable. | |
| This option is passed unchanged to gpg’s --local-user parameter, | |
| so you may specify a key using any method that gpg supports. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| versionsort.prereleaseSuffix | |
| </dt> | |
| <dd> | |
| <p> | |
| When version sort is used in <a href="git-tag.html">git-tag(1)</a>, prerelease | |
| tags (e.g. "1.0-rc1") may appear after the main release | |
| "1.0". By specifying the suffix "-rc" in this variable, | |
| "1.0-rc1" will appear before "1.0". | |
| </p> | |
| <div class="paragraph"><p>This variable can be specified multiple times, once per suffix. The | |
| order of suffixes in the config file determines the sorting order | |
| (e.g. if "-pre" appears before "-rc" in the config file then 1.0-preXX | |
| is sorted before 1.0-rcXX). The sorting order between different | |
| suffixes is undefined if they are in multiple config files.</p></div> | |
| </dd> | |
| <dt class="hdlist1"> | |
| web.browser | |
| </dt> | |
| <dd> | |
| <p> | |
| Specify a web browser that may be used by some commands. | |
| Currently only <a href="git-instaweb.html">git-instaweb(1)</a> and <a href="git-help.html">git-help(1)</a> | |
| may use it. | |
| </p> | |
| </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 2016-07-13 14:58:50 PDT | |
| </div> | |
| </div> | |
| </body> | |
| </html> |