1 <?xml version=
"1.0" encoding=
"UTF-8"?>
2 <!DOCTYPE html PUBLIC
"-//W3C//DTD XHTML 1.1//EN"
3 "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
4 <html xmlns=
"http://www.w3.org/1999/xhtml" xml:
lang=
"en">
6 <meta http-equiv=
"Content-Type" content=
"application/xhtml+xml; charset=UTF-8" />
7 <meta name=
"generator" content=
"AsciiDoc 10.2.0" />
8 <title>git-config(
1)
</title>
9 <style type=
"text/css">
10 /* Shared CSS for AsciiDoc xhtml11 and html5 backends */
14 font-family: Georgia,serif;
18 h1, h2, h3, h4, h5, h6,
19 div.title, caption.title,
20 thead, p.table.header,
22 #author, #revnumber, #revdate, #revremark,
24 font-family: Arial,Helvetica,sans-serif;
28 margin:
1em
5%
1em
5%;
33 text-decoration: underline;
49 h1, h2, h3, h4, h5, h6 {
57 border-bottom:
2px solid silver;
77 border:
1px solid silver;
88 ul
> li { color: #aaa; }
89 ul
> li
> * { color: black; }
91 .monospaced, code, pre {
92 font-family:
"Courier New", Courier, monospace;
99 white-space: pre-wrap;
109 #revnumber, #revdate, #revremark {
114 border-top:
2px solid silver;
120 padding-bottom:
0.5em;
124 padding-bottom:
0.5em;
129 margin-bottom:
1.5em;
131 div.imageblock, div.exampleblock, div.verseblock,
132 div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
133 div.admonitionblock {
135 margin-bottom:
1.5em;
137 div.admonitionblock {
139 margin-bottom:
2.0em;
144 div.content { /* Block element content. */
148 /* Block element titles. */
149 div.title, caption.title {
154 margin-bottom:
0.5em;
160 td div.title:first-child {
163 div.content div.title:first-child {
166 div.content + div.title {
170 div.sidebarblock
> div.content {
172 border:
1px solid #dddddd;
173 border-left:
4px solid #f0f0f0;
177 div.listingblock
> div.content {
178 border:
1px solid #dddddd;
179 border-left:
5px solid #f0f0f0;
184 div.quoteblock, div.verseblock {
188 border-left:
5px solid #f0f0f0;
192 div.quoteblock
> div.attribution {
197 div.verseblock
> pre.content {
198 font-family: inherit;
201 div.verseblock
> div.attribution {
205 /* DEPRECATED: Pre version
8.2.7 verse style literal block. */
206 div.verseblock + div.attribution {
210 div.admonitionblock .icon {
214 text-decoration: underline;
216 padding-right:
0.5em;
218 div.admonitionblock td.content {
220 border-left:
3px solid #dddddd;
223 div.exampleblock
> div.content {
224 border-left:
3px solid #dddddd;
228 div.imageblock div.content { padding-left:
0; }
229 span.image img { border-style: none; vertical-align: text-bottom; }
230 a.image:visited { color: white; }
234 margin-bottom:
0.8em;
247 list-style-position: outside;
250 list-style-type: decimal;
253 list-style-type: lower-alpha;
256 list-style-type: upper-alpha;
259 list-style-type: lower-roman;
262 list-style-type: upper-roman;
265 div.compact ul, div.compact ol,
266 div.compact p, div.compact p,
267 div.compact div, div.compact div {
269 margin-bottom:
0.1em;
281 margin-bottom:
0.8em;
284 padding-bottom:
15px;
286 dt.hdlist1.strong, td.hdlist1.strong {
292 padding-right:
0.8em;
298 div.hdlist.compact tr {
307 .footnote, .footnoteref {
311 span.footnote, span.footnoteref {
312 vertical-align: super;
316 margin:
20px
0 20px
0;
320 #footnotes div.footnote {
326 border-top:
1px solid silver;
335 padding-right:
0.5em;
336 padding-bottom:
0.3em;
344 #footer-badges { display: none; }
348 margin-bottom:
2.5em;
356 margin-bottom:
0.1em;
359 div.toclevel0, div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
376 span.aqua { color: aqua; }
377 span.black { color: black; }
378 span.blue { color: blue; }
379 span.fuchsia { color: fuchsia; }
380 span.gray { color: gray; }
381 span.green { color: green; }
382 span.lime { color: lime; }
383 span.maroon { color: maroon; }
384 span.navy { color: navy; }
385 span.olive { color: olive; }
386 span.purple { color: purple; }
387 span.red { color: red; }
388 span.silver { color: silver; }
389 span.teal { color: teal; }
390 span.white { color: white; }
391 span.yellow { color: yellow; }
393 span.aqua-background { background: aqua; }
394 span.black-background { background: black; }
395 span.blue-background { background: blue; }
396 span.fuchsia-background { background: fuchsia; }
397 span.gray-background { background: gray; }
398 span.green-background { background: green; }
399 span.lime-background { background: lime; }
400 span.maroon-background { background: maroon; }
401 span.navy-background { background: navy; }
402 span.olive-background { background: olive; }
403 span.purple-background { background: purple; }
404 span.red-background { background: red; }
405 span.silver-background { background: silver; }
406 span.teal-background { background: teal; }
407 span.white-background { background: white; }
408 span.yellow-background { background: yellow; }
410 span.big { font-size:
2em; }
411 span.small { font-size:
0.6em; }
413 span.underline { text-decoration: underline; }
414 span.overline { text-decoration: overline; }
415 span.line-through { text-decoration: line-through; }
417 div.unbreakable { page-break-inside: avoid; }
427 margin-bottom:
1.5em;
429 div.tableblock
> table {
430 border:
3px solid #
527bbd;
432 thead, p.table.header {
439 /* Because the table frame attribute is overridden by CSS in most browsers. */
440 div.tableblock
> table[
frame=
"void"] {
443 div.tableblock
> table[
frame=
"hsides"] {
444 border-left-style: none;
445 border-right-style: none;
447 div.tableblock
> table[
frame=
"vsides"] {
448 border-top-style: none;
449 border-bottom-style: none;
460 margin-bottom:
1.5em;
462 thead, p.tableblock.header {
473 border-color: #
527bbd;
474 border-collapse: collapse;
476 th.tableblock, td.tableblock {
480 border-color: #
527bbd;
483 table.tableblock.frame-topbot {
484 border-left-style: hidden;
485 border-right-style: hidden;
487 table.tableblock.frame-sides {
488 border-top-style: hidden;
489 border-bottom-style: hidden;
491 table.tableblock.frame-none {
492 border-style: hidden;
495 th.tableblock.halign-left, td.tableblock.halign-left {
498 th.tableblock.halign-center, td.tableblock.halign-center {
501 th.tableblock.halign-right, td.tableblock.halign-right {
505 th.tableblock.valign-top, td.tableblock.valign-top {
508 th.tableblock.valign-middle, td.tableblock.valign-middle {
509 vertical-align: middle;
511 th.tableblock.valign-bottom, td.tableblock.valign-bottom {
512 vertical-align: bottom;
523 padding-bottom:
0.5em;
524 border-top:
2px solid silver;
525 border-bottom:
2px solid silver;
530 body.manpage div.sectionbody {
535 body.manpage div#toc { display: none; }
540 <script type=
"text/javascript">
542 var asciidoc = { // Namespace.
544 /////////////////////////////////////////////////////////////////////
545 // Table Of Contents generator
546 /////////////////////////////////////////////////////////////////////
548 /* Author: Mihai Bazon, September
2002
549 * http://students.infoiasi.ro/~mishoo
551 * Table Of Content generator
554 * Feel free to use this script under the terms of the GNU General Public
555 * License, as long as you do not remove or alter this notice.
558 /* modified by Troy D. Hanson, September
2006. License: GPL */
559 /* modified by Stuart Rackham,
2006,
2009. License: GPL */
562 toc: function (toclevels) {
564 function getText(el) {
566 for (var i = el.firstChild; i != null; i = i.nextSibling) {
567 if (i.nodeType ==
3 /* Node.TEXT_NODE */) // IE doesn't speak constants.
569 else if (i.firstChild != null)
575 function TocEntry(el, text, toclevel) {
578 this.toclevel = toclevel;
581 function tocEntries(el, toclevels) {
582 var result = new Array;
583 var re = new RegExp('[hH]([
1-'+(toclevels+
1)+'])');
584 // Function that scans the DOM tree for header elements (the DOM2
585 // nodeIterator API would be a better technique but not supported by all
587 var iterate = function (el) {
588 for (var i = el.firstChild; i != null; i = i.nextSibling) {
589 if (i.nodeType ==
1 /* Node.ELEMENT_NODE */) {
590 var mo = re.exec(i.tagName);
591 if (mo && (i.getAttribute(
"class") || i.getAttribute(
"className")) !=
"float") {
592 result[result.length] = new TocEntry(i, getText(i), mo[
1]-
1);
602 var toc = document.getElementById(
"toc");
607 // Delete existing TOC entries in case we're reloading the TOC.
608 var tocEntriesToRemove = [];
610 for (i =
0; i < toc.childNodes.length; i++) {
611 var entry = toc.childNodes[i];
612 if (entry.nodeName.toLowerCase() == 'div'
613 && entry.getAttribute(
"class")
614 && entry.getAttribute(
"class").match(/^toclevel/))
615 tocEntriesToRemove.push(entry);
617 for (i =
0; i < tocEntriesToRemove.length; i++) {
618 toc.removeChild(tocEntriesToRemove[i]);
621 // Rebuild TOC entries.
622 var entries = tocEntries(document.getElementById(
"content"), toclevels);
623 for (var i =
0; i < entries.length; ++i) {
624 var entry = entries[i];
625 if (entry.element.id ==
"")
626 entry.element.id =
"_toc_" + i;
627 var a = document.createElement(
"a");
628 a.href =
"#" + entry.element.id;
629 a.appendChild(document.createTextNode(entry.text));
630 var div = document.createElement(
"div");
632 div.className =
"toclevel" + entry.toclevel;
633 toc.appendChild(div);
635 if (entries.length ==
0)
636 toc.parentNode.removeChild(toc);
640 /////////////////////////////////////////////////////////////////////
641 // Footnotes generator
642 /////////////////////////////////////////////////////////////////////
644 /* Based on footnote generation code from:
645 * http://www.brandspankingnew.net/archive/
2005/
07/format_footnote.html
648 footnotes: function () {
649 // Delete existing footnote entries in case we're reloading the footnodes.
651 var noteholder = document.getElementById(
"footnotes");
655 var entriesToRemove = [];
656 for (i =
0; i < noteholder.childNodes.length; i++) {
657 var entry = noteholder.childNodes[i];
658 if (entry.nodeName.toLowerCase() == 'div' && entry.getAttribute(
"class") ==
"footnote")
659 entriesToRemove.push(entry);
661 for (i =
0; i < entriesToRemove.length; i++) {
662 noteholder.removeChild(entriesToRemove[i]);
665 // Rebuild footnote entries.
666 var cont = document.getElementById(
"content");
667 var spans = cont.getElementsByTagName(
"span");
670 for (i=
0; i
<spans.length; i++) {
671 if (spans[i].className ==
"footnote") {
673 var note = spans[i].getAttribute(
"data-note");
675 // Use [\s\S] in place of . so multi-line matches work.
676 // Because JavaScript has no s (dotall) regex flag.
677 note = spans[i].innerHTML.match(/\s*\[([\s\S]*)]\s*/)[
1];
679 "[<a id='_footnoteref_" + n +
"' href='#_footnote_" + n +
680 "' title='View footnote' class='footnote'>" + n +
"</a>]";
681 spans[i].setAttribute(
"data-note", note);
683 noteholder.innerHTML +=
684 "<div class='footnote' id='_footnote_" + n +
"'>" +
685 "<a href='#_footnoteref_" + n +
"' title='Return to text'>" +
686 n +
"</a>. " + note +
"</div>";
687 var id =spans[i].getAttribute(
"id");
688 if (id != null) refs[
"#"+id] = n;
692 noteholder.parentNode.removeChild(noteholder);
694 // Process footnoterefs.
695 for (i=
0; i
<spans.length; i++) {
696 if (spans[i].className ==
"footnoteref") {
697 var href = spans[i].getElementsByTagName(
"a")[
0].getAttribute(
"href");
698 href = href.match(/#.*/)[
0]; // Because IE return full URL.
701 "[<a href='#_footnote_" + n +
702 "' title='View footnote' class='footnote'>" + n +
"</a>]";
708 install: function(toclevels) {
711 function reinstall() {
712 asciidoc.footnotes();
714 asciidoc.toc(toclevels);
718 function reinstallAndRemoveTimer() {
719 clearInterval(timerId);
723 timerId = setInterval(reinstall,
500);
724 if (document.addEventListener)
725 document.addEventListener(
"DOMContentLoaded", reinstallAndRemoveTimer, false);
727 window.onload = reinstallAndRemoveTimer;
735 <body class=
"manpage">
738 git-config(
1) Manual Page
741 <div class=
"sectionbody">
743 Get and set repository or global options
749 <h2 id=
"_synopsis">SYNOPSIS
</h2>
750 <div class=
"sectionbody">
751 <div class=
"verseblock">
752 <pre class=
"content"><em>git config
</em> [
<file-option
>] [--type=
<type
>] [--fixed-value] [--show-origin] [--show-scope] [-z|--null]
<name
> [
<value
> [
<value-pattern
>]]
753 <em>git config
</em> [
<file-option
>] [--type=
<type
>] --add
<name
> <value
>
754 <em>git config
</em> [
<file-option
>] [--type=
<type
>] [--fixed-value] --replace-all
<name
> <value
> [
<value-pattern
>]
755 <em>git config
</em> [
<file-option
>] [--type=
<type
>] [--show-origin] [--show-scope] [-z|--null] [--fixed-value] --get
<name
> [
<value-pattern
>]
756 <em>git config
</em> [
<file-option
>] [--type=
<type
>] [--show-origin] [--show-scope] [-z|--null] [--fixed-value] --get-all
<name
> [
<value-pattern
>]
757 <em>git config
</em> [
<file-option
>] [--type=
<type
>] [--show-origin] [--show-scope] [-z|--null] [--fixed-value] [--name-only] --get-regexp
<name-regex
> [
<value-pattern
>]
758 <em>git config
</em> [
<file-option
>] [--type=
<type
>] [-z|--null] --get-urlmatch
<name
> <URL
>
759 <em>git config
</em> [
<file-option
>] [--fixed-value] --unset
<name
> [
<value-pattern
>]
760 <em>git config
</em> [
<file-option
>] [--fixed-value] --unset-all
<name
> [
<value-pattern
>]
761 <em>git config
</em> [
<file-option
>] --rename-section
<old-name
> <new-name
>
762 <em>git config
</em> [
<file-option
>] --remove-section
<name
>
763 <em>git config
</em> [
<file-option
>] [--show-origin] [--show-scope] [-z|--null] [--name-only] -l | --list
764 <em>git config
</em> [
<file-option
>] --get-color
<name
> [
<default
>]
765 <em>git config
</em> [
<file-option
>] --get-colorbool
<name
> [
<stdout-is-tty
>]
766 <em>git config
</em> [
<file-option
>] -e | --edit
</pre>
767 <div class=
"attribution">
772 <h2 id=
"_description">DESCRIPTION
</h2>
773 <div class=
"sectionbody">
774 <div class=
"paragraph"><p>You can query/set/replace/unset options with this command. The name is
775 actually the section and the key separated by a dot, and the value will be
777 <div class=
"paragraph"><p>Multiple lines can be added to an option by using the
<code>--add
</code> option.
778 If you want to update or unset an option which can occur on multiple
779 lines, a
<code>value-pattern
</code> (which is an extended regular expression,
780 unless the
<code>--fixed-value
</code> option is given) needs to be given. Only the
781 existing values that match the pattern are updated or unset. If
782 you want to handle the lines that do
<strong>not
</strong> match the pattern, just
783 prepend a single exclamation mark in front (see also
<a href=
"#EXAMPLES">[EXAMPLES]
</a>),
784 but note that this only works when the
<code>--fixed-value
</code> option is not
786 <div class=
"paragraph"><p>The
<code>--type=
<type
></code> option instructs
<em>git config
</em> to ensure that incoming and
787 outgoing values are canonicalize-able under the given
<type
>. If no
788 <code>--type=
<type
></code> is given, no canonicalization will be performed. Callers may
789 unset an existing
<code>--type
</code> specifier with
<code>--no-type
</code>.
</p></div>
790 <div class=
"paragraph"><p>When reading, the values are read from the system, global and
791 repository local configuration files by default, and options
792 <code>--system
</code>,
<code>--global
</code>,
<code>--local
</code>,
<code>--worktree
</code> and
793 <code>--file
<filename
></code> can be used to tell the command to read from only
794 that location (see
<a href=
"#FILES">[FILES]
</a>).
</p></div>
795 <div class=
"paragraph"><p>When writing, the new value is written to the repository local
796 configuration file by default, and options
<code>--system
</code>,
<code>--global
</code>,
797 <code>--worktree
</code>,
<code>--file
<filename
></code> can be used to tell the command to
798 write to that location (you can say
<code>--local
</code> but that is the
800 <div class=
"paragraph"><p>This command will fail with non-zero status upon error. Some exit
802 <div class=
"ulist"><ul>
805 The section or key is invalid (ret=
1),
810 no section or name was provided (ret=
2),
815 the config file is invalid (ret=
3),
820 the config file cannot be written (ret=
4),
825 you try to unset an option which does not exist (ret=
5),
830 you try to unset/set an option for which multiple lines match (ret=
5), or
835 you try to use an invalid regexp (ret=
6).
839 <div class=
"paragraph"><p>On success, the command returns the exit code
0.
</p></div>
840 <div class=
"paragraph"><p>A list of all available configuration variables can be obtained using the
841 <code>git help --config
</code> command.
</p></div>
845 <h2 id=
"OPTIONS">OPTIONS
</h2>
846 <div class=
"sectionbody">
847 <div class=
"dlist"><dl>
853 Default behavior is to replace at most one line. This replaces
854 all lines matching the key (and optionally the
<code>value-pattern
</code>).
862 Adds a new line to the option without altering any existing
863 values. This is the same as providing
<em>^$
</em> as the
<code>value-pattern
</code>
864 in
<code>--replace-all
</code>.
872 Get the value for a given key (optionally filtered by a regex
873 matching the value). Returns error code
1 if the key was not
874 found and the last value if multiple key values were found.
882 Like get, but returns all values for a multi-valued key.
890 Like --get-all, but interprets the name as a regular expression and
891 writes out the key names. Regular expression matching is currently
892 case-sensitive and done against a canonicalized version of the key
893 in which section and variable names are lowercased, but subsection
898 --get-urlmatch
<name
> <URL
>
902 When given a two-part
<name
> as
<section
>.
<key
>, the value for
903 <section
>.
<URL
>.
<key
> whose
<URL
> part matches the best to the
904 given URL is returned (if no such key exists, the value for
905 <section
>.
<key
> is used as a fallback). When given just the
906 <section
> as name, do so for all the keys in the section and
907 list them. Returns error code
1 if no value is found.
915 For writing options: write to global
<code>~/.gitconfig
</code> file
916 rather than the repository
<code>.git/config
</code>, write to
917 <code>$XDG_CONFIG_HOME/git/config
</code> file if this file exists and the
918 <code>~/.gitconfig
</code> file doesn
’t.
920 <div class=
"paragraph"><p>For reading options: read only from global
<code>~/.gitconfig
</code> and from
921 <code>$XDG_CONFIG_HOME/git/config
</code> rather than from all available files.
</p></div>
922 <div class=
"paragraph"><p>See also
<a href=
"#FILES">[FILES]
</a>.
</p></div>
929 For writing options: write to system-wide
930 <code>$(prefix)/etc/gitconfig
</code> rather than the repository
931 <code>.git/config
</code>.
933 <div class=
"paragraph"><p>For reading options: read only from system-wide
<code>$(prefix)/etc/gitconfig
</code>
934 rather than from all available files.
</p></div>
935 <div class=
"paragraph"><p>See also
<a href=
"#FILES">[FILES]
</a>.
</p></div>
942 For writing options: write to the repository
<code>.git/config
</code> file.
943 This is the default behavior.
945 <div class=
"paragraph"><p>For reading options: read only from the repository
<code>.git/config
</code> rather than
946 from all available files.
</p></div>
947 <div class=
"paragraph"><p>See also
<a href=
"#FILES">[FILES]
</a>.
</p></div>
954 Similar to
<code>--local
</code> except that
<code>$GIT_DIR/config.worktree
</code> is
955 read from or written to if
<code>extensions.worktreeConfig
</code> is
956 enabled. If not it
’s the same as
<code>--local
</code>. Note that
<code>$GIT_DIR
</code>
957 is equal to
<code>$GIT_COMMON_DIR
</code> for the main working tree, but is of
958 the form
<code>$GIT_DIR/worktrees/
<id
>/
</code> for other working trees. See
959 <a href=
"git-worktree.html">git-worktree(
1)
</a> to learn how to enable
960 <code>extensions.worktreeConfig
</code>.
964 -f
<config-file
>
967 --file
<config-file
>
971 For writing options: write to the specified file rather than the
972 repository
<code>.git/config
</code>.
974 <div class=
"paragraph"><p>For reading options: read only from the specified file rather than from all
975 available files.
</p></div>
976 <div class=
"paragraph"><p>See also
<a href=
"#FILES">[FILES]
</a>.
</p></div>
983 Similar to
<code>--file
</code> but use the given blob instead of a file. E.g.
984 you can use
<em>master:.gitmodules
</em> to read values from the file
985 <em>.gitmodules
</em> in the master branch. See
"SPECIFYING REVISIONS"
986 section in
<a href=
"gitrevisions.html">gitrevisions(
7)
</a> for a more complete list of
987 ways to spell blob names.
995 Remove the given section from the configuration file.
1003 Rename the given section to a new name.
1006 <dt class=
"hdlist1">
1011 Remove the line matching the key from config file.
1014 <dt class=
"hdlist1">
1019 Remove all lines matching the key from config file.
1022 <dt class=
"hdlist1">
1025 <dt class=
"hdlist1">
1030 List all variables set in config file, along with their values.
1033 <dt class=
"hdlist1">
1038 When used with the
<code>value-pattern
</code> argument, treat
<code>value-pattern
</code> as
1039 an exact string instead of a regular expression. This will restrict
1040 the name/value pairs that are matched to only those where the value
1041 is exactly equal to the
<code>value-pattern
</code>.
1044 <dt class=
"hdlist1">
1049 <em>git config
</em> will ensure that any input or output is valid under the given
1050 type constraint(s), and will canonicalize outgoing values in
<code><type
></code>'s
1053 <div class=
"paragraph"><p>Valid
<code><type
></code>'s include:
</p></div>
1054 <div class=
"ulist"><ul>
1057 <em>bool
</em>: canonicalize values as either
"true" or
"false".
1062 <em>int
</em>: canonicalize values as simple decimal numbers. An optional suffix of
1063 <em>k
</em>,
<em>m
</em>, or
<em>g
</em> will cause the value to be multiplied by
1024,
1048576, or
1064 1073741824 upon input.
1069 <em>bool-or-int
</em>: canonicalize according to either
<em>bool
</em> or
<em>int
</em>, as described
1075 <em>path
</em>: canonicalize by expanding a leading
<code>~
</code> to the value of
<code>$HOME
</code> and
1076 <code>~user
</code> to the home directory for the specified user. This specifier has no
1077 effect when setting the value (but you can use
<code>git config section.variable
1078 ~/
</code> from the command line to let your shell do the expansion.)
1083 <em>expiry-date
</em>: canonicalize by converting from a fixed or relative date-string
1084 to a timestamp. This specifier has no effect when setting the value.
1089 <em>color
</em>: When getting a value, canonicalize by converting to an ANSI color
1090 escape sequence. When setting a value, a sanity-check is performed to ensure
1091 that the given value is canonicalize-able as an ANSI color, but it is written
1097 <dt class=
"hdlist1">
1100 <dt class=
"hdlist1">
1103 <dt class=
"hdlist1">
1106 <dt class=
"hdlist1">
1109 <dt class=
"hdlist1">
1114 Historical options for selecting a type specifier. Prefer instead
<code>--type
</code>
1118 <dt class=
"hdlist1">
1123 Un-sets the previously set type specifier (if one was previously set). This
1124 option requests that
<em>git config
</em> not canonicalize the retrieved variable.
1125 <code>--no-type
</code> has no effect without
<code>--type=
<type
></code> or
<code>--
<type
></code>.
1128 <dt class=
"hdlist1">
1131 <dt class=
"hdlist1">
1136 For all options that output values and/or keys, always
1137 end values with the null character (instead of a
1138 newline). Use newline instead as a delimiter between
1139 key and value. This allows for secure parsing of the
1140 output without getting confused e.g. by values that
1141 contain line breaks.
1144 <dt class=
"hdlist1">
1149 Output only the names of config variables for
<code>--list
</code> or
1150 <code>--get-regexp
</code>.
1153 <dt class=
"hdlist1">
1158 Augment the output of all queried config options with the
1159 origin type (file, standard input, blob, command line) and
1160 the actual origin (config file path, ref, or blob id if
1164 <dt class=
"hdlist1">
1169 Similar to
<code>--show-origin
</code> in that it augments the output of
1170 all queried config options with the scope of that value
1171 (worktree, local, global, system, command).
1174 <dt class=
"hdlist1">
1175 --get-colorbool
<name
> [
<stdout-is-tty
>]
1179 Find the color setting for
<code><name
></code> (e.g.
<code>color.diff
</code>) and output
1180 "true" or
"false".
<code><stdout-is-tty
></code> should be either
"true" or
1181 "false", and is taken into account when configuration says
1182 "auto". If
<code><stdout-is-tty
></code> is missing, then checks the standard
1183 output of the command itself, and exits with status
0 if color
1184 is to be used, or exits with status
1 otherwise.
1185 When the color setting for
<code>name
</code> is undefined, the command uses
1186 <code>color.ui
</code> as fallback.
1189 <dt class=
"hdlist1">
1190 --get-color
<name
> [
<default
>]
1194 Find the color configured for
<code>name
</code> (e.g.
<code>color.diff.new
</code>) and
1195 output it as the ANSI color escape sequence to the standard
1196 output. The optional
<code>default
</code> parameter is used instead, if
1197 there is no color configured for
<code>name
</code>.
1199 <div class=
"paragraph"><p><code>--type=color [--default=
<default
>]
</code> is preferred over
<code>--get-color
</code>
1200 (but note that
<code>--get-color
</code> will omit the trailing newline printed by
1201 <code>--type=color
</code>).
</p></div>
1203 <dt class=
"hdlist1">
1206 <dt class=
"hdlist1">
1211 Opens an editor to modify the specified config file; either
1212 <code>--system
</code>,
<code>--global
</code>,
<code>--local
</code> (default),
<code>--worktree
</code>, or
1213 <code>--file
<config-file
></code>.
1216 <dt class=
"hdlist1">
1221 Respect
<code>include.*
</code> directives in config files when looking up
1222 values. Defaults to
<code>off
</code> when a specific file is given (e.g.,
1223 using
<code>--file
</code>,
<code>--global
</code>, etc) and
<code>on
</code> when searching all
1227 <dt class=
"hdlist1">
1228 --default
<value
>
1232 When using
<code>--get
</code>, and the requested variable is not found, behave as if
1233 <value
> were the value assigned to that variable.
1240 <h2 id=
"_configuration">CONFIGURATION
</h2>
1241 <div class=
"sectionbody">
1242 <div class=
"paragraph"><p><code>pager.config
</code> is only respected when listing configuration, i.e., when
1243 using
<code>--list
</code> or any of the
<code>--get-*
</code> which may return multiple results.
1244 The default is to use a pager.
</p></div>
1248 <h2 id=
"FILES">FILES
</h2>
1249 <div class=
"sectionbody">
1250 <div class=
"paragraph"><p>By default,
<em>git config
</em> will read configuration options from multiple
1252 <div class=
"dlist"><dl>
1253 <dt class=
"hdlist1">
1254 $(prefix)/etc/gitconfig
1258 System-wide configuration file.
1261 <dt class=
"hdlist1">
1262 $XDG_CONFIG_HOME/git/config
1264 <dt class=
"hdlist1">
1269 User-specific configuration files. When the XDG_CONFIG_HOME environment
1270 variable is not set or empty, $HOME/.config/ is used as
1273 <div class=
"paragraph"><p>These are also called
"global" configuration files. If both files exist, both
1274 files are read in the order given above.
</p></div>
1276 <dt class=
"hdlist1">
1281 Repository specific configuration file.
1284 <dt class=
"hdlist1">
1285 $GIT_DIR/config.worktree
1289 This is optional and is only searched when
1290 <code>extensions.worktreeConfig
</code> is present in $GIT_DIR/config.
1294 <div class=
"paragraph"><p>You may also provide additional configuration parameters when running any
1295 git command by using the
<code>-c
</code> option. See
<a href=
"git.html">git(
1)
</a> for details.
</p></div>
1296 <div class=
"paragraph"><p>Options will be read from all of these files that are available. If the
1297 global or the system-wide configuration files are missing or unreadable they
1298 will be ignored. If the repository configuration file is missing or unreadable,
1299 <em>git config
</em> will exit with a non-zero error code. An error message is produced
1300 if the file is unreadable, but not if it is missing.
</p></div>
1301 <div class=
"paragraph"><p>The files are read in the order given above, with last value found taking
1302 precedence over values read earlier. When multiple values are taken then all
1303 values of a key from all files will be used.
</p></div>
1304 <div class=
"paragraph"><p>By default, options are only written to the repository specific
1305 configuration file. Note that this also affects options like
<code>--replace-all
</code>
1306 and
<code>--unset
</code>.
<strong><em>git config
</em> will only ever change one file at a time
</strong>.
</p></div>
1307 <div class=
"paragraph"><p>You can limit which configuration sources are read from or written to by
1308 specifying the path of a file with the
<code>--file
</code> option, or by specifying a
1309 configuration scope with
<code>--system
</code>,
<code>--global
</code>,
<code>--local
</code>, or
<code>--worktree
</code>.
1310 For more, see
<a href=
"#OPTIONS">[OPTIONS]
</a> above.
</p></div>
1314 <h2 id=
"SCOPES">SCOPES
</h2>
1315 <div class=
"sectionbody">
1316 <div class=
"paragraph"><p>Each configuration source falls within a configuration scope. The scopes
1318 <div class=
"dlist"><dl>
1319 <dt class=
"hdlist1">
1324 $(prefix)/etc/gitconfig
1327 <dt class=
"hdlist1">
1332 $XDG_CONFIG_HOME/git/config
1334 <div class=
"paragraph"><p>~/.gitconfig
</p></div>
1336 <dt class=
"hdlist1">
1344 <dt class=
"hdlist1">
1349 $GIT_DIR/config.worktree
1352 <dt class=
"hdlist1">
1357 GIT_CONFIG_{COUNT,KEY,VALUE} environment variables (see
<a href=
"#ENVIRONMENT">[ENVIRONMENT]
</a>
1360 <div class=
"paragraph"><p>the
<code>-c
</code> option
</p></div>
1363 <div class=
"paragraph"><p>With the exception of
<em>command
</em>, each scope corresponds to a command line
1364 option:
<code>--system
</code>,
<code>--global
</code>,
<code>--local
</code>,
<code>--worktree
</code>.
</p></div>
1365 <div class=
"paragraph"><p>When reading options, specifying a scope will only read options from the
1366 files within that scope. When writing options, specifying a scope will write
1367 to the files within that scope (instead of the repository specific
1368 configuration file). See
<a href=
"#OPTIONS">[OPTIONS]
</a> above for a complete description.
</p></div>
1369 <div class=
"paragraph"><p>Most configuration options are respected regardless of the scope it is
1370 defined in, but some options are only respected in certain scopes. See the
1371 respective option
’s documentation for the full details.
</p></div>
1373 <h3 id=
"_protected_configuration">Protected configuration
</h3>
1374 <div class=
"paragraph"><p>Protected configuration refers to the
<em>system
</em>,
<em>global
</em>, and
<em>command
</em> scopes.
1375 For security reasons, certain options are only respected when they are
1376 specified in protected configuration, and ignored otherwise.
</p></div>
1377 <div class=
"paragraph"><p>Git treats these scopes as if they are controlled by the user or a trusted
1378 administrator. This is because an attacker who controls these scopes can do
1379 substantial harm without using Git, so it is assumed that the user
’s environment
1380 protects these scopes against attackers.
</p></div>
1385 <h2 id=
"ENVIRONMENT">ENVIRONMENT
</h2>
1386 <div class=
"sectionbody">
1387 <div class=
"dlist"><dl>
1388 <dt class=
"hdlist1">
1391 <dt class=
"hdlist1">
1396 Take the configuration from the given files instead from global or
1397 system-level configuration. See
<a href=
"git.html">git(
1)
</a> for details.
1400 <dt class=
"hdlist1">
1405 Whether to skip reading settings from the system-wide
1406 $(prefix)/etc/gitconfig file. See
<a href=
"git.html">git(
1)
</a> for details.
1410 <div class=
"paragraph"><p>See also
<a href=
"#FILES">[FILES]
</a>.
</p></div>
1411 <div class=
"dlist"><dl>
1412 <dt class=
"hdlist1">
1415 <dt class=
"hdlist1">
1416 GIT_CONFIG_KEY_
<n
>
1418 <dt class=
"hdlist1">
1419 GIT_CONFIG_VALUE_
<n
>
1423 If GIT_CONFIG_COUNT is set to a positive number, all environment pairs
1424 GIT_CONFIG_KEY_
<n
> and GIT_CONFIG_VALUE_
<n
> up to that number will be
1425 added to the process
’s runtime configuration. The config pairs are
1426 zero-indexed. Any missing key or value is treated as an error. An empty
1427 GIT_CONFIG_COUNT is treated the same as GIT_CONFIG_COUNT=
0, namely no
1428 pairs are processed. These environment variables will override values
1429 in configuration files, but will be overridden by any explicit options
1430 passed via
<code>git -c
</code>.
1432 <div class=
"paragraph"><p>This is useful for cases where you want to spawn multiple git commands
1433 with a common configuration but cannot depend on a configuration file,
1434 for example when writing scripts.
</p></div>
1436 <dt class=
"hdlist1">
1441 If no
<code>--file
</code> option is provided to
<code>git config
</code>, use the file
1442 given by
<code>GIT_CONFIG
</code> as if it were provided via
<code>--file
</code>. This
1443 variable has no effect on other Git commands, and is mostly for
1444 historical compatibility; there is generally no reason to use it
1445 instead of the
<code>--file
</code> option.
1452 <h2 id=
"EXAMPLES">EXAMPLES
</h2>
1453 <div class=
"sectionbody">
1454 <div class=
"paragraph"><p>Given a .git/config like this:
</p></div>
1455 <div class=
"listingblock">
1456 <div class=
"content">
1458 # This is the config file, and
1459 # a '#' or ';' character indicates
1465 ; Don't trust file modes
1468 ; Our diff algorithm
1470 external = /usr/local/bin/diff-wrapper
1475 gitproxy=proxy-command for kernel.org
1476 gitproxy=default-proxy ; for all the rest
1481 [http
"https://weak.example.com"]
1483 cookieFile = /tmp/cookie.txt
</code></pre>
1485 <div class=
"paragraph"><p>you can set the filemode to true with
</p></div>
1486 <div class=
"listingblock">
1487 <div class=
"content">
1488 <pre><code>% git config core.filemode true
</code></pre>
1490 <div class=
"paragraph"><p>The hypothetical proxy command entries actually have a postfix to discern
1491 what URL they apply to. Here is how to change the entry for kernel.org
1493 <div class=
"listingblock">
1494 <div class=
"content">
1495 <pre><code>% git config core.gitproxy '
"ssh" for kernel.org' 'for kernel.org$'
</code></pre>
1497 <div class=
"paragraph"><p>This makes sure that only the key/value pair for kernel.org is replaced.
</p></div>
1498 <div class=
"paragraph"><p>To delete the entry for renames, do
</p></div>
1499 <div class=
"listingblock">
1500 <div class=
"content">
1501 <pre><code>% git config --unset diff.renames
</code></pre>
1503 <div class=
"paragraph"><p>If you want to delete an entry for a multivar (like core.gitproxy above),
1504 you have to provide a regex matching the value of exactly one line.
</p></div>
1505 <div class=
"paragraph"><p>To query the value for a given key, do
</p></div>
1506 <div class=
"listingblock">
1507 <div class=
"content">
1508 <pre><code>% git config --get core.filemode
</code></pre>
1510 <div class=
"paragraph"><p>or
</p></div>
1511 <div class=
"listingblock">
1512 <div class=
"content">
1513 <pre><code>% git config core.filemode
</code></pre>
1515 <div class=
"paragraph"><p>or, to query a multivar:
</p></div>
1516 <div class=
"listingblock">
1517 <div class=
"content">
1518 <pre><code>% git config --get core.gitproxy
"for kernel.org$"</code></pre>
1520 <div class=
"paragraph"><p>If you want to know all the values for a multivar, do:
</p></div>
1521 <div class=
"listingblock">
1522 <div class=
"content">
1523 <pre><code>% git config --get-all core.gitproxy
</code></pre>
1525 <div class=
"paragraph"><p>If you like to live dangerously, you can replace
<strong>all
</strong> core.gitproxy by a
1526 new one with
</p></div>
1527 <div class=
"listingblock">
1528 <div class=
"content">
1529 <pre><code>% git config --replace-all core.gitproxy ssh
</code></pre>
1531 <div class=
"paragraph"><p>However, if you really only want to replace the line for the default proxy,
1532 i.e. the one without a
"for …" postfix, do something like this:
</p></div>
1533 <div class=
"listingblock">
1534 <div class=
"content">
1535 <pre><code>% git config core.gitproxy ssh '! for '
</code></pre>
1537 <div class=
"paragraph"><p>To actually match only values with an exclamation mark, you have to
</p></div>
1538 <div class=
"listingblock">
1539 <div class=
"content">
1540 <pre><code>% git config section.key value '[!]'
</code></pre>
1542 <div class=
"paragraph"><p>To add a new proxy, without altering any of the existing ones, use
</p></div>
1543 <div class=
"listingblock">
1544 <div class=
"content">
1545 <pre><code>% git config --add core.gitproxy '
"proxy-command" for example.com'
</code></pre>
1547 <div class=
"paragraph"><p>An example to use customized color from the configuration in your
1549 <div class=
"listingblock">
1550 <div class=
"content">
1551 <pre><code>#!/bin/sh
1552 WS=$(git config --get-color color.diff.whitespace
"blue reverse")
1553 RESET=$(git config --get-color
"" "reset")
1554 echo
"${WS}your whitespace color or blue reverse${RESET}"</code></pre>
1556 <div class=
"paragraph"><p>For URLs in
<code>https://weak.example.com
</code>,
<code>http.sslVerify
</code> is set to
1557 false, while it is set to
<code>true
</code> for all others:
</p></div>
1558 <div class=
"listingblock">
1559 <div class=
"content">
1560 <pre><code>% git config --type=bool --get-urlmatch http.sslverify https://good.example.com
1562 % git config --type=bool --get-urlmatch http.sslverify https://weak.example.com
1564 % git config --get-urlmatch http https://weak.example.com
1565 http.cookieFile /tmp/cookie.txt
1566 http.sslverify false
</code></pre>
1571 <h2 id=
"_configuration_file">CONFIGURATION FILE
</h2>
1572 <div class=
"sectionbody">
1573 <div class=
"paragraph"><p>The Git configuration file contains a number of variables that affect
1574 the Git commands' behavior. The files
<code>.git/config
</code> and optionally
1575 <code>config.worktree
</code> (see the
"CONFIGURATION FILE" section of
1576 <a href=
"git-worktree.html">git-worktree(
1)
</a>) in each repository are used to store the
1577 configuration for that repository, and
<code>$HOME/.gitconfig
</code> is used to
1578 store a per-user configuration as fallback values for the
<code>.git/config
</code>
1579 file. The file
<code>/etc/gitconfig
</code> can be used to store a system-wide
1580 default configuration.
</p></div>
1581 <div class=
"paragraph"><p>The configuration variables are used by both the Git plumbing
1582 and the porcelain commands. The variables are divided into sections, wherein
1583 the fully qualified variable name of the variable itself is the last
1584 dot-separated segment and the section name is everything before the last
1585 dot. The variable names are case-insensitive, allow only alphanumeric
1586 characters and
<code>-
</code>, and must start with an alphabetic character. Some
1587 variables may appear multiple times; we say then that the variable is
1588 multivalued.
</p></div>
1590 <h3 id=
"_syntax">Syntax
</h3>
1591 <div class=
"paragraph"><p>The syntax is fairly flexible and permissive. Whitespace characters,
1592 which in this context are the space character (SP) and the horizontal
1593 tabulation (HT), are mostly ignored. The
<em>#
</em> and
<em>;
</em> characters begin
1594 comments to the end of line. Blank lines are ignored.
</p></div>
1595 <div class=
"paragraph"><p>The file consists of sections and variables. A section begins with
1596 the name of the section in square brackets and continues until the next
1597 section begins. Section names are case-insensitive. Only alphanumeric
1598 characters,
<code>-
</code> and
<code>.
</code> are allowed in section names. Each variable
1599 must belong to some section, which means that there must be a section
1600 header before the first setting of a variable.
</p></div>
1601 <div class=
"paragraph"><p>Sections can be further divided into subsections. To begin a subsection
1602 put its name in double quotes, separated by space from the section name,
1603 in the section header, like in the example below:
</p></div>
1604 <div class=
"listingblock">
1605 <div class=
"content">
1606 <pre><code> [section
"subsection"]
</code></pre>
1608 <div class=
"paragraph"><p>Subsection names are case sensitive and can contain any characters except
1609 newline and the null byte. Doublequote
<code>"</code> and backslash can be included
1610 by escaping them as <code>\"</code> and
<code>\\
</code>, respectively. Backslashes preceding
1611 other characters are dropped when reading; for example,
<code>\t
</code> is read as
1612 <code>t
</code> and
<code>\
0</code> is read as
<code>0</code>. Section headers cannot span multiple lines.
1613 Variables may belong directly to a section or to a given subsection. You
1614 can have
<code>[section]
</code> if you have
<code>[section
"subsection"]
</code>, but you don
’t
1616 <div class=
"paragraph"><p>There is also a deprecated
<code>[section.subsection]
</code> syntax. With this
1617 syntax, the subsection name is converted to lower-case and is also
1618 compared case sensitively. These subsection names follow the same
1619 restrictions as section names.
</p></div>
1620 <div class=
"paragraph"><p>All the other lines (and the remainder of the line after the section
1621 header) are recognized as setting variables, in the form
1622 <em>name = value
</em> (or just
<em>name
</em>, which is a short-hand to say that
1623 the variable is the boolean
"true").
1624 The variable names are case-insensitive, allow only alphanumeric characters
1625 and
<code>-
</code>, and must start with an alphabetic character.
</p></div>
1626 <div class=
"paragraph"><p>Whitespace characters surrounding
<code>name
</code>,
<code>=
</code> and
<code>value
</code> are discarded.
1627 Internal whitespace characters within
<em>value
</em> are retained verbatim.
1628 Comments starting with either
<code>#
</code> or
<code>;
</code> and extending to the end of line
1629 are discarded. A line that defines a value can be continued to the next
1630 line by ending it with a backslash (
<code>\
</code>); the backslash and the end-of-line
1631 characters are discarded.
</p></div>
1632 <div class=
"paragraph"><p>If
<code>value
</code> needs to contain leading or trailing whitespace characters,
1633 it must be enclosed in double quotation marks (
<code>"</code>). Inside double quotation
1634 marks, double quote (<code>"</code>) and backslash (
<code>\
</code>) characters must be escaped:
1635 use
<code>\
"</code> for <code>"</code> and
<code>\\
</code> for
<code>\
</code>.
</p></div>
1636 <div class=
"paragraph"><p>The following escape sequences (beside
<code>\
"</code> and <code>\\</code>) are recognized:
1637 <code>\n</code> for newline character (NL), <code>\t</code> for horizontal tabulation (HT, TAB)
1638 and <code>\b</code> for backspace (BS). Other char escape sequences (including octal
1639 escape sequences) are invalid.</p></div>
1642 <h3 id="_includes
">Includes</h3>
1643 <div class="paragraph
"><p>The <code>include</code> and <code>includeIf</code> sections allow you to include config
1644 directives from another source. These sections behave identically to
1645 each other with the exception that <code>includeIf</code> sections may be ignored
1646 if their condition does not evaluate to true; see "Conditional includes
"
1648 <div class="paragraph
"><p>You can include a config file from another by setting the special
1649 <code>include.path</code> (or <code>includeIf.*.path</code>) variable to the name of the file
1650 to be included. The variable takes a pathname as its value, and is
1651 subject to tilde expansion. These variables can be given multiple times.</p></div>
1652 <div class="paragraph
"><p>The contents of the included file are inserted immediately, as if they
1653 had been found at the location of the include directive. If the value of the
1654 variable is a relative path, the path is considered to
1655 be relative to the configuration file in which the include directive
1656 was found. See below for examples.</p></div>
1659 <h3 id="_conditional_includes
">Conditional includes</h3>
1660 <div class="paragraph
"><p>You can conditionally include a config file from another by setting an
1661 <code>includeIf.<condition>.path</code> variable to the name of the file to be
1663 <div class="paragraph
"><p>The condition starts with a keyword followed by a colon and some data
1664 whose format and meaning depends on the keyword. Supported keywords
1666 <div class="dlist
"><dl>
1667 <dt class="hdlist1
">
1672 The data that follows the keyword <code>gitdir:</code> is used as a glob
1673 pattern. If the location of the .git directory matches the
1674 pattern, the include condition is met.
1676 <div class="paragraph
"><p>The .git location may be auto-discovered, or come from <code>$GIT_DIR</code>
1677 environment variable. If the repository is auto-discovered via a .git
1678 file (e.g. from submodules, or a linked worktree), the .git location
1679 would be the final location where the .git directory is, not where the
1680 .git file is.</p></div>
1681 <div class="paragraph
"><p>The pattern can contain standard globbing wildcards and two additional
1682 ones, <code>**/</code> and <code>/**</code>, that can match multiple path components. Please
1683 refer to <a href="gitignore.html
">gitignore(5)</a> for details. For convenience:</p></div>
1684 <div class="ulist
"><ul>
1687 If the pattern starts with <code>~/</code>, <code>~</code> will be substituted with the
1688 content of the environment variable <code>HOME</code>.
1693 If the pattern starts with <code>./</code>, it is replaced with the directory
1694 containing the current config file.
1699 If the pattern does not start with either <code>~/</code>, <code>./</code> or <code>/</code>, <code>**/</code>
1700 will be automatically prepended. For example, the pattern <code>foo/bar</code>
1701 becomes <code>**/foo/bar</code> and would match <code>/any/path/to/foo/bar</code>.
1706 If the pattern ends with <code>/</code>, <code>**</code> will be automatically added. For
1707 example, the pattern <code>foo/</code> becomes <code>foo/**</code>. In other words, it
1708 matches "foo
" and everything inside, recursively.
1713 <dt class="hdlist1
">
1714 <code>gitdir/i</code>
1718 This is the same as <code>gitdir</code> except that matching is done
1719 case-insensitively (e.g. on case-insensitive file systems)
1722 <dt class="hdlist1
">
1723 <code>onbranch</code>
1727 The data that follows the keyword <code>onbranch:</code> is taken to be a
1728 pattern with standard globbing wildcards and two additional
1729 ones, <code>**/</code> and <code>/**</code>, that can match multiple path components.
1730 If we are in a worktree where the name of the branch that is
1731 currently checked out matches the pattern, the include condition
1734 <div class="paragraph
"><p>If the pattern ends with <code>/</code>, <code>**</code> will be automatically added. For
1735 example, the pattern <code>foo/</code> becomes <code>foo/**</code>. In other words, it matches
1736 all branches that begin with <code>foo/</code>. This is useful if your branches are
1737 organized hierarchically and you would like to apply a configuration to
1738 all the branches in that hierarchy.</p></div>
1740 <dt class="hdlist1
">
1741 <code>hasconfig:remote.*.url:</code>
1745 The data that follows this keyword is taken to
1746 be a pattern with standard globbing wildcards and two
1747 additional ones, <code>**/</code> and <code>/**</code>, that can match multiple
1748 components. The first time this keyword is seen, the rest of
1749 the config files will be scanned for remote URLs (without
1750 applying any values). If there exists at least one remote URL
1751 that matches this pattern, the include condition is met.
1753 <div class="paragraph
"><p>Files included by this option (directly or indirectly) are not allowed
1754 to contain remote URLs.</p></div>
1755 <div class="paragraph
"><p>Note that unlike other includeIf conditions, resolving this condition
1756 relies on information that is not yet known at the point of reading the
1757 condition. A typical use case is this option being present as a
1758 system-level or global-level config, and the remote URL being in a
1759 local-level config; hence the need to scan ahead when resolving this
1760 condition. In order to avoid the chicken-and-egg problem in which
1761 potentially-included files can affect whether such files are potentially
1762 included, Git breaks the cycle by prohibiting these files from affecting
1763 the resolution of these conditions (thus, prohibiting them from
1764 declaring remote URLs).</p></div>
1765 <div class="paragraph
"><p>As for the naming of this keyword, it is for forwards compatibility with
1766 a naming scheme that supports more variable-based include conditions,
1767 but currently Git only supports the exact keyword described above.</p></div>
1770 <div class="paragraph
"><p>A few more notes on matching via <code>gitdir</code> and <code>gitdir/i</code>:</p></div>
1771 <div class="ulist
"><ul>
1774 Symlinks in <code>$GIT_DIR</code> are not resolved before matching.
1779 Both the symlink & realpath versions of paths will be matched
1780 outside of <code>$GIT_DIR</code>. E.g. if ~/git is a symlink to
1781 /mnt/storage/git, both <code>gitdir:~/git</code> and <code>gitdir:/mnt/storage/git</code>
1784 <div class="paragraph
"><p>This was not the case in the initial release of this feature in
1785 v2.13.0, which only matched the realpath version. Configuration that
1786 wants to be compatible with the initial release of this feature needs
1787 to either specify only the realpath version, or both versions.</p></div>
1791 Note that "../
" is not special and will match literally, which is
1792 unlikely what you want.
1798 <h3 id="_example
">Example</h3>
1799 <div class="listingblock
">
1800 <div class="content
">
1801 <pre><code># Core variables
1803 ; Don't trust file modes
1806 # Our diff algorithm
1808 external = /usr/local/bin/diff-wrapper
1813 merge = refs/heads/devel
1817 gitProxy="ssh
" for "kernel.org
"
1818 gitProxy=default-proxy ; for the rest
1821 path = /path/to/foo.inc ; include by absolute path
1822 path = foo.inc ; find "foo.inc
" relative to the current file
1823 path = ~/foo.inc ; find "foo.inc
" in your `$HOME` directory
1825 ; include if $GIT_DIR is /path/to/foo/.git
1826 [includeIf "gitdir:/path/to/foo/.git
"]
1827 path = /path/to/foo.inc
1829 ; include for all repositories inside /path/to/group
1830 [includeIf "gitdir:/path/to/group/
"]
1831 path = /path/to/foo.inc
1833 ; include for all repositories inside $HOME/to/group
1834 [includeIf "gitdir:~/to/group/
"]
1835 path = /path/to/foo.inc
1837 ; relative paths are always relative to the including
1838 ; file (if the condition is true); their location is not
1839 ; affected by the condition
1840 [includeIf "gitdir:/path/to/group/
"]
1843 ; include only if we are in a worktree where foo-branch is
1844 ; currently checked out
1845 [includeIf "onbranch:foo-branch
"]
1848 ; include only if a remote with the given URL exists (note
1849 ; that such a URL may be provided later in a file or in a
1850 ; file read after this file is read, as seen in this example)
1851 [includeIf "hasconfig:remote.*.url:https://example.com/**
"]
1854 url = https://example.com/git</code></pre>
1858 <h3 id="_values
">Values</h3>
1859 <div class="paragraph
"><p>Values of many variables are treated as a simple string, but there
1860 are variables that take values of specific types and there are rules
1861 as to how to spell them.</p></div>
1862 <div class="dlist
"><dl>
1863 <dt class="hdlist1
">
1868 When a variable is said to take a boolean value, many
1869 synonyms are accepted for <em>true</em> and <em>false</em>; these are all
1872 <div class="dlist
"><dl>
1873 <dt class="hdlist1
">
1878 Boolean true literals are <code>yes</code>, <code>on</code>, <code>true</code>,
1879 and <code>1</code>. Also, a variable defined without <code>= <value></code>
1883 <dt class="hdlist1
">
1888 Boolean false literals are <code>no</code>, <code>off</code>, <code>false</code>,
1889 <code>0</code> and the empty string.
1891 <div class="paragraph
"><p>When converting a value to its canonical form using the <code>--type=bool</code> type
1892 specifier, <em>git config</em> will ensure that the output is "true
" or
1893 "false
" (spelled in lowercase).</p></div>
1897 <dt class="hdlist1
">
1902 The value for many variables that specify various sizes can
1903 be suffixed with <code>k</code>, <code>M</code>,… to mean "scale the number by
1904 1024", "by
1024x1024
", etc.
1907 <dt class="hdlist1
">
1912 The value for a variable that takes a color is a list of
1913 colors (at most two, one for foreground and one for background)
1914 and attributes (as many as you want), separated by spaces.
1916 <div class="paragraph
"><p>The basic colors accepted are <code>normal</code>, <code>black</code>, <code>red</code>, <code>green</code>,
1917 <code>yellow</code>, <code>blue</code>, <code>magenta</code>, <code>cyan</code>, <code>white</code> and <code>default</code>. The first
1918 color given is the foreground; the second is the background. All the
1919 basic colors except <code>normal</code> and <code>default</code> have a bright variant that can
1920 be specified by prefixing the color with <code>bright</code>, like <code>brightred</code>.</p></div>
1921 <div class="paragraph
"><p>The color <code>normal</code> makes no change to the color. It is the same as an
1922 empty string, but can be used as the foreground color when specifying a
1923 background color alone (for example, "normal red
").</p></div>
1924 <div class="paragraph
"><p>The color <code>default</code> explicitly resets the color to the terminal default,
1925 for example to specify a cleared background. Although it varies between
1926 terminals, this is usually not the same as setting to "white black
".</p></div>
1927 <div class="paragraph
"><p>Colors may also be given as numbers between 0 and 255; these use ANSI
1928 256-color mode (but note that not all terminals may support this). If
1929 your terminal supports it, you may also specify 24-bit RGB values as
1930 hex, like <code>#ff0ab3</code>.</p></div>
1931 <div class="paragraph
"><p>The accepted attributes are <code>bold</code>, <code>dim</code>, <code>ul</code>, <code>blink</code>, <code>reverse</code>,
1932 <code>italic</code>, and <code>strike</code> (for crossed-out or "strikethrough
" letters).
1933 The position of any attributes with respect to the colors
1934 (before, after, or in between), doesn’t matter. Specific attributes may
1935 be turned off by prefixing them with <code>no</code> or <code>no-</code> (e.g., <code>noreverse</code>,
1936 <code>no-ul</code>, etc).</p></div>
1937 <div class="paragraph
"><p>The pseudo-attribute <code>reset</code> resets all colors and attributes before
1938 applying the specified coloring. For example, <code>reset green</code> will result
1939 in a green foreground and default background without any active
1940 attributes.</p></div>
1941 <div class="paragraph
"><p>An empty color string produces no color effect at all. This can be used
1942 to avoid coloring specific elements without disabling color entirely.</p></div>
1943 <div class="paragraph
"><p>For git’s pre-defined color slots, the attributes are meant to be reset
1944 at the beginning of each item in the colored output. So setting
1945 <code>color.decorate.branch</code> to <code>black</code> will paint that branch name in a
1946 plain <code>black</code>, even if the previous thing on the same output line (e.g.
1947 opening parenthesis before the list of branch names in <code>log --decorate</code>
1948 output) is set to be painted with <code>bold</code> or some other attribute.
1949 However, custom log formats may do more complicated and layered
1950 coloring, and the negated forms may be useful there.</p></div>
1952 <dt class="hdlist1
">
1957 A variable that takes a pathname value can be given a
1958 string that begins with "<code>~/
</code>" or "<code>~user/
</code>", and the usual
1959 tilde expansion happens to such a string: <code>~/</code>
1960 is expanded to the value of <code>$HOME</code>, and <code>~user/</code> to the
1961 specified user’s home directory.
1963 <div class="paragraph
"><p>If a path starts with <code>%(prefix)/</code>, the remainder is interpreted as a
1964 path relative to Git’s "runtime prefix
", i.e. relative to the location
1965 where Git itself was installed. For example, <code>%(prefix)/bin/</code> refers to
1966 the directory in which the Git executable itself lives. If Git was
1967 compiled without runtime prefix support, the compiled-in prefix will be
1968 substituted instead. In the unlikely event that a literal path needs to
1969 be specified that should <em>not</em> be expanded, it needs to be prefixed by
1970 <code>./</code>, like so: <code>./%(prefix)/bin</code>.</p></div>
1975 <h3 id="_variables
">Variables</h3>
1976 <div class="paragraph
"><p>Note that this list is non-comprehensive and not necessarily complete.
1977 For command-specific variables, you will find a more detailed description
1978 in the appropriate manual page.</p></div>
1979 <div class="paragraph
"><p>Other git-related tools may and do use their own variables. When
1980 inventing new variables for use in your own tool, make sure their
1981 names do not conflict with those that are used by Git itself and
1982 other popular tools, and describe them in your documentation.</p></div>
1983 <div class="dlist
"><dl>
1984 <dt class="hdlist1
">
1987 <dt class="hdlist1
">
1988 add.ignore-errors (deprecated)
1992 Tells <em>git add</em> to continue adding files when some files cannot be
1993 added due to indexing errors. Equivalent to the <code>--ignore-errors</code>
1994 option of <a href="git-add.html
">git-add(1)</a>. <code>add.ignore-errors</code> is deprecated,
1995 as it does not follow the usual naming convention for configuration
1999 <dt class="hdlist1
">
2000 add.interactive.useBuiltin
2004 Unused configuration variable. Used in Git versions v2.25.0 to
2005 v2.36.0 to enable the built-in version of <a href="git-add.html
">git-add(1)</a>'s
2006 interactive mode, which then became the default in Git
2007 versions v2.37.0 to v2.39.0.
2010 <dt class="hdlist1
">
2015 These variables control various optional help messages designed to
2016 aid new users. When left unconfigured, Git will give the message
2017 alongside instructions on how to squelch it. You can tell Git
2018 that you do not need the help message by setting these to <code>false</code>:
2020 <div class="openblock
">
2021 <div class="content
">
2022 <div class="dlist
"><dl>
2023 <dt class="hdlist1
">
2028 Shown when the user accidentally adds one
2029 git repo inside of another.
2032 <dt class="hdlist1
">
2037 Shown when the user runs <code>git add</code> without providing
2038 the pathspec parameter.
2041 <dt class="hdlist1
">
2046 Shown when the user attempts to add an ignored file to
2050 <dt class="hdlist1
">
2055 Shown when <a href="git-am.html
">git-am(1)</a> fails to apply a patch
2056 file, to tell the user the location of the file.
2059 <dt class="hdlist1
">
2060 ambiguousFetchRefspec
2064 Shown when a fetch refspec for multiple remotes maps to
2065 the same remote-tracking branch namespace and causes branch
2066 tracking set-up to fail.
2069 <dt class="hdlist1
">
2070 checkoutAmbiguousRemoteBranchName
2074 Shown when the argument to
2075 <a href="git-checkout.html
">git-checkout(1)</a> and <a href="git-switch.html
">git-switch(1)</a>
2076 ambiguously resolves to a
2077 remote tracking branch on more than one remote in
2078 situations where an unambiguous argument would have
2079 otherwise caused a remote-tracking branch to be
2080 checked out. See the <code>checkout.defaultRemote</code>
2081 configuration variable for how to set a given remote
2082 to be used by default in some situations where this
2083 advice would be printed.
2086 <dt class="hdlist1
">
2091 Shown when <a href="git-merge.html
">git-merge(1)</a> refuses to
2092 merge to avoid overwriting local changes.
2095 <dt class="hdlist1
">
2100 Shown when the user uses
2101 <a href="git-switch.html
">git-switch(1)</a> or <a href="git-checkout.html
">git-checkout(1)</a>
2102 to move to the detached HEAD state, to tell the user how
2103 to create a local branch after the fact.
2106 <dt class="hdlist1
">
2111 Shown when a fast-forward is not possible.
2114 <dt class="hdlist1
">
2115 fetchShowForcedUpdates
2119 Shown when <a href="git-fetch.html
">git-fetch(1)</a> takes a long time
2120 to calculate forced updates after ref updates, or to warn
2121 that the check is disabled.
2124 <dt class="hdlist1
">
2129 Shown when the user tries to delete a not fully merged
2130 branch without the force option set.
2133 <dt class="hdlist1
">
2138 Shown when a hook is ignored because the hook is not
2142 <dt class="hdlist1
">
2147 Shown when the user’s information is guessed from the
2148 system username and domain name, to tell the user how to
2149 set their identity configuration.
2152 <dt class="hdlist1
">
2157 Shown when various commands stop because of conflicts.
2160 <dt class="hdlist1
">
2165 Shown when a user attempts to recursively tag a tag object.
2168 <dt class="hdlist1
">
2173 Shown when <a href="git-push.html
">git-push(1)</a> rejects an update that
2174 does not qualify for fast-forwarding (e.g., a tag.)
2177 <dt class="hdlist1
">
2182 Shown when <a href="git-push.html
">git-push(1)</a> rejects an update that
2183 tries to overwrite a remote ref that points at an
2184 object we do not have.
2187 <dt class="hdlist1
">
2192 Shown when <a href="git-push.html
">git-push(1)</a> rejects an update that
2193 tries to overwrite a remote ref that points at an
2194 object that is not a commit-ish, or make the remote
2195 ref point at an object that is not a commit-ish.
2198 <dt class="hdlist1
">
2203 Shown when <a href="git-push.html
">git-push(1)</a> fails due to a
2204 non-fast-forward update to the current branch.
2207 <dt class="hdlist1
">
2212 Shown when the user ran <a href="git-push.html
">git-push(1)</a> and pushed
2213 "matching refs
" explicitly (i.e. used <code>:</code>, or
2214 specified a refspec that isn’t the current branch) and
2215 it resulted in a non-fast-forward error.
2218 <dt class="hdlist1
">
2223 Shown when <a href="git-push.html
">git-push(1)</a> rejects a forced update of
2224 a branch when its remote-tracking ref has updates that we
2225 do not have locally.
2228 <dt class="hdlist1
">
2229 pushUnqualifiedRefname
2233 Shown when <a href="git-push.html
">git-push(1)</a> gives up trying to
2234 guess based on the source and destination refs what
2235 remote ref namespace the source belongs in, but where
2236 we can still suggest that the user push to either
2237 <code>refs/heads/*</code> or <code>refs/tags/*</code> based on the type of the
2241 <dt class="hdlist1
">
2246 Set this variable to <code>false</code> if you want to disable
2247 <code>pushNonFFCurrent</code>, <code>pushNonFFMatching</code>, <code>pushAlreadyExists</code>,
2248 <code>pushFetchFirst</code>, <code>pushNeedsForce</code>, and <code>pushRefNeedsUpdate</code>
2252 <dt class="hdlist1
">
2257 Shown when the user provides an illegal ref name, to
2258 tell the user about the ref syntax documentation.
2261 <dt class="hdlist1
">
2266 Shown when <a href="git-reset.html
">git-reset(1)</a> takes more than 2
2267 seconds to refresh the index after reset, to tell the user
2268 that they can use the <code>--no-refresh</code> option.
2271 <dt class="hdlist1
">
2276 Shown by various commands when conflicts
2277 prevent the operation from being performed.
2280 <dt class="hdlist1
">
2285 Shown on failure in the output of <a href="git-rm.html
">git-rm(1)</a>, to
2286 give directions on how to proceed from the current state.
2289 <dt class="hdlist1
">
2294 Shown when a sequencer command is already in progress.
2297 <dt class="hdlist1
">
2302 Shown when <a href="git-rebase.html
">git-rebase(1)</a> skips a commit that has already
2303 been cherry-picked onto the upstream branch.
2306 <dt class="hdlist1
">
2311 Shown when <a href="git-status.html
">git-status(1)</a> computes the ahead/behind
2312 counts for a local ref compared to its remote tracking ref,
2313 and that calculation takes longer than expected. Will not
2314 appear if <code>status.aheadBehind</code> is false or the option
2315 <code>--no-ahead-behind</code> is given.
2318 <dt class="hdlist1
">
2323 Show directions on how to proceed from the current
2324 state in the output of <a href="git-status.html
">git-status(1)</a>, in
2325 the template shown when writing commit messages in
2326 <a href="git-commit.html
">git-commit(1)</a>, and in the help message shown
2327 by <a href="git-switch.html
">git-switch(1)</a> or
2328 <a href="git-checkout.html
">git-checkout(1)</a> when switching branches.
2331 <dt class="hdlist1
">
2336 Shown when <a href="git-status.html
">git-status(1)</a> takes more than 2
2337 seconds to enumerate untracked files, to tell the user that
2338 they can use the <code>-u</code> option.
2341 <dt class="hdlist1
">
2342 submoduleAlternateErrorStrategyDie
2346 Shown when a submodule.alternateErrorStrategy option
2347 configured to "die
" causes a fatal error.
2350 <dt class="hdlist1
">
2351 submoduleMergeConflict
2355 Advice shown when a non-trivial submodule merge conflict is
2359 <dt class="hdlist1
">
2360 submodulesNotUpdated
2364 Shown when a user runs a submodule command that fails
2365 because <code>git submodule update --init</code> was not run.
2368 <dt class="hdlist1
">
2369 suggestDetachingHead
2373 Shown when <a href="git-switch.html
">git-switch(1)</a> refuses to detach HEAD
2374 without the explicit <code>--detach</code> option.
2377 <dt class="hdlist1
">
2382 Shown when either <a href="git-add.html
">git-add(1)</a> or <a href="git-rm.html
">git-rm(1)</a>
2383 is asked to update index entries outside the current sparse
2387 <dt class="hdlist1
">
2392 Shown when Git is waiting for editor input. Relevant
2393 when e.g. the editor is not launched inside the terminal.
2396 <dt class="hdlist1
">
2401 Shown when the user tries to create a worktree from an
2402 invalid reference, to tell the user how to create a new unborn
2409 <dt class="hdlist1
">
2414 Command aliases for the <a href="git.html
">git(1)</a> command wrapper - e.g.
2415 after defining <code>alias.last = cat-file commit HEAD</code>, the invocation
2416 <code>git last</code> is equivalent to <code>git cat-file commit HEAD</code>. To avoid
2417 confusion and troubles with script usage, aliases that
2418 hide existing Git commands are ignored. Arguments are split by
2419 spaces, the usual shell quoting and escaping are supported.
2420 A quote pair or a backslash can be used to quote them.
2422 <div class="paragraph
"><p>Note that the first word of an alias does not necessarily have to be a
2423 command. It can be a command-line option that will be passed into the
2424 invocation of <code>git</code>. In particular, this is useful when used with <code>-c</code>
2425 to pass in one-time configurations or <code>-p</code> to force pagination. For example,
2426 <code>loud-rebase = -c commit.verbose=true rebase</code> can be defined such that
2427 running <code>git loud-rebase</code> would be equivalent to
2428 <code>git -c commit.verbose=true rebase</code>. Also, <code>ps = -p status</code> would be a
2429 helpful alias since <code>git ps</code> would paginate the output of <code>git status</code>
2430 where the original command does not.</p></div>
2431 <div class="paragraph
"><p>If the alias expansion is prefixed with an exclamation point,
2432 it will be treated as a shell command. For example, defining
2433 <code>alias.new = !gitk --all --not ORIG_HEAD</code>, the invocation
2434 <code>git new</code> is equivalent to running the shell command
2435 <code>gitk --all --not ORIG_HEAD</code>. Note that shell commands will be
2436 executed from the top-level directory of a repository, which may
2437 not necessarily be the current directory.
2438 <code>GIT_PREFIX</code> is set as returned by running <code>git rev-parse --show-prefix</code>
2439 from the original current directory. See <a href="git-rev-parse.html
">git-rev-parse(1)</a>.</p></div>
2441 <dt class="hdlist1
">
2446 If true, git-am will call git-mailsplit for patches in mbox format
2447 with parameter <code>--keep-cr</code>. In this case git-mailsplit will
2448 not remove <code>\r</code> from lines ending with <code>\r\n</code>. Can be overridden
2449 by giving <code>--no-keep-cr</code> from the command line.
2450 See <a href="git-am.html
">git-am(1)</a>, <a href="git-mailsplit.html
">git-mailsplit(1)</a>.
2453 <dt class="hdlist1
">
2458 By default, <code>git am</code> will fail if the patch does not apply cleanly. When
2459 set to true, this setting tells <code>git am</code> to fall back on 3-way merge if
2460 the patch records the identity of blobs it is supposed to apply to and
2461 we have those blobs available locally (equivalent to giving the <code>--3way</code>
2462 option from the command line). Defaults to <code>false</code>.
2463 See <a href="git-am.html
">git-am(1)</a>.
2466 <dt class="hdlist1
">
2467 apply.ignoreWhitespace
2471 When set to <em>change</em>, tells <em>git apply</em> to ignore changes in
2472 whitespace, in the same way as the <code>--ignore-space-change</code>
2474 When set to one of: no, none, never, false, it tells <em>git apply</em> to
2475 respect all whitespace differences.
2476 See <a href="git-apply.html
">git-apply(1)</a>.
2479 <dt class="hdlist1
">
2484 Tells <em>git apply</em> how to handle whitespace, in the same way
2485 as the <code>--whitespace</code> option. See <a href="git-apply.html
">git-apply(1)</a>.
2488 <dt class="hdlist1
">
2493 A reference to a tree in the repository from which to read attributes,
2494 instead of the <code>.gitattributes</code> file in the working tree. In a bare
2495 repository, this defaults to <code>HEAD:.gitattributes</code>. If the value does
2496 not resolve to a valid tree object, an empty tree is used instead.
2497 When the <code>GIT_ATTR_SOURCE</code> environment variable or <code>--attr-source</code>
2498 command line option are used, this configuration variable has no effect.
2501 <dt class="hdlist1
">
2506 Show blank commit object name for boundary commits in
2507 <a href="git-blame.html
">git-blame(1)</a>. This option defaults to false.
2510 <dt class="hdlist1
">
2515 This determines the coloring scheme to be applied to blame
2516 output. It can be <em>repeatedLines</em>, <em>highlightRecent</em>,
2517 or <em>none</em> which is the default.
2520 <dt class="hdlist1
">
2525 Specifies the format used to output dates in <a href="git-blame.html
">git-blame(1)</a>.
2526 If unset the iso format is used. For supported values,
2527 see the discussion of the <code>--date</code> option at <a href="git-log.html
">git-log(1)</a>.
2530 <dt class="hdlist1
">
2535 Show the author email instead of author name in <a href="git-blame.html
">git-blame(1)</a>.
2536 This option defaults to false.
2539 <dt class="hdlist1
">
2544 Do not treat root commits as boundaries in <a href="git-blame.html
">git-blame(1)</a>.
2545 This option defaults to false.
2548 <dt class="hdlist1
">
2549 blame.ignoreRevsFile
2553 Ignore revisions listed in the file, one unabbreviated object name per
2554 line, in <a href="git-blame.html
">git-blame(1)</a>. Whitespace and comments beginning with
2555 <code>#</code> are ignored. This option may be repeated multiple times. Empty
2556 file names will reset the list of ignored revisions. This option will
2557 be handled before the command line option <code>--ignore-revs-file</code>.
2560 <dt class="hdlist1
">
2561 blame.markUnblamableLines
2565 Mark lines that were changed by an ignored revision that we could not
2566 attribute to another commit with a <em>*</em> in the output of
2567 <a href="git-blame.html
">git-blame(1)</a>.
2570 <dt class="hdlist1
">
2571 blame.markIgnoredLines
2575 Mark lines that were changed by an ignored revision that we attributed to
2576 another commit with a <em>?</em> in the output of <a href="git-blame.html
">git-blame(1)</a>.
2579 <dt class="hdlist1
">
2580 branch.autoSetupMerge
2584 Tells <em>git branch</em>, <em>git switch</em> and <em>git checkout</em> to set up new branches
2585 so that <a href="git-pull.html
">git-pull(1)</a> will appropriately merge from the
2586 starting point branch. Note that even if this option is not set,
2587 this behavior can be chosen per-branch using the <code>--track</code>
2588 and <code>--no-track</code> options. The valid settings are: <code>false</code> — no
2589 automatic setup is done; <code>true</code> — automatic setup is done when the
2590 starting point is a remote-tracking branch; <code>always</code> —  automatic setup is done when the starting point is either a
2591 local branch or remote-tracking branch; <code>inherit</code> — if the starting point
2592 has a tracking configuration, it is copied to the new
2593 branch; <code>simple</code> — automatic setup is done only when the starting point
2594 is a remote-tracking branch and the new branch has the same name as the
2595 remote branch. This option defaults to true.
2598 <dt class="hdlist1
">
2599 branch.autoSetupRebase
2603 When a new branch is created with <em>git branch</em>, <em>git switch</em> or <em>git checkout</em>
2604 that tracks another branch, this variable tells Git to set
2605 up pull to rebase instead of merge (see "branch.
<name
>.rebase
").
2606 When <code>never</code>, rebase is never automatically set to true.
2607 When <code>local</code>, rebase is set to true for tracked branches of
2608 other local branches.
2609 When <code>remote</code>, rebase is set to true for tracked branches of
2610 remote-tracking branches.
2611 When <code>always</code>, rebase will be set to true for all tracking
2613 See "branch.autoSetupMerge
" for details on how to set up a
2614 branch to track another branch.
2615 This option defaults to never.
2618 <dt class="hdlist1
">
2623 This variable controls the sort ordering of branches when displayed by
2624 <a href="git-branch.html
">git-branch(1)</a>. Without the "--sort=
<value
>" option provided, the
2625 value of this variable will be used as the default.
2626 See <a href="git-for-each-ref.html
">git-for-each-ref(1)</a> field names for valid values.
2629 <dt class="hdlist1
">
2630 branch.<name>.remote
2634 When on branch <name>, it tells <em>git fetch</em> and <em>git push</em>
2635 which remote to fetch from or push to. The remote to push to
2636 may be overridden with <code>remote.pushDefault</code> (for all branches).
2637 The remote to push to, for the current branch, may be further
2638 overridden by <code>branch.<name>.pushRemote</code>. If no remote is
2639 configured, or if you are not on any branch and there is more than
2640 one remote defined in the repository, it defaults to <code>origin</code> for
2641 fetching and <code>remote.pushDefault</code> for pushing.
2642 Additionally, <code>.</code> (a period) is the current local repository
2643 (a dot-repository), see <code>branch.<name>.merge</code>'s final note below.
2646 <dt class="hdlist1
">
2647 branch.<name>.pushRemote
2651 When on branch <name>, it overrides <code>branch.<name>.remote</code> for
2652 pushing. It also overrides <code>remote.pushDefault</code> for pushing
2653 from branch <name>. When you pull from one place (e.g. your
2654 upstream) and push to another place (e.g. your own publishing
2655 repository), you would want to set <code>remote.pushDefault</code> to
2656 specify the remote to push to for all branches, and use this
2657 option to override it for a specific branch.
2660 <dt class="hdlist1
">
2661 branch.<name>.merge
2665 Defines, together with branch.<name>.remote, the upstream branch
2666 for the given branch. It tells <em>git fetch</em>/<em>git pull</em>/<em>git rebase</em> which
2667 branch to merge and can also affect <em>git push</em> (see push.default).
2668 When in branch <name>, it tells <em>git fetch</em> the default
2669 refspec to be marked for merging in FETCH_HEAD. The value is
2670 handled like the remote part of a refspec, and must match a
2671 ref which is fetched from the remote given by
2672 "branch.
<name
>.remote
".
2673 The merge information is used by <em>git pull</em> (which first calls
2674 <em>git fetch</em>) to lookup the default branch for merging. Without
2675 this option, <em>git pull</em> defaults to merge the first refspec fetched.
2676 Specify multiple values to get an octopus merge.
2677 If you wish to setup <em>git pull</em> so that it merges into <name> from
2678 another branch in the local repository, you can point
2679 branch.<name>.merge to the desired branch, and use the relative path
2680 setting <code>.</code> (a period) for branch.<name>.remote.
2683 <dt class="hdlist1
">
2684 branch.<name>.mergeOptions
2688 Sets default options for merging into branch <name>. The syntax and
2689 supported options are the same as those of <a href="git-merge.html
">git-merge(1)</a>, but
2690 option values containing whitespace characters are currently not
2694 <dt class="hdlist1
">
2695 branch.<name>.rebase
2699 When true, rebase the branch <name> on top of the fetched branch,
2700 instead of merging the default branch from the default remote when
2701 "git pull
" is run. See "pull.rebase
" for doing this in a non
2702 branch-specific manner.
2704 <div class="paragraph
"><p>When <code>merges</code> (or just <em>m</em>), pass the <code>--rebase-merges</code> option to <em>git rebase</em>
2705 so that the local merge commits are included in the rebase (see
2706 <a href="git-rebase.html
">git-rebase(1)</a> for details).</p></div>
2707 <div class="paragraph
"><p>When the value is <code>interactive</code> (or just <em>i</em>), the rebase is run in interactive
2709 <div class="paragraph
"><p><strong>NOTE</strong>: this is a possibly dangerous operation; do <strong>not</strong> use
2710 it unless you understand the implications (see <a href="git-rebase.html
">git-rebase(1)</a>
2711 for details).</p></div>
2713 <dt class="hdlist1
">
2714 branch.<name>.description
2718 Branch description, can be edited with
2719 <code>git branch --edit-description</code>. Branch description is
2720 automatically added to the format-patch cover letter or
2721 request-pull summary.
2724 <dt class="hdlist1
">
2725 browser.<tool>.cmd
2729 Specify the command to invoke the specified browser. The
2730 specified command is evaluated in shell with the URLs passed
2731 as arguments. (See <a href="git-web
--browse.html
">git-web--browse(1)</a>.)
2734 <dt class="hdlist1
">
2735 browser.<tool>.path
2739 Override the path for the given tool that may be used to
2740 browse HTML help (see <code>-w</code> option in <a href="git-help.html
">git-help(1)</a>) or a
2741 working repository in gitweb (see <a href="git-instaweb.html
">git-instaweb(1)</a>).
2744 <dt class="hdlist1
">
2749 The <code>bundle.*</code> keys may appear in a bundle list file found via the
2750 <code>git clone --bundle-uri</code> option. These keys currently have no effect
2751 if placed in a repository config file, though this will change in the
2752 future. See <a href="technical/bundle-uri.html
">the bundle URI design
2753 document</a> for more details.
2756 <dt class="hdlist1
">
2761 This integer value advertises the version of the bundle list format
2762 used by the bundle list. Currently, the only accepted value is <code>1</code>.
2765 <dt class="hdlist1
">
2770 This string value should be either <code>all</code> or <code>any</code>. This value describes
2771 whether all of the advertised bundles are required to unbundle a
2772 complete understanding of the bundled information (<code>all</code>) or if any one
2773 of the listed bundle URIs is sufficient (<code>any</code>).
2776 <dt class="hdlist1
">
2781 If this string-valued key exists, then the bundle list is designed to
2782 work well with incremental <code>git fetch</code> commands. The heuristic signals
2783 that there are additional keys available for each bundle that help
2784 determine which subset of bundles the client should download. The
2785 only value currently understood is <code>creationToken</code>.
2788 <dt class="hdlist1
">
2793 The <code>bundle.<id>.*</code> keys are used to describe a single item in the
2794 bundle list, grouped under <code><id></code> for identification purposes.
2797 <dt class="hdlist1
">
2798 bundle.<id>.uri
2802 This string value defines the URI by which Git can reach the contents
2803 of this <code><id></code>. This URI may be a bundle file or another bundle list.
2806 <dt class="hdlist1
">
2807 checkout.defaultRemote
2811 When you run <code>git checkout <something></code>
2812 or <code>git switch <something></code> and only have one
2813 remote, it may implicitly fall back on checking out and
2814 tracking e.g. <code>origin/<something></code>. This stops working as soon
2815 as you have more than one remote with a <code><something></code>
2816 reference. This setting allows for setting the name of a
2817 preferred remote that should always win when it comes to
2818 disambiguation. The typical use-case is to set this to
2819 <code>origin</code>.
2821 <div class="paragraph
"><p>Currently this is used by <a href="git-switch.html
">git-switch(1)</a> and
2822 <a href="git-checkout.html
">git-checkout(1)</a> when <code>git checkout <something></code>
2823 or <code>git switch <something></code>
2824 will checkout the <code><something></code> branch on another remote,
2825 and by <a href="git-worktree.html
">git-worktree(1)</a> when <code>git worktree add</code> refers to a
2826 remote branch. This setting might be used for other checkout-like
2827 commands or functionality in the future.</p></div>
2829 <dt class="hdlist1
">
2834 Provides the default value for the <code>--guess</code> or <code>--no-guess</code>
2835 option in <code>git checkout</code> and <code>git switch</code>. See
2836 <a href="git-switch.html
">git-switch(1)</a> and <a href="git-checkout.html
">git-checkout(1)</a>.
2839 <dt class="hdlist1
">
2844 The number of parallel workers to use when updating the working tree.
2845 The default is one, i.e. sequential execution. If set to a value less
2846 than one, Git will use as many workers as the number of logical cores
2847 available. This setting and <code>checkout.thresholdForParallelism</code> affect
2848 all commands that perform checkout. E.g. checkout, clone, reset,
2849 sparse-checkout, etc.
2851 <div class="paragraph
"><p>Note: Parallel checkout usually delivers better performance for repositories
2852 located on SSDs or over NFS. For repositories on spinning disks and/or machines
2853 with a small number of cores, the default sequential checkout often performs
2854 better. The size and compression level of a repository might also influence how
2855 well the parallel version performs.</p></div>
2857 <dt class="hdlist1
">
2858 checkout.thresholdForParallelism
2862 When running parallel checkout with a small number of files, the cost
2863 of subprocess spawning and inter-process communication might outweigh
2864 the parallelization gains. This setting allows you to define the minimum
2865 number of files for which parallel checkout should be attempted. The
2869 <dt class="hdlist1
">
2874 A boolean to make git-clean refuse to delete files unless -f
2875 is given. Defaults to true.
2878 <dt class="hdlist1
">
2879 clone.defaultRemoteName
2883 The name of the remote to create when cloning a repository. Defaults to
2884 <code>origin</code>, and can be overridden by passing the <code>--origin</code> command-line
2885 option to <a href="git-clone.html
">git-clone(1)</a>.
2888 <dt class="hdlist1
">
2893 Reject cloning a repository if it is a shallow one; this can be overridden by
2894 passing the <code>--reject-shallow</code> option on the command line. See <a href="git-clone.html
">git-clone(1)</a>
2897 <dt class="hdlist1
">
2898 clone.filterSubmodules
2902 If a partial clone filter is provided (see <code>--filter</code> in
2903 <a href="git-rev-list.html
">git-rev-list(1)</a>) and <code>--recurse-submodules</code> is used, also apply
2904 the filter to submodules.
2907 <dt class="hdlist1
">
2912 A boolean to enable/disable color in hints (e.g. when a push
2913 failed, see <code>advice.*</code> for a list). May be set to <code>always</code>,
2914 <code>false</code> (or <code>never</code>) or <code>auto</code> (or <code>true</code>), in which case colors
2915 are used only when the error output goes to a terminal. If
2916 unset, then the value of <code>color.ui</code> is used (<code>auto</code> by default).
2919 <dt class="hdlist1
">
2924 Use customized color for hints.
2927 <dt class="hdlist1
">
2928 color.blame.highlightRecent
2932 Specify the line annotation color for <code>git blame --color-by-age</code>
2933 depending upon the age of the line.
2935 <div class="paragraph
"><p>This setting should be set to a comma-separated list of color and
2936 date settings, starting and ending with a color, the dates should be
2937 set from oldest to newest. The metadata will be colored with the
2938 specified colors if the line was introduced before the given
2939 timestamp, overwriting older timestamped colors.</p></div>
2940 <div class="paragraph
"><p>Instead of an absolute timestamp relative timestamps work as well,
2941 e.g. <code>2.weeks.ago</code> is valid to address anything older than 2 weeks.</p></div>
2942 <div class="paragraph
"><p>It defaults to <code>blue,12 month ago,white,1 month ago,red</code>, which
2943 colors everything older than one year blue, recent changes between
2944 one month and one year old are kept white, and lines introduced
2945 within the last month are colored red.</p></div>
2947 <dt class="hdlist1
">
2948 color.blame.repeatedLines
2952 Use the specified color to colorize line annotations for
2953 <code>git blame --color-lines</code>, if they come from the same commit as the
2954 preceding line. Defaults to cyan.
2957 <dt class="hdlist1
">
2962 A boolean to enable/disable color in the output of
2963 <a href="git-branch.html
">git-branch(1)</a>. May be set to <code>always</code>,
2964 <code>false</code> (or <code>never</code>) or <code>auto</code> (or <code>true</code>), in which case colors are used
2965 only when the output is to a terminal. If unset, then the
2966 value of <code>color.ui</code> is used (<code>auto</code> by default).
2969 <dt class="hdlist1
">
2970 color.branch.<slot>
2974 Use customized color for branch coloration. <code><slot></code> is one of
2975 <code>current</code> (the current branch), <code>local</code> (a local branch),
2976 <code>remote</code> (a remote-tracking branch in refs/remotes/),
2977 <code>upstream</code> (upstream tracking branch), <code>plain</code> (other
2981 <dt class="hdlist1
">
2986 Whether to use ANSI escape sequences to add color to patches.
2987 If this is set to <code>always</code>, <a href="git-diff.html
">git-diff(1)</a>,
2988 <a href="git-log.html
">git-log(1)</a>, and <a href="git-show.html
">git-show(1)</a> will use color
2989 for all patches. If it is set to <code>true</code> or <code>auto</code>, those
2990 commands will only use color when output is to the terminal.
2991 If unset, then the value of <code>color.ui</code> is used (<code>auto</code> by
2994 <div class="paragraph
"><p>This does not affect <a href="git-format-patch.html
">git-format-patch(1)</a> or the
2995 <em>git-diff-*</em> plumbing commands. Can be overridden on the
2996 command line with the <code>--color[=<when>]</code> option.</p></div>
2998 <dt class="hdlist1
">
2999 color.diff.<slot>
3003 Use customized color for diff colorization. <code><slot></code> specifies
3004 which part of the patch to use the specified color, and is one
3005 of <code>context</code> (context text - <code>plain</code> is a historical synonym),
3006 <code>meta</code> (metainformation), <code>frag</code>
3007 (hunk header), <em>func</em> (function in hunk header), <code>old</code> (removed lines),
3008 <code>new</code> (added lines), <code>commit</code> (commit headers), <code>whitespace</code>
3009 (highlighting whitespace errors), <code>oldMoved</code> (deleted lines),
3010 <code>newMoved</code> (added lines), <code>oldMovedDimmed</code>, <code>oldMovedAlternative</code>,
3011 <code>oldMovedAlternativeDimmed</code>, <code>newMovedDimmed</code>, <code>newMovedAlternative</code>
3012 <code>newMovedAlternativeDimmed</code> (See the <em><mode></em>
3013 setting of <em>--color-moved</em> in <a href="git-diff.html
">git-diff(1)</a> for details),
3014 <code>contextDimmed</code>, <code>oldDimmed</code>, <code>newDimmed</code>, <code>contextBold</code>,
3015 <code>oldBold</code>, and <code>newBold</code> (see <a href="git-range-diff.html
">git-range-diff(1)</a> for details).
3018 <dt class="hdlist1
">
3019 color.decorate.<slot>
3023 Use customized color for <em>git log --decorate</em> output. <code><slot></code> is one
3024 of <code>branch</code>, <code>remoteBranch</code>, <code>tag</code>, <code>stash</code> or <code>HEAD</code> for local
3025 branches, remote-tracking branches, tags, stash and HEAD, respectively
3026 and <code>grafted</code> for grafted commits.
3029 <dt class="hdlist1
">
3034 When set to <code>always</code>, always highlight matches. When <code>false</code> (or
3035 <code>never</code>), never. When set to <code>true</code> or <code>auto</code>, use color only
3036 when the output is written to the terminal. If unset, then the
3037 value of <code>color.ui</code> is used (<code>auto</code> by default).
3040 <dt class="hdlist1
">
3041 color.grep.<slot>
3045 Use customized color for grep colorization. <code><slot></code> specifies which
3046 part of the line to use the specified color, and is one of
3048 <div class="openblock
">
3049 <div class="content
">
3050 <div class="dlist
"><dl>
3051 <dt class="hdlist1
">
3052 <code>context</code>
3056 non-matching text in context lines (when using <code>-A</code>, <code>-B</code>, or <code>-C</code>)
3059 <dt class="hdlist1
">
3060 <code>filename</code>
3064 filename prefix (when not using <code>-h</code>)
3067 <dt class="hdlist1
">
3068 <code>function</code>
3072 function name lines (when using <code>-p</code>)
3075 <dt class="hdlist1
">
3076 <code>lineNumber</code>
3080 line number prefix (when using <code>-n</code>)
3083 <dt class="hdlist1
">
3088 column number prefix (when using <code>--column</code>)
3091 <dt class="hdlist1
">
3096 matching text (same as setting <code>matchContext</code> and <code>matchSelected</code>)
3099 <dt class="hdlist1
">
3100 <code>matchContext</code>
3104 matching text in context lines
3107 <dt class="hdlist1
">
3108 <code>matchSelected</code>
3112 matching text in selected lines. Also, used to customize the following
3113 <a href="git-log.html
">git-log(1)</a> subcommands: <code>--grep</code>, <code>--author</code>, and <code>--committer</code>.
3116 <dt class="hdlist1
">
3117 <code>selected</code>
3121 non-matching text in selected lines. Also, used to customize the
3122 following <a href="git-log.html
">git-log(1)</a> subcommands: <code>--grep</code>, <code>--author</code> and
3123 <code>--committer</code>.
3126 <dt class="hdlist1
">
3127 <code>separator</code>
3131 separators between fields on a line (<code>:</code>, <code>-</code>, and <code>=</code>)
3132 and between hunks (<code>--</code>)
3138 <dt class="hdlist1
">
3143 When set to <code>always</code>, always use colors for interactive prompts
3144 and displays (such as those used by "git-add --interactive
" and
3145 "git-clean --interactive
"). When false (or <code>never</code>), never.
3146 When set to <code>true</code> or <code>auto</code>, use colors only when the output is
3147 to the terminal. If unset, then the value of <code>color.ui</code> is
3148 used (<code>auto</code> by default).
3151 <dt class="hdlist1
">
3152 color.interactive.<slot>
3156 Use customized color for <em>git add --interactive</em> and <em>git clean
3157 --interactive</em> output. <code><slot></code> may be <code>prompt</code>, <code>header</code>, <code>help</code>
3158 or <code>error</code>, for four distinct types of normal output from
3159 interactive commands.
3162 <dt class="hdlist1
">
3167 A boolean to specify whether <code>auto</code> color modes should colorize
3168 output going to the pager. Defaults to true; set this to false
3169 if your pager does not understand ANSI color codes.
3172 <dt class="hdlist1
">
3177 A boolean to enable/disable color in push errors. May be set to
3178 <code>always</code>, <code>false</code> (or <code>never</code>) or <code>auto</code> (or <code>true</code>), in which
3179 case colors are used only when the error output goes to a terminal.
3180 If unset, then the value of <code>color.ui</code> is used (<code>auto</code> by default).
3183 <dt class="hdlist1
">
3188 Use customized color for push errors.
3191 <dt class="hdlist1
">
3196 If set, keywords at the start of the line are highlighted. The
3197 keywords are "error
", "warning
", "hint
" and "success
", and are
3198 matched case-insensitively. May be set to <code>always</code>, <code>false</code> (or
3199 <code>never</code>) or <code>auto</code> (or <code>true</code>). If unset, then the value of
3200 <code>color.ui</code> is used (<code>auto</code> by default).
3203 <dt class="hdlist1
">
3204 color.remote.<slot>
3208 Use customized color for each remote keyword. <code><slot></code> may be
3209 <code>hint</code>, <code>warning</code>, <code>success</code> or <code>error</code> which match the
3210 corresponding keyword.
3213 <dt class="hdlist1
">
3218 A boolean to enable/disable color in the output of
3219 <a href="git-show-branch.html
">git-show-branch(1)</a>. May be set to <code>always</code>,
3220 <code>false</code> (or <code>never</code>) or <code>auto</code> (or <code>true</code>), in which case colors are used
3221 only when the output is to a terminal. If unset, then the
3222 value of <code>color.ui</code> is used (<code>auto</code> by default).
3225 <dt class="hdlist1
">
3230 A boolean to enable/disable color in the output of
3231 <a href="git-status.html
">git-status(1)</a>. May be set to <code>always</code>,
3232 <code>false</code> (or <code>never</code>) or <code>auto</code> (or <code>true</code>), in which case colors are used
3233 only when the output is to a terminal. If unset, then the
3234 value of <code>color.ui</code> is used (<code>auto</code> by default).
3237 <dt class="hdlist1
">
3238 color.status.<slot>
3242 Use customized color for status colorization. <code><slot></code> is
3243 one of <code>header</code> (the header text of the status message),
3244 <code>added</code> or <code>updated</code> (files which are added but not committed),
3245 <code>changed</code> (files which are changed but not added in the index),
3246 <code>untracked</code> (files which are not tracked by Git),
3247 <code>branch</code> (the current branch),
3248 <code>nobranch</code> (the color the <em>no branch</em> warning is shown in, defaulting
3250 <code>localBranch</code> or <code>remoteBranch</code> (the local and remote branch names,
3251 respectively, when branch and tracking information is displayed in the
3252 status short-format), or
3253 <code>unmerged</code> (files which have unmerged changes).
3256 <dt class="hdlist1
">
3261 A boolean to enable/disable color when pushes are rejected. May be
3262 set to <code>always</code>, <code>false</code> (or <code>never</code>) or <code>auto</code> (or <code>true</code>), in which
3263 case colors are used only when the error output goes to a terminal.
3264 If unset, then the value of <code>color.ui</code> is used (<code>auto</code> by default).
3267 <dt class="hdlist1
">
3268 color.transport.rejected
3272 Use customized color when a push was rejected.
3275 <dt class="hdlist1
">
3280 This variable determines the default value for variables such
3281 as <code>color.diff</code> and <code>color.grep</code> that control the use of color
3282 per command family. Its scope will expand as more commands learn
3283 configuration to set a default for the <code>--color</code> option. Set it
3284 to <code>false</code> or <code>never</code> if you prefer Git commands not to use
3285 color unless enabled explicitly with some other configuration
3286 or the <code>--color</code> option. Set it to <code>always</code> if you want all
3287 output not intended for machine consumption to use color, to
3288 <code>true</code> or <code>auto</code> (this is the default since Git 1.8.4) if you
3289 want such output to use color when written to the terminal.
3292 <dt class="hdlist1
">
3297 Specify whether supported commands should output in columns.
3298 This variable consists of a list of tokens separated by spaces
3301 <div class="paragraph
"><p>These options control when the feature should be enabled
3302 (defaults to <em>never</em>):</p></div>
3303 <div class="openblock
">
3304 <div class="content
">
3305 <div class="dlist
"><dl>
3306 <dt class="hdlist1
">
3311 always show in columns
3314 <dt class="hdlist1
">
3319 never show in columns
3322 <dt class="hdlist1
">
3327 show in columns if the output is to the terminal
3332 <div class="paragraph
"><p>These options control layout (defaults to <em>column</em>). Setting any
3333 of these implies <em>always</em> if none of <em>always</em>, <em>never</em>, or <em>auto</em> are
3334 specified.</p></div>
3335 <div class="openblock
">
3336 <div class="content
">
3337 <div class="dlist
"><dl>
3338 <dt class="hdlist1
">
3343 fill columns before rows
3346 <dt class="hdlist1
">
3351 fill rows before columns
3354 <dt class="hdlist1
">
3364 <div class="paragraph
"><p>Finally, these options can be combined with a layout option (defaults
3365 to <em>nodense</em>):</p></div>
3366 <div class="openblock
">
3367 <div class="content
">
3368 <div class="dlist
"><dl>
3369 <dt class="hdlist1
">
3374 make unequal size columns to utilize more space
3377 <dt class="hdlist1
">
3378 <code>nodense</code>
3382 make equal size columns
3388 <dt class="hdlist1
">
3393 Specify whether to output branch listing in <code>git branch</code> in columns.
3394 See <code>column.ui</code> for details.
3397 <dt class="hdlist1
">
3402 Specify the layout when listing items in <code>git clean -i</code>, which always
3403 shows files and directories in columns. See <code>column.ui</code> for details.
3406 <dt class="hdlist1
">
3411 Specify whether to output untracked files in <code>git status</code> in columns.
3412 See <code>column.ui</code> for details.
3415 <dt class="hdlist1
">
3420 Specify whether to output tag listings in <code>git tag</code> in columns.
3421 See <code>column.ui</code> for details.
3424 <dt class="hdlist1
">
3429 This setting overrides the default of the <code>--cleanup</code> option in
3430 <code>git commit</code>. See <a href="git-commit.html
">git-commit(1)</a> for details. Changing the
3431 default can be useful when you always want to keep lines that begin
3432 with the comment character <code>#</code> in your log message, in which case you
3433 would do <code>git config commit.cleanup whitespace</code> (note that you will
3434 have to remove the help lines that begin with <code>#</code> in the commit log
3435 template yourself, if you do this).
3438 <dt class="hdlist1
">
3443 A boolean to specify whether all commits should be GPG signed.
3444 Use of this option when doing operations such as rebase can
3445 result in a large number of commits being signed. It may be
3446 convenient to use an agent to avoid typing your GPG passphrase
3450 <dt class="hdlist1
">
3455 A boolean to enable/disable inclusion of status information in the
3456 commit message template when using an editor to prepare the commit
3457 message. Defaults to true.
3460 <dt class="hdlist1
">
3465 Specify the pathname of a file to use as the template for
3466 new commit messages.
3469 <dt class="hdlist1
">
3474 A boolean or int to specify the level of verbosity with <code>git commit</code>.
3475 See <a href="git-commit.html
">git-commit(1)</a>.
3478 <dt class="hdlist1
">
3479 commitGraph.generationVersion
3483 Specifies the type of generation number version to use when writing
3484 or reading the commit-graph file. If version 1 is specified, then
3485 the corrected commit dates will not be written or read. Defaults to
3489 <dt class="hdlist1
">
3490 commitGraph.maxNewFilters
3494 Specifies the default value for the <code>--max-new-filters</code> option of <code>git
3495 commit-graph write</code> (c.f., <a href="git-commit-graph.html
">git-commit-graph(1)</a>).
3498 <dt class="hdlist1
">
3499 commitGraph.readChangedPaths
3503 If true, then git will use the changed-path Bloom filters in the
3504 commit-graph file (if it exists, and they are present). Defaults to
3505 true. See <a href="git-commit-graph.html
">git-commit-graph(1)</a> for more information.
3508 <dt class="hdlist1
">
3513 This is only used by git-completion.bash to add or remove
3514 commands from the list of completed commands. Normally only
3515 porcelain commands and a few select others are completed. You
3516 can add more commands, separated by space, in this
3517 variable. Prefixing the command with <em>-</em> will remove it from
3521 <dt class="hdlist1
">
3526 Tells Git if the executable bit of files in the working tree
3529 <div class="paragraph
"><p>Some filesystems lose the executable bit when a file that is
3530 marked as executable is checked out, or checks out a
3531 non-executable file with executable bit on.
3532 <a href="git-clone.html
">git-clone(1)</a> or <a href="git-init.html
">git-init(1)</a> probe the filesystem
3533 to see if it handles the executable bit correctly
3534 and this variable is automatically set as necessary.</p></div>
3535 <div class="paragraph
"><p>A repository, however, may be on a filesystem that handles
3536 the filemode correctly, and this variable is set to <em>true</em>
3537 when created, but later may be made accessible from another
3538 environment that loses the filemode (e.g. exporting ext4 via
3539 CIFS mount, visiting a Cygwin created repository with
3540 Git for Windows or Eclipse).
3541 In such a case it may be necessary to set this variable to <em>false</em>.
3542 See <a href="git-update-index.html
">git-update-index(1)</a>.</p></div>
3543 <div class="paragraph
"><p>The default is true (when core.filemode is not specified in the config file).</p></div>
3545 <dt class="hdlist1
">
3550 (Windows-only) If true, mark newly-created directories and files whose
3551 name starts with a dot as hidden. If <em>dotGitOnly</em>, only the <code>.git/</code>
3552 directory is hidden, but no other files starting with a dot. The
3553 default mode is <em>dotGitOnly</em>.
3556 <dt class="hdlist1
">
3561 Internal variable which enables various workarounds to enable
3562 Git to work better on filesystems that are not case sensitive,
3563 like APFS, HFS+, FAT, NTFS, etc. For example, if a directory listing
3564 finds "makefile
" when Git expects "Makefile
", Git will assume
3565 it is really the same file, and continue to remember it as
3568 <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>
3569 will probe and set core.ignoreCase true if appropriate when the repository
3570 is created.</p></div>
3571 <div class="paragraph
"><p>Git relies on the proper configuration of this variable for your operating
3572 and file system. Modifying this value may result in unexpected behavior.</p></div>
3574 <dt class="hdlist1
">
3575 core.precomposeUnicode
3579 This option is only used by Mac OS implementation of Git.
3580 When core.precomposeUnicode=true, Git reverts the unicode decomposition
3581 of filenames done by Mac OS. This is useful when sharing a repository
3582 between Mac OS and Linux or Windows.
3583 (Git for Windows 1.7.10 or higher is needed, or Git under cygwin 1.7).
3584 When false, file names are handled fully transparent by Git,
3585 which is backward compatible with older versions of Git.
3588 <dt class="hdlist1
">
3593 If set to true, do not allow checkout of paths that would
3594 be considered equivalent to <code>.git</code> on an HFS+ filesystem.
3595 Defaults to <code>true</code> on Mac OS, and <code>false</code> elsewhere.
3598 <dt class="hdlist1
">
3603 If set to true, do not allow checkout of paths that would
3604 cause problems with the NTFS filesystem, e.g. conflict with
3606 Defaults to <code>true</code> on Windows, and <code>false</code> elsewhere.
3609 <dt class="hdlist1
">
3614 If set to true, enable the built-in file system monitor
3615 daemon for this working directory (<a href="git-fsmonitor
--daemon.html
">git-fsmonitor--daemon(1)</a>).
3617 <div class="paragraph
"><p>Like hook-based file system monitors, the built-in file system monitor
3618 can speed up Git commands that need to refresh the Git index
3619 (e.g. <code>git status</code>) in a working directory with many files. The
3620 built-in monitor eliminates the need to install and maintain an
3621 external third-party tool.</p></div>
3622 <div class="paragraph
"><p>The built-in file system monitor is currently available only on a
3623 limited set of supported platforms. Currently, this includes Windows
3624 and MacOS.</p></div>
3625 <div class="literalblock
">
3626 <div class="content
">
3627 <pre><code>Otherwise, this variable contains the pathname of the "fsmonitor
"
3628 hook command.</code></pre>
3630 <div class="paragraph
"><p>This hook command is used to identify all files that may have changed
3631 since the requested date/time. This information is used to speed up
3632 git by avoiding unnecessary scanning of files that have not changed.</p></div>
3633 <div class="paragraph
"><p>See the "fsmonitor-watchman
" section of <a href="githooks.html
">githooks(5)</a>.</p></div>
3634 <div class="paragraph
"><p>Note that if you concurrently use multiple versions of Git, such
3635 as one version on the command line and another version in an IDE
3636 tool, that the definition of <code>core.fsmonitor</code> was extended to
3637 allow boolean values in addition to hook pathnames. Git versions
3638 2.35.1 and prior will not understand the boolean values and will
3639 consider the "true
" or "false
" values as hook pathnames to be
3640 invoked. Git versions 2.26 thru 2.35.1 default to hook protocol
3641 V2 and will fall back to no fsmonitor (full scan). Git versions
3642 prior to 2.26 default to hook protocol V1 and will silently
3643 assume there were no changes to report (no scan), so status
3644 commands may report incomplete results. For this reason, it is
3645 best to upgrade all of your Git versions before using the built-in
3646 file system monitor.</p></div>
3648 <dt class="hdlist1
">
3649 core.fsmonitorHookVersion
3653 Sets the protocol version to be used when invoking the
3656 <div class="paragraph
"><p>There are currently versions 1 and 2. When this is not set,
3657 version 2 will be tried first and if it fails then version 1
3658 will be tried. Version 1 uses a timestamp as input to determine
3659 which files have changes since that time but some monitors
3660 like Watchman have race conditions when used with a timestamp.
3661 Version 2 uses an opaque string so that the monitor can return
3662 something that can be used to determine what files have changed
3663 without race conditions.</p></div>
3665 <dt class="hdlist1
">
3670 If false, the ctime differences between the index and the
3671 working tree are ignored; useful when the inode change time
3672 is regularly modified by something outside Git (file system
3673 crawlers and some backup systems).
3674 See <a href="git-update-index.html
">git-update-index(1)</a>. True by default.
3677 <dt class="hdlist1
">
3682 If true, the split-index feature of the index will be used.
3683 See <a href="git-update-index.html
">git-update-index(1)</a>. False by default.
3686 <dt class="hdlist1
">
3691 Determines what to do about the untracked cache feature of the
3692 index. It will be kept, if this variable is unset or set to
3693 <code>keep</code>. It will automatically be added if set to <code>true</code>. And
3694 it will automatically be removed, if set to <code>false</code>. Before
3695 setting it to <code>true</code>, you should check that mtime is working
3696 properly on your system.
3697 See <a href="git-update-index.html
">git-update-index(1)</a>. <code>keep</code> by default, unless
3698 <code>feature.manyFiles</code> is enabled which sets this setting to
3699 <code>true</code> by default.
3702 <dt class="hdlist1
">
3707 When missing or is set to <code>default</code>, many fields in the stat
3708 structure are checked to detect if a file has been modified
3709 since Git looked at it. When this configuration variable is
3710 set to <code>minimal</code>, sub-second part of mtime and ctime, the
3711 uid and gid of the owner of the file, the inode number (and
3712 the device number, if Git was compiled to use it), are
3713 excluded from the check among these fields, leaving only the
3714 whole-second part of mtime (and ctime, if <code>core.trustCtime</code>
3715 is set) and the filesize to be checked.
3717 <div class="paragraph
"><p>There are implementations of Git that do not leave usable values in
3718 some fields (e.g. JGit); by excluding these fields from the
3719 comparison, the <code>minimal</code> mode may help interoperability when the
3720 same repository is used by these other systems at the same time.</p></div>
3722 <dt class="hdlist1
">
3727 Commands that output paths (e.g. <em>ls-files</em>, <em>diff</em>), will
3728 quote "unusual
" characters in the pathname by enclosing the
3729 pathname in double-quotes and escaping those characters with
3730 backslashes in the same way C escapes control characters (e.g.
3731 <code>\t</code> for TAB, <code>\n</code> for LF, <code>\\</code> for backslash) or bytes with
3732 values larger than 0x80 (e.g. octal <code>\302\265</code> for "micro
" in
3733 UTF-8). If this variable is set to false, bytes higher than
3734 0x80 are not considered "unusual
" any more. Double-quotes,
3735 backslash and control characters are always escaped regardless
3736 of the setting of this variable. A simple space character is
3737 not considered "unusual
". Many commands can output pathnames
3738 completely verbatim using the <code>-z</code> option. The default value
3742 <dt class="hdlist1
">
3747 Sets the line ending type to use in the working directory for
3748 files that are marked as text (either by having the <code>text</code>
3749 attribute set, or by having <code>text=auto</code> and Git auto-detecting
3750 the contents as text).
3751 Alternatives are <em>lf</em>, <em>crlf</em> and <em>native</em>, which uses the platform’s
3752 native line ending. The default value is <code>native</code>. See
3753 <a href="gitattributes.html
">gitattributes(5)</a> for more information on end-of-line
3754 conversion. Note that this value is ignored if <code>core.autocrlf</code>
3755 is set to <code>true</code> or <code>input</code>.
3758 <dt class="hdlist1
">
3763 If true, makes Git check if converting <code>CRLF</code> is reversible when
3764 end-of-line conversion is active. Git will verify if a command
3765 modifies a file in the work tree either directly or indirectly.
3766 For example, committing a file followed by checking out the
3767 same file should yield the original file in the work tree. If
3768 this is not the case for the current setting of
3769 <code>core.autocrlf</code>, Git will reject the file. The variable can
3770 be set to "warn
", in which case Git will only warn about an
3771 irreversible conversion but continue the operation.
3773 <div class="paragraph
"><p>CRLF conversion bears a slight chance of corrupting data.
3774 When it is enabled, Git will convert CRLF to LF during commit and LF to
3775 CRLF during checkout. A file that contains a mixture of LF and
3776 CRLF before the commit cannot be recreated by Git. For text
3777 files this is the right thing to do: it corrects line endings
3778 such that we have only LF line endings in the repository.
3779 But for binary files that are accidentally classified as text the
3780 conversion can corrupt data.</p></div>
3781 <div class="paragraph
"><p>If you recognize such corruption early you can easily fix it by
3782 setting the conversion type explicitly in .gitattributes. Right
3783 after committing you still have the original file in your work
3784 tree and this file is not yet corrupted. You can explicitly tell
3785 Git that this file is binary and Git will handle the file
3786 appropriately.</p></div>
3787 <div class="paragraph
"><p>Unfortunately, the desired effect of cleaning up text files with
3788 mixed line endings and the undesired effect of corrupting binary
3789 files cannot be distinguished. In both cases CRLFs are removed
3790 in an irreversible way. For text files this is the right thing
3791 to do because CRLFs are line endings, while for binary files
3792 converting CRLFs corrupts data.</p></div>
3793 <div class="paragraph
"><p>Note, this safety check does not mean that a checkout will generate a
3794 file identical to the original file for a different setting of
3795 <code>core.eol</code> and <code>core.autocrlf</code>, but only for the current one. For
3796 example, a text file with <code>LF</code> would be accepted with <code>core.eol=lf</code>
3797 and could later be checked out with <code>core.eol=crlf</code>, in which case the
3798 resulting file would contain <code>CRLF</code>, although the original file
3799 contained <code>LF</code>. However, in both work trees the line endings would be
3800 consistent, that is either all <code>LF</code> or all <code>CRLF</code>, but never mixed. A
3801 file with mixed line endings would be reported by the <code>core.safecrlf</code>
3802 mechanism.</p></div>
3804 <dt class="hdlist1
">
3809 Setting this variable to "true
" is the same as setting
3810 the <code>text</code> attribute to "auto
" on all files and core.eol to "crlf
".
3811 Set to true if you want to have <code>CRLF</code> line endings in your
3812 working directory and the repository has LF line endings.
3813 This variable can be set to <em>input</em>,
3814 in which case no output conversion is performed.
3817 <dt class="hdlist1
">
3818 core.checkRoundtripEncoding
3822 A comma and/or whitespace separated list of encodings that Git
3823 performs UTF-8 round trip checks on if they are used in an
3824 <code>working-tree-encoding</code> attribute (see <a href="gitattributes.html
">gitattributes(5)</a>).
3825 The default value is <code>SHIFT-JIS</code>.
3828 <dt class="hdlist1
">
3833 If false, symbolic links are checked out as small plain files that
3834 contain the link text. <a href="git-update-index.html
">git-update-index(1)</a> and
3835 <a href="git-add.html
">git-add(1)</a> will not change the recorded type to regular
3836 file. Useful on filesystems like FAT that do not support
3839 <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>
3840 will probe and set core.symlinks false if appropriate when the repository
3841 is created.</p></div>
3843 <dt class="hdlist1
">
3848 A "proxy command
" to execute (as <em>command host port</em>) instead
3849 of establishing direct connection to the remote server when
3850 using the Git protocol for fetching. If the variable value is
3851 in the "COMMAND for DOMAIN
" format, the command is applied only
3852 on hostnames ending with the specified domain string. This variable
3853 may be set multiple times and is matched in the given order;
3854 the first match wins.
3856 <div class="paragraph
"><p>Can be overridden by the <code>GIT_PROXY_COMMAND</code> environment variable
3857 (which always applies universally, without the special "for
"
3858 handling).</p></div>
3859 <div class="paragraph
"><p>The special string <code>none</code> can be used as the proxy command to
3860 specify that no proxy be used for a given domain pattern.
3861 This is useful for excluding servers inside a firewall from
3862 proxy use, while defaulting to a common proxy for external domains.</p></div>
3864 <dt class="hdlist1
">
3869 If this variable is set, <code>git fetch</code> and <code>git push</code> will
3870 use the specified command instead of <code>ssh</code> when they need to
3871 connect to a remote system. The command is in the same form as
3872 the <code>GIT_SSH_COMMAND</code> environment variable and is overridden
3873 when the environment variable is set.
3876 <dt class="hdlist1
">
3881 If true, Git will avoid using lstat() calls to detect if files have
3882 changed by setting the "assume-unchanged
" bit for those tracked files
3883 which it has updated identically in both the index and working tree.
3885 <div class="paragraph
"><p>When files are modified outside of Git, the user will need to stage
3886 the modified files explicitly (e.g. see <em>Examples</em> section in
3887 <a href="git-update-index.html
">git-update-index(1)</a>).
3888 Git will not normally detect changes to those files.</p></div>
3889 <div class="paragraph
"><p>This is useful on systems where lstat() calls are very slow, such as
3890 CIFS/Microsoft Windows.</p></div>
3891 <div class="paragraph
"><p>False by default.</p></div>
3893 <dt class="hdlist1
">
3894 core.preferSymlinkRefs
3898 Instead of the default "symref
" format for HEAD
3899 and other symbolic reference files, use symbolic links.
3900 This is sometimes needed to work with old scripts that
3901 expect HEAD to be a symbolic link.
3904 <dt class="hdlist1
">
3905 core.alternateRefsCommand
3909 When advertising tips of available history from an alternate, use the shell to
3910 execute the specified command instead of <a href="git-for-each-ref.html
">git-for-each-ref(1)</a>. The
3911 first argument is the absolute path of the alternate. Output must contain one
3912 hex object id per line (i.e., the same as produced by <code>git for-each-ref
3913 --format='%(objectname)'</code>).
3915 <div class="paragraph
"><p>Note that you cannot generally put <code>git for-each-ref</code> directly into the config
3916 value, as it does not take a repository path as an argument (but you can wrap
3917 the command above in a shell script).</p></div>
3919 <dt class="hdlist1
">
3920 core.alternateRefsPrefixes
3924 When listing references from an alternate, list only references that begin
3925 with the given prefix. Prefixes match as if they were given as arguments to
3926 <a href="git-for-each-ref.html
">git-for-each-ref(1)</a>. To list multiple prefixes, separate them with
3927 whitespace. If <code>core.alternateRefsCommand</code> is set, setting
3928 <code>core.alternateRefsPrefixes</code> has no effect.
3931 <dt class="hdlist1
">
3936 If true this repository is assumed to be <em>bare</em> and has no
3937 working directory associated with it. If this is the case a
3938 number of commands that require a working directory will be
3939 disabled, such as <a href="git-add.html
">git-add(1)</a> or <a href="git-merge.html
">git-merge(1)</a>.
3941 <div class="paragraph
"><p>This setting is automatically guessed by <a href="git-clone.html
">git-clone(1)</a> or
3942 <a href="git-init.html
">git-init(1)</a> when the repository was created. By default a
3943 repository that ends in "/.git
" is assumed to be not bare (bare =
3944 false), while all other repositories are assumed to be bare (bare
3947 <dt class="hdlist1
">
3952 Set the path to the root of the working tree.
3953 If <code>GIT_COMMON_DIR</code> environment variable is set, core.worktree
3954 is ignored and not used for determining the root of working tree.
3955 This can be overridden by the <code>GIT_WORK_TREE</code> environment
3956 variable and the <code>--work-tree</code> command-line option.
3957 The value can be an absolute path or relative to the path to
3958 the .git directory, which is either specified by --git-dir
3959 or GIT_DIR, or automatically discovered.
3960 If --git-dir or GIT_DIR is specified but none of
3961 --work-tree, GIT_WORK_TREE and core.worktree is specified,
3962 the current working directory is regarded as the top level
3963 of your working tree.
3965 <div class="paragraph
"><p>Note that this variable is honored even when set in a configuration
3966 file in a ".git
" subdirectory of a directory and its value differs
3967 from the latter directory (e.g. "/path/to/.git/config
" has
3968 core.worktree set to "/different/path
"), which is most likely a
3969 misconfiguration. Running Git commands in the "/path/to
" directory will
3970 still use "/different/path
" as the root of the work tree and can cause
3971 confusion unless you know what you are doing (e.g. you are creating a
3972 read-only snapshot of the same index to a location different from the
3973 repository’s usual working tree).</p></div>
3975 <dt class="hdlist1
">
3976 core.logAllRefUpdates
3980 Enable the reflog. Updates to a ref <ref> is logged to the file
3981 "<code>$GIT_DIR/logs/
<ref
></code>", by appending the new and old
3982 SHA-1, the date/time and the reason of the update, but
3983 only when the file exists. If this configuration
3984 variable is set to <code>true</code>, missing "<code>$GIT_DIR/logs/
<ref
></code>"
3985 file is automatically created for branch heads (i.e. under
3986 <code>refs/heads/</code>), remote refs (i.e. under <code>refs/remotes/</code>),
3987 note refs (i.e. under <code>refs/notes/</code>), and the symbolic ref <code>HEAD</code>.
3988 If it is set to <code>always</code>, then a missing reflog is automatically
3989 created for any ref under <code>refs/</code>.
3991 <div class="paragraph
"><p>This information can be used to determine what commit
3992 was the tip of a branch "2 days ago
".</p></div>
3993 <div class="paragraph
"><p>This value is true by default in a repository that has
3994 a working directory associated with it, and false by
3995 default in a bare repository.</p></div>
3997 <dt class="hdlist1
">
3998 core.repositoryFormatVersion
4002 Internal variable identifying the repository format and layout
4006 <dt class="hdlist1
">
4007 core.sharedRepository
4011 When <em>group</em> (or <em>true</em>), the repository is made shareable between
4012 several users in a group (making sure all the files and objects are
4013 group-writable). When <em>all</em> (or <em>world</em> or <em>everybody</em>), the
4014 repository will be readable by all users, additionally to being
4015 group-shareable. When <em>umask</em> (or <em>false</em>), Git will use permissions
4016 reported by umask(2). When <em>0xxx</em>, where <em>0xxx</em> is an octal number,
4017 files in the repository will have this mode value. <em>0xxx</em> will override
4018 user’s umask value (whereas the other options will only override
4019 requested parts of the user’s umask value). Examples: <em>0660</em> will make
4020 the repo read/write-able for the owner and group, but inaccessible to
4021 others (equivalent to <em>group</em> unless umask is e.g. <em>0022</em>). <em>0640</em> is a
4022 repository that is group-readable but not group-writable.
4023 See <a href="git-init.html
">git-init(1)</a>. False by default.
4026 <dt class="hdlist1
">
4027 core.warnAmbiguousRefs
4031 If true, Git will warn you if the ref name you passed it is ambiguous
4032 and might match multiple refs in the repository. True by default.
4035 <dt class="hdlist1
">
4040 An integer -1..9, indicating a default compression level.
4041 -1 is the zlib default. 0 means no compression,
4042 and 1..9 are various speed/size tradeoffs, 9 being slowest.
4043 If set, this provides a default to other compression variables,
4044 such as <code>core.looseCompression</code> and <code>pack.compression</code>.
4047 <dt class="hdlist1
">
4048 core.looseCompression
4052 An integer -1..9, indicating the compression level for objects that
4053 are not in a pack file. -1 is the zlib default. 0 means no
4054 compression, and 1..9 are various speed/size tradeoffs, 9 being
4055 slowest. If not set, defaults to core.compression. If that is
4056 not set, defaults to 1 (best speed).
4059 <dt class="hdlist1
">
4060 core.packedGitWindowSize
4064 Number of bytes of a pack file to map into memory in a
4065 single mapping operation. Larger window sizes may allow
4066 your system to process a smaller number of large pack files
4067 more quickly. Smaller window sizes will negatively affect
4068 performance due to increased calls to the operating system’s
4069 memory manager, but may improve performance when accessing
4070 a large number of large pack files.
4072 <div class="paragraph
"><p>Default is 1 MiB if NO_MMAP was set at compile time, otherwise 32
4073 MiB on 32 bit platforms and 1 GiB on 64 bit platforms. This should
4074 be reasonable for all users/operating systems. You probably do
4075 not need to adjust this value.</p></div>
4076 <div class="paragraph
"><p>Common unit suffixes of <em>k</em>, <em>m</em>, or <em>g</em> are supported.</p></div>
4078 <dt class="hdlist1
">
4083 Maximum number of bytes to map simultaneously into memory
4084 from pack files. If Git needs to access more than this many
4085 bytes at once to complete an operation it will unmap existing
4086 regions to reclaim virtual address space within the process.
4088 <div class="paragraph
"><p>Default is 256 MiB on 32 bit platforms and 32 TiB (effectively
4089 unlimited) on 64 bit platforms.
4090 This should be reasonable for all users/operating systems, except on
4091 the largest projects. You probably do not need to adjust this value.</p></div>
4092 <div class="paragraph
"><p>Common unit suffixes of <em>k</em>, <em>m</em>, or <em>g</em> are supported.</p></div>
4094 <dt class="hdlist1
">
4095 core.deltaBaseCacheLimit
4099 Maximum number of bytes per thread to reserve for caching base objects
4100 that may be referenced by multiple deltified objects. By storing the
4101 entire decompressed base objects in a cache Git is able
4102 to avoid unpacking and decompressing frequently used base
4103 objects multiple times.
4105 <div class="paragraph
"><p>Default is 96 MiB on all platforms. This should be reasonable
4106 for all users/operating systems, except on the largest projects.
4107 You probably do not need to adjust this value.</p></div>
4108 <div class="paragraph
"><p>Common unit suffixes of <em>k</em>, <em>m</em>, or <em>g</em> are supported.</p></div>
4110 <dt class="hdlist1
">
4111 core.bigFileThreshold
4115 The size of files considered "big
", which as discussed below
4116 changes the behavior of numerous git commands, as well as how
4117 such files are stored within the repository. The default is
4118 512 MiB. Common unit suffixes of <em>k</em>, <em>m</em>, or <em>g</em> are
4121 <div class="paragraph
"><p>Files above the configured limit will be:</p></div>
4122 <div class="ulist
"><ul>
4125 Stored deflated in packfiles, without attempting delta compression.
4127 <div class="paragraph
"><p>The default limit is primarily set with this use-case in mind. With it,
4128 most projects will have their source code and other text files delta
4129 compressed, but not larger binary media files.</p></div>
4130 <div class="paragraph
"><p>Storing large files without delta compression avoids excessive memory
4131 usage, at the slight expense of increased disk usage.</p></div>
4135 Will be treated as if they were labeled "binary
" (see
4136 <a href="gitattributes.html
">gitattributes(5)</a>). e.g. <a href="git-log.html
">git-log(1)</a> and
4137 <a href="git-diff.html
">git-diff(1)</a> will not compute diffs for files above this limit.
4142 Will generally be streamed when written, which avoids excessive
4143 memory usage, at the cost of some fixed overhead. Commands that make
4144 use of this include <a href="git-archive.html
">git-archive(1)</a>,
4145 <a href="git-fast-import.html
">git-fast-import(1)</a>, <a href="git-index-pack.html
">git-index-pack(1)</a>,
4146 <a href="git-unpack-objects.html
">git-unpack-objects(1)</a> and <a href="git-fsck.html
">git-fsck(1)</a>.
4151 <dt class="hdlist1
">
4156 Specifies the pathname to the file that contains patterns to
4157 describe paths that are not meant to be tracked, in addition
4158 to <code>.gitignore</code> (per-directory) and <code>.git/info/exclude</code>.
4159 Defaults to <code>$XDG_CONFIG_HOME/git/ignore</code>.
4160 If <code>$XDG_CONFIG_HOME</code> is either not set or empty, <code>$HOME/.config/git/ignore</code>
4161 is used instead. See <a href="gitignore.html
">gitignore(5)</a>.
4164 <dt class="hdlist1
">
4169 Some commands (e.g. svn and http interfaces) that interactively
4170 ask for a password can be told to use an external program given
4171 via the value of this variable. Can be overridden by the <code>GIT_ASKPASS</code>
4172 environment variable. If not set, fall back to the value of the
4173 <code>SSH_ASKPASS</code> environment variable or, failing that, a simple password
4174 prompt. The external program shall be given a suitable prompt as
4175 command-line argument and write the password on its STDOUT.
4178 <dt class="hdlist1
">
4183 In addition to <code>.gitattributes</code> (per-directory) and
4184 <code>.git/info/attributes</code>, Git looks into this file for attributes
4185 (see <a href="gitattributes.html
">gitattributes(5)</a>). Path expansions are made the same
4186 way as for <code>core.excludesFile</code>. Its default value is
4187 <code>$XDG_CONFIG_HOME/git/attributes</code>. If <code>$XDG_CONFIG_HOME</code> is either not
4188 set or empty, <code>$HOME/.config/git/attributes</code> is used instead.
4191 <dt class="hdlist1
">
4196 By default Git will look for your hooks in the
4197 <code>$GIT_DIR/hooks</code> directory. Set this to different path,
4198 e.g. <code>/etc/git/hooks</code>, and Git will try to find your hooks in
4199 that directory, e.g. <code>/etc/git/hooks/pre-receive</code> instead of
4200 in <code>$GIT_DIR/hooks/pre-receive</code>.
4202 <div class="paragraph
"><p>The path can be either absolute or relative. A relative path is
4203 taken as relative to the directory where the hooks are run (see
4204 the "DESCRIPTION
" section of <a href="githooks.html
">githooks(5)</a>).</p></div>
4205 <div class="paragraph
"><p>This configuration variable is useful in cases where you’d like to
4206 centrally configure your Git hooks instead of configuring them on a
4207 per-repository basis, or as a more flexible and centralized
4208 alternative to having an <code>init.templateDir</code> where you’ve changed
4209 default hooks.</p></div>
4211 <dt class="hdlist1
">
4216 Commands such as <code>commit</code> and <code>tag</code> that let you edit
4217 messages by launching an editor use the value of this
4218 variable when it is set, and the environment variable
4219 <code>GIT_EDITOR</code> is not set. See <a href="git-var.html
">git-var(1)</a>.
4222 <dt class="hdlist1
">
4227 Commands such as <code>commit</code> and <code>tag</code> that let you edit
4228 messages consider a line that begins with this ASCII character
4229 commented, and removes them after the editor returns
4230 (default <em>#</em>).
4232 <div class="paragraph
"><p>If set to "auto
", <code>git-commit</code> would select a character that is not
4233 the beginning character of any line in existing commit messages.</p></div>
4235 <dt class="hdlist1
">
4236 core.filesRefLockTimeout
4240 The length of time, in milliseconds, to retry when trying to
4241 lock an individual reference. Value 0 means not to retry at
4242 all; -1 means to try indefinitely. Default is 100 (i.e.,
4246 <dt class="hdlist1
">
4247 core.packedRefsTimeout
4251 The length of time, in milliseconds, to retry when trying to
4252 lock the <code>packed-refs</code> file. Value 0 means not to retry at
4253 all; -1 means to try indefinitely. Default is 1000 (i.e.,
4254 retry for 1 second).
4257 <dt class="hdlist1
">
4262 Text viewer for use by Git commands (e.g., <em>less</em>). The value
4263 is meant to be interpreted by the shell. The order of preference
4264 is the <code>$GIT_PAGER</code> environment variable, then <code>core.pager</code>
4265 configuration, then <code>$PAGER</code>, and then the default chosen at
4266 compile time (usually <em>less</em>).
4268 <div class="paragraph
"><p>When the <code>LESS</code> environment variable is unset, Git sets it to <code>FRX</code>
4269 (if <code>LESS</code> environment variable is set, Git does not change it at
4270 all). If you want to selectively override Git’s default setting
4271 for <code>LESS</code>, you can set <code>core.pager</code> to e.g. <code>less -S</code>. This will
4272 be passed to the shell by Git, which will translate the final
4273 command to <code>LESS=FRX less -S</code>. The environment does not set the
4274 <code>S</code> option but the command line does, instructing less to truncate
4275 long lines. Similarly, setting <code>core.pager</code> to <code>less -+F</code> will
4276 deactivate the <code>F</code> option specified by the environment from the
4277 command-line, deactivating the "quit if one screen
" behavior of
4278 <code>less</code>. One can specifically activate some flags for particular
4279 commands: for example, setting <code>pager.blame</code> to <code>less -S</code> enables
4280 line truncation only for <code>git blame</code>.</p></div>
4281 <div class="paragraph
"><p>Likewise, when the <code>LV</code> environment variable is unset, Git sets it
4282 to <code>-c</code>. You can override this setting by exporting <code>LV</code> with
4283 another value or setting <code>core.pager</code> to <code>lv +c</code>.</p></div>
4285 <dt class="hdlist1
">
4290 A comma separated list of common whitespace problems to
4291 notice. <em>git diff</em> will use <code>color.diff.whitespace</code> to
4292 highlight them, and <em>git apply --whitespace=error</em> will
4293 consider them as errors. You can prefix <code>-</code> to disable
4294 any of them (e.g. <code>-trailing-space</code>):
4296 <div class="ulist
"><ul>
4299 <code>blank-at-eol</code> treats trailing whitespaces at the end of the line
4300 as an error (enabled by default).
4305 <code>space-before-tab</code> treats a space character that appears immediately
4306 before a tab character in the initial indent part of the line as an
4307 error (enabled by default).
4312 <code>indent-with-non-tab</code> treats a line that is indented with space
4313 characters instead of the equivalent tabs as an error (not enabled by
4319 <code>tab-in-indent</code> treats a tab character in the initial indent part of
4320 the line as an error (not enabled by default).
4325 <code>blank-at-eof</code> treats blank lines added at the end of file as an error
4326 (enabled by default).
4331 <code>trailing-space</code> is a short-hand to cover both <code>blank-at-eol</code> and
4332 <code>blank-at-eof</code>.
4337 <code>cr-at-eol</code> treats a carriage-return at the end of line as
4338 part of the line terminator, i.e. with it, <code>trailing-space</code>
4339 does not trigger if the character before such a carriage-return
4340 is not a whitespace (not enabled by default).
4345 <code>tabwidth=<n></code> tells how many character positions a tab occupies; this
4346 is relevant for <code>indent-with-non-tab</code> and when Git fixes <code>tab-in-indent</code>
4347 errors. The default tab width is 8. Allowed values are 1 to 63.
4352 <dt class="hdlist1
">
4357 A comma-separated list of components of the repository that
4358 should be hardened via the core.fsyncMethod when created or
4359 modified. You can disable hardening of any component by
4360 prefixing it with a <em>-</em>. Items that are not hardened may be
4361 lost in the event of an unclean system shutdown. Unless you
4362 have special requirements, it is recommended that you leave
4363 this option empty or pick one of <code>committed</code>, <code>added</code>,
4364 or <code>all</code>.
4366 <div class="paragraph
"><p>When this configuration is encountered, the set of components starts with
4367 the platform default value, disabled components are removed, and additional
4368 components are added. <code>none</code> resets the state so that the platform default
4369 is ignored.</p></div>
4370 <div class="paragraph
"><p>The empty string resets the fsync configuration to the platform
4371 default. The default on most platforms is equivalent to
4372 <code>core.fsync=committed,-loose-object</code>, which has good performance,
4373 but risks losing recent work in the event of an unclean system shutdown.</p></div>
4374 <div class="ulist
"><ul>
4377 <code>none</code> clears the set of fsynced components.
4382 <code>loose-object</code> hardens objects added to the repo in loose-object form.
4387 <code>pack</code> hardens objects added to the repo in packfile form.
4392 <code>pack-metadata</code> hardens packfile bitmaps and indexes.
4397 <code>commit-graph</code> hardens the commit-graph file.
4402 <code>index</code> hardens the index when it is modified.
4407 <code>objects</code> is an aggregate option that is equivalent to
4408 <code>loose-object,pack</code>.
4413 <code>reference</code> hardens references modified in the repo.
4418 <code>derived-metadata</code> is an aggregate option that is equivalent to
4419 <code>pack-metadata,commit-graph</code>.
4424 <code>committed</code> is an aggregate option that is currently equivalent to
4425 <code>objects</code>. This mode sacrifices some performance to ensure that work
4426 that is committed to the repository with <code>git commit</code> or similar commands
4432 <code>added</code> is an aggregate option that is currently equivalent to
4433 <code>committed,index</code>. This mode sacrifices additional performance to
4434 ensure that the results of commands like <code>git add</code> and similar operations
4440 <code>all</code> is an aggregate option that syncs all individual components above.
4445 <dt class="hdlist1
">
4450 A value indicating the strategy Git will use to harden repository data
4451 using fsync and related primitives.
4453 <div class="ulist
"><ul>
4456 <code>fsync</code> uses the fsync() system call or platform equivalents.
4461 <code>writeout-only</code> issues pagecache writeback requests, but depending on the
4462 filesystem and storage hardware, data added to the repository may not be
4463 durable in the event of a system crash. This is the default mode on macOS.
4468 <code>batch</code> enables a mode that uses writeout-only flushes to stage multiple
4469 updates in the disk writeback cache and then does a single full fsync of
4470 a dummy file to trigger the disk cache flush at the end of the operation.
4472 <div class="paragraph
"><p>Currently <code>batch</code> mode only applies to loose-object files. Other repository
4473 data is made durable as if <code>fsync</code> was specified. This mode is expected to
4474 be as safe as <code>fsync</code> on macOS for repos stored on HFS+ or APFS filesystems
4475 and on Windows for repos stored on NTFS or ReFS filesystems.</p></div>
4479 <dt class="hdlist1
">
4480 core.fsyncObjectFiles
4484 This boolean will enable <em>fsync()</em> when writing object files.
4485 This setting is deprecated. Use core.fsync instead.
4487 <div class="paragraph
"><p>This setting affects data added to the Git repository in loose-object
4488 form. When set to true, Git will issue an fsync or similar system call
4489 to flush caches so that loose-objects remain consistent in the face
4490 of a unclean system shutdown.</p></div>
4492 <dt class="hdlist1
">
4497 Enable parallel index preload for operations like <em>git diff</em>
4499 <div class="paragraph
"><p>This can speed up operations like <em>git diff</em> and <em>git status</em> especially
4500 on filesystems like NFS that have weak caching semantics and thus
4501 relatively high IO latencies. When enabled, Git will do the
4502 index comparison to the filesystem data in parallel, allowing
4503 overlapping IO’s. Defaults to true.</p></div>
4505 <dt class="hdlist1
">
4510 Windows-only: comma-separated list of environment variables'
4511 names that need to be unset before spawning any other process.
4512 Defaults to <code>PERL5LIB</code> to account for the fact that Git for
4513 Windows insists on using its own Perl interpreter.
4516 <dt class="hdlist1
">
4517 core.restrictinheritedhandles
4521 Windows-only: override whether spawned processes inherit only standard
4522 file handles (<code>stdin</code>, <code>stdout</code> and <code>stderr</code>) or all handles. Can be
4523 <code>auto</code>, <code>true</code> or <code>false</code>. Defaults to <code>auto</code>, which means <code>true</code> on
4524 Windows 7 and later, and <code>false</code> on older Windows versions.
4527 <dt class="hdlist1
">
4532 You can set this to <em>link</em>, in which case a hardlink followed by
4533 a delete of the source are used to make sure that object creation
4534 will not overwrite existing objects.
4536 <div class="paragraph
"><p>On some file system/operating system combinations, this is unreliable.
4537 Set this config setting to <em>rename</em> there; However, This will remove the
4538 check that makes sure that existing object files will not get overwritten.</p></div>
4540 <dt class="hdlist1
">
4545 When showing commit messages, also show notes which are stored in
4546 the given ref. The ref must be fully qualified. If the given
4547 ref does not exist, it is not an error but means that no
4548 notes should be printed.
4550 <div class="paragraph
"><p>This setting defaults to "refs/notes/commits
", and it can be overridden by
4551 the <code>GIT_NOTES_REF</code> environment variable. See <a href="git-notes.html
">git-notes(1)</a>.</p></div>
4553 <dt class="hdlist1
">
4558 If true, then git will read the commit-graph file (if it exists)
4559 to parse the graph structure of commits. Defaults to true. See
4560 <a href="git-commit-graph.html
">git-commit-graph(1)</a> for more information.
4563 <dt class="hdlist1
">
4568 If set to <code>false</code>, behave as if the <code>--no-replace-objects</code>
4569 option was given on the command line. See <a href="git.html
">git(1)</a> and
4570 <a href="git-replace.html
">git-replace(1)</a> for more information.
4573 <dt class="hdlist1
">
4578 Use the multi-pack-index file to track multiple packfiles using a
4579 single index. See <a href="git-multi-pack-index.html
">git-multi-pack-index(1)</a> for more
4580 information. Defaults to true.
4583 <dt class="hdlist1
">
4588 Enable "sparse checkout
" feature. See <a href="git-sparse-checkout.html
">git-sparse-checkout(1)</a>
4589 for more information.
4592 <dt class="hdlist1
">
4593 core.sparseCheckoutCone
4597 Enables the "cone mode
" of the sparse checkout feature. When the
4598 sparse-checkout file contains a limited set of patterns, this
4599 mode provides significant performance advantages. The "non-cone
4600 mode
" can be requested to allow specifying more flexible
4601 patterns by setting this variable to <em>false</em>. See
4602 <a href="git-sparse-checkout.html
">git-sparse-checkout(1)</a> for more information.
4605 <dt class="hdlist1
">
4610 Set the length object names are abbreviated to. If
4611 unspecified or set to "auto
", an appropriate value is
4612 computed based on the approximate number of packed objects
4613 in your repository, which hopefully is enough for
4614 abbreviated object names to stay unique for some time.
4615 If set to "no
", no abbreviation is made and the object names
4616 are shown in their full length.
4617 The minimum length is 4.
4620 <dt class="hdlist1
">
4625 The maximum depth Git is willing to recurse while traversing a
4626 tree (e.g., "a/b/cde/f
" has a depth of 4). This is a fail-safe
4627 to allow Git to abort cleanly, and should not generally need to
4628 be adjusted. The default is 4096.
4631 <dt class="hdlist1
">
4636 Specify an external helper to be called when a username or
4637 password credential is needed; the helper may consult external
4638 storage to avoid prompting the user for the credentials. This is
4639 normally the name of a credential helper with possible
4640 arguments, but may also be an absolute path with arguments or, if
4641 preceded by <code>!</code>, shell commands.
4643 <div class="paragraph
"><p>Note that multiple helpers may be defined. See <a href="gitcredentials.html
">gitcredentials(7)</a>
4644 for details and examples.</p></div>
4646 <dt class="hdlist1
">
4647 credential.useHttpPath
4651 When acquiring credentials, consider the "path
" component of an http
4652 or https URL to be important. Defaults to false. See
4653 <a href="gitcredentials.html
">gitcredentials(7)</a> for more information.
4656 <dt class="hdlist1
">
4661 If no username is set for a network authentication, use this username
4662 by default. See credential.<context>.* below, and
4663 <a href="gitcredentials.html
">gitcredentials(7)</a>.
4666 <dt class="hdlist1
">
4667 credential.<url>.*
4671 Any of the credential.* options above can be applied selectively to
4672 some credentials. For example, "credential.https://example.com.username
"
4673 would set the default username only for https connections to
4674 example.com. See <a href="gitcredentials.html
">gitcredentials(7)</a> for details on how URLs are
4678 <dt class="hdlist1
">
4679 credentialCache.ignoreSIGHUP
4683 Tell git-credential-cache—daemon to ignore SIGHUP, instead of quitting.
4686 <dt class="hdlist1
">
4687 credentialStore.lockTimeoutMS
4691 The length of time, in milliseconds, for git-credential-store to retry
4692 when trying to lock the credentials file. A value of 0 means not to retry at
4693 all; -1 means to try indefinitely. Default is 1000 (i.e., retry for
4697 <dt class="hdlist1
">
4698 diff.autoRefreshIndex
4702 When using <em>git diff</em> to compare with work tree
4703 files, do not consider stat-only changes as changed.
4704 Instead, silently run <code>git update-index --refresh</code> to
4705 update the cached stat information for paths whose
4706 contents in the work tree match the contents in the
4707 index. This option defaults to true. Note that this
4708 affects only <em>git diff</em> Porcelain, and not lower level
4709 <em>diff</em> commands such as <em>git diff-files</em>.
4712 <dt class="hdlist1
">
4717 A comma separated list of <code>--dirstat</code> parameters specifying the
4718 default behavior of the <code>--dirstat</code> option to <a href="git-diff.html
">git-diff(1)</a>
4719 and friends. The defaults can be overridden on the command line
4720 (using <code>--dirstat=<param1,param2,...></code>). The fallback defaults
4721 (when not changed by <code>diff.dirstat</code>) are <code>changes,noncumulative,3</code>.
4722 The following parameters are available:
4724 <div class="openblock
">
4725 <div class="content
">
4726 <div class="dlist
"><dl>
4727 <dt class="hdlist1
">
4728 <code>changes</code>
4732 Compute the dirstat numbers by counting the lines that have been
4733 removed from the source, or added to the destination. This ignores
4734 the amount of pure code movements within a file. In other words,
4735 rearranging lines in a file is not counted as much as other changes.
4736 This is the default behavior when no parameter is given.
4739 <dt class="hdlist1
">
4744 Compute the dirstat numbers by doing the regular line-based diff
4745 analysis, and summing the removed/added line counts. (For binary
4746 files, count 64-byte chunks instead, since binary files have no
4747 natural concept of lines). This is a more expensive <code>--dirstat</code>
4748 behavior than the <code>changes</code> behavior, but it does count rearranged
4749 lines within a file as much as other changes. The resulting output
4750 is consistent with what you get from the other <code>--*stat</code> options.
4753 <dt class="hdlist1
">
4758 Compute the dirstat numbers by counting the number of files changed.
4759 Each changed file counts equally in the dirstat analysis. This is
4760 the computationally cheapest <code>--dirstat</code> behavior, since it does
4761 not have to look at the file contents at all.
4764 <dt class="hdlist1
">
4765 <code>cumulative</code>
4769 Count changes in a child directory for the parent directory as well.
4770 Note that when using <code>cumulative</code>, the sum of the percentages
4771 reported may exceed 100%. The default (non-cumulative) behavior can
4772 be specified with the <code>noncumulative</code> parameter.
4775 <dt class="hdlist1
">
4780 An integer parameter specifies a cut-off percent (3% by default).
4781 Directories contributing less than this percentage of the changes
4782 are not shown in the output.
4787 <div class="paragraph
"><p>Example: The following will count changed files, while ignoring
4788 directories with less than 10% of the total amount of changed files,
4789 and accumulating child directory counts in the parent directories:
4790 <code>files,10,cumulative</code>.</p></div>
4792 <dt class="hdlist1
">
4797 Limit the width of the filename part in --stat output. If set, applies
4798 to all commands generating --stat output except format-patch.
4801 <dt class="hdlist1
">
4806 Limit the width of the graph part in --stat output. If set, applies
4807 to all commands generating --stat output except format-patch.
4810 <dt class="hdlist1
">
4815 Generate diffs with <n> lines of context instead of the default
4816 of 3. This value is overridden by the -U option.
4819 <dt class="hdlist1
">
4820 diff.interHunkContext
4824 Show the context between diff hunks, up to the specified number
4825 of lines, thereby fusing the hunks that are close to each other.
4826 This value serves as the default for the <code>--inter-hunk-context</code>
4827 command line option.
4830 <dt class="hdlist1
">
4835 If this config variable is set, diff generation is not
4836 performed using the internal diff machinery, but using the
4837 given command. Can be overridden with the ‘GIT_EXTERNAL_DIFF’
4838 environment variable. The command is called with parameters
4839 as described under "git Diffs
" in <a href="git.html
">git(1)</a>. Note: if
4840 you want to use an external diff program only on a subset of
4841 your files, you might want to use <a href="gitattributes.html
">gitattributes(5)</a> instead.
4844 <dt class="hdlist1
">
4845 diff.ignoreSubmodules
4849 Sets the default value of --ignore-submodules. Note that this
4850 affects only <em>git diff</em> Porcelain, and not lower level <em>diff</em>
4851 commands such as <em>git diff-files</em>. <em>git checkout</em>
4852 and <em>git switch</em> also honor
4853 this setting when reporting uncommitted changes. Setting it to
4854 <em>all</em> disables the submodule summary normally shown by <em>git commit</em>
4855 and <em>git status</em> when <code>status.submoduleSummary</code> is set unless it is
4856 overridden by using the --ignore-submodules command-line option.
4857 The <em>git submodule</em> commands are not affected by this setting.
4858 By default this is set to untracked so that any untracked
4859 submodules are ignored.
4862 <dt class="hdlist1
">
4867 If set, <em>git diff</em> uses a prefix pair that is different from the
4868 standard "a/
" and "b/
" depending on what is being compared. When
4869 this configuration is in effect, reverse diff output also swaps
4870 the order of the prefixes:
4872 <div class="dlist
"><dl>
4873 <dt class="hdlist1
">
4874 <code>git diff</code>
4878 compares the (i)ndex and the (w)ork tree;
4881 <dt class="hdlist1
">
4882 <code>git diff HEAD</code>
4886 compares a (c)ommit and the (w)ork tree;
4889 <dt class="hdlist1
">
4890 <code>git diff --cached</code>
4894 compares a (c)ommit and the (i)ndex;
4897 <dt class="hdlist1
">
4898 <code>git diff HEAD:file1 file2</code>
4902 compares an (o)bject and a (w)ork tree entity;
4905 <dt class="hdlist1
">
4906 <code>git diff --no-index a b</code>
4910 compares two non-git things (1) and (2).
4915 <dt class="hdlist1
">
4920 If set, <em>git diff</em> does not show any source or destination prefix.
4923 <dt class="hdlist1
">
4928 If set, <em>git diff</em> uses this source prefix. Defaults to "a/
".
4931 <dt class="hdlist1
">
4936 If set, <em>git diff</em> uses this destination prefix. Defaults to "b/
".
4939 <dt class="hdlist1
">
4944 If set to <em>true</em>, <em>git diff</em> does not show changes outside of the directory
4945 and show pathnames relative to the current directory.
4948 <dt class="hdlist1
">
4953 File indicating how to order files within a diff.
4954 See the <em>-O</em> option to <a href="git-diff.html
">git-diff(1)</a> for details.
4955 If <code>diff.orderFile</code> is a relative pathname, it is treated as
4956 relative to the top of the working tree.
4959 <dt class="hdlist1
">
4964 The number of files to consider in the exhaustive portion of
4965 copy/rename detection; equivalent to the <em>git diff</em> option
4966 <code>-l</code>. If not set, the default value is currently 1000. This
4967 setting has no effect if rename detection is turned off.
4970 <dt class="hdlist1
">
4975 Whether and how Git detects renames. If set to "false
",
4976 rename detection is disabled. If set to "true
", basic rename
4977 detection is enabled. If set to "copies
" or "copy
", Git will
4978 detect copies, as well. Defaults to true. Note that this
4979 affects only <em>git diff</em> Porcelain like <a href="git-diff.html
">git-diff(1)</a> and
4980 <a href="git-log.html
">git-log(1)</a>, and not lower level commands such as
4981 <a href="git-diff-files.html
">git-diff-files(1)</a>.
4984 <dt class="hdlist1
">
4985 diff.suppressBlankEmpty
4989 A boolean to inhibit the standard behavior of printing a space
4990 before each empty output line. Defaults to false.
4993 <dt class="hdlist1
">
4998 Specify the format in which differences in submodules are
4999 shown. The "short
" format just shows the names of the commits
5000 at the beginning and end of the range. The "log
" format lists
5001 the commits in the range like <a href="git-submodule.html
">git-submodule(1)</a> <code>summary</code>
5002 does. The "diff
" format shows an inline diff of the changed
5003 contents of the submodule. Defaults to "short
".
5006 <dt class="hdlist1
">
5011 A POSIX Extended Regular Expression used to determine what is a "word
"
5012 when performing word-by-word difference calculations. Character
5013 sequences that match the regular expression are "words
", all other
5014 characters are <strong>ignorable</strong> whitespace.
5017 <dt class="hdlist1
">
5018 diff.<driver>.command
5022 The custom diff driver command. See <a href="gitattributes.html
">gitattributes(5)</a>
5026 <dt class="hdlist1
">
5027 diff.<driver>.xfuncname
5031 The regular expression that the diff driver should use to
5032 recognize the hunk header. A built-in pattern may also be used.
5033 See <a href="gitattributes.html
">gitattributes(5)</a> for details.
5036 <dt class="hdlist1
">
5037 diff.<driver>.binary
5041 Set this option to true to make the diff driver treat files as
5042 binary. See <a href="gitattributes.html
">gitattributes(5)</a> for details.
5045 <dt class="hdlist1
">
5046 diff.<driver>.textconv
5050 The command that the diff driver should call to generate the
5051 text-converted version of a file. The result of the
5052 conversion is used to generate a human-readable diff. See
5053 <a href="gitattributes.html
">gitattributes(5)</a> for details.
5056 <dt class="hdlist1
">
5057 diff.<driver>.wordRegex
5061 The regular expression that the diff driver should use to
5062 split words in a line. See <a href="gitattributes.html
">gitattributes(5)</a> for
5066 <dt class="hdlist1
">
5067 diff.<driver>.cachetextconv
5071 Set this option to true to make the diff driver cache the text
5072 conversion outputs. See <a href="gitattributes.html
">gitattributes(5)</a> for details.
5074 <div class="dlist
"><dl>
5075 <dt class="hdlist1
">
5080 Use Araxis Merge (requires a graphical session)
5083 <dt class="hdlist1
">
5088 Use Beyond Compare (requires a graphical session)
5091 <dt class="hdlist1
">
5096 Use Beyond Compare (requires a graphical session)
5099 <dt class="hdlist1
">
5104 Use Beyond Compare (requires a graphical session)
5107 <dt class="hdlist1
">
5108 <code>codecompare</code>
5112 Use Code Compare (requires a graphical session)
5115 <dt class="hdlist1
">
5116 <code>deltawalker</code>
5120 Use DeltaWalker (requires a graphical session)
5123 <dt class="hdlist1
">
5124 <code>diffmerge</code>
5128 Use DiffMerge (requires a graphical session)
5131 <dt class="hdlist1
">
5132 <code>diffuse</code>
5136 Use Diffuse (requires a graphical session)
5139 <dt class="hdlist1
">
5140 <code>ecmerge</code>
5144 Use ECMerge (requires a graphical session)
5147 <dt class="hdlist1
">
5155 <dt class="hdlist1
">
5156 <code>examdiff</code>
5160 Use ExamDiff Pro (requires a graphical session)
5163 <dt class="hdlist1
">
5168 Use Guiffy’s Diff Tool (requires a graphical session)
5171 <dt class="hdlist1
">
5172 <code>gvimdiff</code>
5176 Use gVim (requires a graphical session)
5179 <dt class="hdlist1
">
5184 Use KDiff3 (requires a graphical session)
5187 <dt class="hdlist1
">
5188 <code>kompare</code>
5192 Use Kompare (requires a graphical session)
5195 <dt class="hdlist1
">
5200 Use Meld (requires a graphical session)
5203 <dt class="hdlist1
">
5204 <code>nvimdiff</code>
5211 <dt class="hdlist1
">
5212 <code>opendiff</code>
5216 Use FileMerge (requires a graphical session)
5219 <dt class="hdlist1
">
5220 <code>p4merge</code>
5224 Use HelixCore P4Merge (requires a graphical session)
5227 <dt class="hdlist1
">
5232 Use Sublime Merge (requires a graphical session)
5235 <dt class="hdlist1
">
5240 Use TkDiff (requires a graphical session)
5243 <dt class="hdlist1
">
5244 <code>vimdiff</code>
5251 <dt class="hdlist1
">
5252 <code>winmerge</code>
5256 Use WinMerge (requires a graphical session)
5259 <dt class="hdlist1
">
5264 Use xxdiff (requires a graphical session)
5269 <dt class="hdlist1
">
5270 diff.indentHeuristic
5274 Set this option to <code>false</code> to disable the default heuristics
5275 that shift diff hunk boundaries to make patches easier to read.
5278 <dt class="hdlist1
">
5283 Choose a diff algorithm. The variants are as follows:
5285 <div class="openblock
">
5286 <div class="content
">
5287 <div class="dlist
"><dl>
5288 <dt class="hdlist1
">
5289 <code>default</code>, <code>myers</code>
5293 The basic greedy diff algorithm. Currently, this is the default.
5296 <dt class="hdlist1
">
5297 <code>minimal</code>
5301 Spend extra time to make sure the smallest possible diff is
5305 <dt class="hdlist1
">
5306 <code>patience</code>
5310 Use "patience diff
" algorithm when generating patches.
5313 <dt class="hdlist1
">
5314 <code>histogram</code>
5318 This algorithm extends the patience algorithm to "support
5319 low-occurrence common elements
".
5325 <dt class="hdlist1
">
5326 diff.wsErrorHighlight
5330 Highlight whitespace errors in the <code>context</code>, <code>old</code> or <code>new</code>
5331 lines of the diff. Multiple values are separated by comma,
5332 <code>none</code> resets previous values, <code>default</code> reset the list to
5333 <code>new</code> and <code>all</code> is a shorthand for <code>old,new,context</code>. The
5334 whitespace errors are colored with <code>color.diff.whitespace</code>.
5335 The command line option <code>--ws-error-highlight=<kind></code>
5336 overrides this setting.
5339 <dt class="hdlist1
">
5344 If set to either a valid <code><mode></code> or a true value, moved lines
5345 in a diff are colored differently, for details of valid modes
5346 see <em>--color-moved</em> in <a href="git-diff.html
">git-diff(1)</a>. If simply set to
5347 true the default color mode will be used. When set to false,
5348 moved lines are not colored.
5351 <dt class="hdlist1
">
5356 When moved lines are colored using e.g. the <code>diff.colorMoved</code> setting,
5357 this option controls the <code><mode></code> how spaces are treated.
5358 For details of valid modes see <em>--color-moved-ws</em> in <a href="git-diff.html
">git-diff(1)</a>.
5361 <dt class="hdlist1
">
5366 Controls which diff tool is used by <a href="git-difftool.html
">git-difftool(1)</a>.
5367 This variable overrides the value configured in <code>merge.tool</code>.
5368 The list below shows the valid built-in values.
5369 Any other value is treated as a custom diff tool and requires
5370 that a corresponding difftool.<tool>.cmd variable is defined.
5373 <dt class="hdlist1
">
5378 Controls which diff tool is used by <a href="git-difftool.html
">git-difftool(1)</a> when
5379 the -g/--gui flag is specified. This variable overrides the value
5380 configured in <code>merge.guitool</code>. The list below shows the valid
5381 built-in values. Any other value is treated as a custom diff tool
5382 and requires that a corresponding difftool.<guitool>.cmd variable
5386 <dt class="hdlist1
">
5387 difftool.<tool>.cmd
5391 Specify the command to invoke the specified diff tool.
5392 The specified command is evaluated in shell with the following
5393 variables available: <em>LOCAL</em> is set to the name of the temporary
5394 file containing the contents of the diff pre-image and <em>REMOTE</em>
5395 is set to the name of the temporary file containing the contents
5396 of the diff post-image.
5398 <div class="paragraph
"><p>See the <code>--tool=<tool></code> option in <a href="git-difftool.html
">git-difftool(1)</a> for more details.</p></div>
5400 <dt class="hdlist1
">
5401 difftool.<tool>.path
5405 Override the path for the given tool. This is useful in case
5406 your tool is not in the PATH.
5409 <dt class="hdlist1
">
5410 difftool.trustExitCode
5414 Exit difftool if the invoked diff tool returns a non-zero exit status.
5416 <div class="paragraph
"><p>See the <code>--trust-exit-code</code> option in <a href="git-difftool.html
">git-difftool(1)</a> for more details.</p></div>
5418 <dt class="hdlist1
">
5423 Prompt before each invocation of the diff tool.
5426 <dt class="hdlist1
">
5431 Set <code>true</code> to use the <code>diff.guitool</code> by default (equivalent to specifying
5432 the <code>--gui</code> argument), or <code>auto</code> to select <code>diff.guitool</code> or <code>diff.tool</code>
5433 depending on the presence of a <code>DISPLAY</code> environment variable value. The
5434 default is <code>false</code>, where the <code>--gui</code> argument must be provided
5435 explicitly for the <code>diff.guitool</code> to be used.
5438 <dt class="hdlist1
">
5439 extensions.objectFormat
5443 Specify the hash algorithm to use. The acceptable values are <code>sha1</code> and
5444 <code>sha256</code>. If not specified, <code>sha1</code> is assumed. It is an error to specify
5445 this key unless <code>core.repositoryFormatVersion</code> is 1.
5447 <div class="paragraph
"><p>Note that this setting should only be set by <a href="git-init.html
">git-init(1)</a> or
5448 <a href="git-clone.html
">git-clone(1)</a>. Trying to change it after initialization will not
5449 work and will produce hard-to-diagnose issues.</p></div>
5451 <dt class="hdlist1
">
5452 extensions.compatObjectFormat
5456 Specify a compatitbility hash algorithm to use. The acceptable values
5457 are <code>sha1</code> and <code>sha256</code>. The value specified must be different from the
5458 value of extensions.objectFormat. This allows client level
5459 interoperability between git repositories whose objectFormat matches
5460 this compatObjectFormat. In particular when fully implemented the
5461 pushes and pulls from a repository in whose objectFormat matches
5462 compatObjectFormat. As well as being able to use oids encoded in
5463 compatObjectFormat in addition to oids encoded with objectFormat to
5464 locally specify objects.
5467 <dt class="hdlist1
">
5468 extensions.refStorage
5472 Specify the ref storage format to use. The acceptable values are:
5474 <div class="ulist
"><ul>
5477 <code>files</code> for loose files with packed-refs. This is the default.
5482 <code>reftable</code> for the reftable format. This format is experimental and its
5483 internals are subject to change.
5485 <div class="paragraph
"><p>It is an error to specify this key unless <code>core.repositoryFormatVersion</code> is 1.</p></div>
5486 <div class="paragraph
"><p>Note that this setting should only be set by <a href="git-init.html
">git-init(1)</a> or
5487 <a href="git-clone.html
">git-clone(1)</a>. Trying to change it after initialization will not
5488 work and will produce hard-to-diagnose issues.</p></div>
5492 <dt class="hdlist1
">
5493 extensions.worktreeConfig
5497 If enabled, then worktrees will load config settings from the
5498 <code>$GIT_DIR/config.worktree</code> file in addition to the
5499 <code>$GIT_COMMON_DIR/config</code> file. Note that <code>$GIT_COMMON_DIR</code> and
5500 <code>$GIT_DIR</code> are the same for the main working tree, while other
5501 working trees have <code>$GIT_DIR</code> equal to
5502 <code>$GIT_COMMON_DIR/worktrees/<id>/</code>. The settings in the
5503 <code>config.worktree</code> file will override settings from any other
5506 <div class="paragraph
"><p>When enabling <code>extensions.worktreeConfig</code>, you must be careful to move
5507 certain values from the common config file to the main working tree’s
5508 <code>config.worktree</code> file, if present:</p></div>
5509 <div class="ulist
"><ul>
5512 <code>core.worktree</code> must be moved from <code>$GIT_COMMON_DIR/config</code> to
5513 <code>$GIT_COMMON_DIR/config.worktree</code>.
5518 If <code>core.bare</code> is true, then it must be moved from <code>$GIT_COMMON_DIR/config</code>
5519 to <code>$GIT_COMMON_DIR/config.worktree</code>.
5521 <div class="paragraph
"><p>It may also be beneficial to adjust the locations of <code>core.sparseCheckout</code>
5522 and <code>core.sparseCheckoutCone</code> depending on your desire for customizable
5523 sparse-checkout settings for each worktree. By default, the <code>git
5524 sparse-checkout</code> builtin enables <code>extensions.worktreeConfig</code>, assigns
5525 these config values on a per-worktree basis, and uses the
5526 <code>$GIT_DIR/info/sparse-checkout</code> file to specify the sparsity for each
5527 worktree independently. See <a href="git-sparse-checkout.html
">git-sparse-checkout(1)</a> for more
5529 <div class="paragraph
"><p>For historical reasons, <code>extensions.worktreeConfig</code> is respected
5530 regardless of the <code>core.repositoryFormatVersion</code> setting.</p></div>
5534 <dt class="hdlist1
">
5535 fastimport.unpackLimit
5539 If the number of objects imported by <a href="git-fast-import.html
">git-fast-import(1)</a>
5540 is below this limit, then the objects will be unpacked into
5541 loose object files. However, if the number of imported objects
5542 equals or exceeds this limit, then the pack will be stored as a
5543 pack. Storing the pack from a fast-import can make the import
5544 operation complete faster, especially on slow filesystems. If
5545 not set, the value of <code>transfer.unpackLimit</code> is used instead.
5548 <dt class="hdlist1
">
5553 The config settings that start with <code>feature.</code> modify the defaults of
5554 a group of other config settings. These groups are created by the Git
5555 developer community as recommended defaults and are subject to change.
5556 In particular, new config options may be added with different defaults.
5559 <dt class="hdlist1
">
5560 feature.experimental
5564 Enable config options that are new to Git, and are being considered for
5565 future defaults. Config settings included here may be added or removed
5566 with each release, including minor version updates. These settings may
5567 have unintended interactions since they are so new. Please enable this
5568 setting if you are interested in providing feedback on experimental
5569 features. The new default values are:
5571 <div class="ulist
"><ul>
5574 <code>fetch.negotiationAlgorithm=skipping</code> may improve fetch negotiation times by
5575 skipping more commits at a time, reducing the number of round trips.
5580 <code>pack.useBitmapBoundaryTraversal=true</code> may improve bitmap traversal times by
5581 walking fewer objects.
5586 <code>pack.allowPackReuse=multi</code> may improve the time it takes to create a pack by
5587 reusing objects from multiple packs instead of just one.
5592 <dt class="hdlist1
">
5597 Enable config options that optimize for repos with many files in the
5598 working directory. With many files, commands such as <code>git status</code> and
5599 <code>git checkout</code> may be slow and these new defaults improve performance:
5601 <div class="ulist
"><ul>
5604 <code>index.skipHash=true</code> speeds up index writes by not computing a trailing
5605 checksum. Note that this will cause Git versions earlier than 2.13.0 to
5606 refuse to parse the index and Git versions earlier than 2.40.0 will report
5607 a corrupted index during <code>git fsck</code>.
5612 <code>index.version=4</code> enables path-prefix compression in the index.
5617 <code>core.untrackedCache=true</code> enables the untracked cache. This setting assumes
5618 that mtime is working on your machine.
5623 <dt class="hdlist1
">
5624 fetch.recurseSubmodules
5628 This option controls whether <code>git fetch</code> (and the underlying fetch
5629 in <code>git pull</code>) will recursively fetch into populated submodules.
5630 This option can be set either to a boolean value or to <em>on-demand</em>.
5631 Setting it to a boolean changes the behavior of fetch and pull to
5632 recurse unconditionally into submodules when set to true or to not
5633 recurse at all when set to false. When set to <em>on-demand</em>, fetch and
5634 pull will only recurse into a populated submodule when its
5635 superproject retrieves a commit that updates the submodule’s
5637 Defaults to <em>on-demand</em>, or to the value of <em>submodule.recurse</em> if set.
5640 <dt class="hdlist1
">
5645 If it is set to true, git-fetch-pack will check all fetched
5646 objects. See <code>transfer.fsckObjects</code> for what’s
5647 checked. Defaults to false. If not set, the value of
5648 <code>transfer.fsckObjects</code> is used instead.
5651 <dt class="hdlist1
">
5652 fetch.fsck.<msg-id>
5656 Acts like <code>fsck.<msg-id></code>, but is used by
5657 <a href="git-fetch-pack.html
">git-fetch-pack(1)</a> instead of <a href="git-fsck.html
">git-fsck(1)</a>. See
5658 the <code>fsck.<msg-id></code> documentation for details.
5661 <dt class="hdlist1
">
5666 Acts like <code>fsck.skipList</code>, but is used by
5667 <a href="git-fetch-pack.html
">git-fetch-pack(1)</a> instead of <a href="git-fsck.html
">git-fsck(1)</a>. See
5668 the <code>fsck.skipList</code> documentation for details.
5671 <dt class="hdlist1
">
5676 If the number of objects fetched over the Git native
5677 transfer is below this
5678 limit, then the objects will be unpacked into loose object
5679 files. However if the number of received objects equals or
5680 exceeds this limit then the received pack will be stored as
5681 a pack, after adding any missing delta bases. Storing the
5682 pack from a push can make the push operation complete faster,
5683 especially on slow filesystems. If not set, the value of
5684 <code>transfer.unpackLimit</code> is used instead.
5687 <dt class="hdlist1
">
5692 If true, fetch will automatically behave as if the <code>--prune</code>
5693 option was given on the command line. See also <code>remote.<name>.prune</code>
5694 and the PRUNING section of <a href="git-fetch.html
">git-fetch(1)</a>.
5697 <dt class="hdlist1
">
5702 If true, fetch will automatically behave as if the
5703 <code>refs/tags/*:refs/tags/*</code> refspec was provided when pruning,
5704 if not set already. This allows for setting both this option
5705 and <code>fetch.prune</code> to maintain a 1=1 mapping to upstream
5706 refs. See also <code>remote.<name>.pruneTags</code> and the PRUNING
5707 section of <a href="git-fetch.html
">git-fetch(1)</a>.
5710 <dt class="hdlist1
">
5715 If true, fetch will attempt to update all available remotes.
5716 This behavior can be overridden by passing <code>--no-all</code> or by
5717 explicitly specifying one or more remote(s) to fetch from.
5721 <dt class="hdlist1
">
5726 Control how ref update status is printed. Valid values are
5727 <code>full</code> and <code>compact</code>. Default value is <code>full</code>. See the
5728 OUTPUT section in <a href="git-fetch.html
">git-fetch(1)</a> for details.
5731 <dt class="hdlist1
">
5732 fetch.negotiationAlgorithm
5736 Control how information about the commits in the local repository
5737 is sent when negotiating the contents of the packfile to be sent by
5738 the server. Set to "consecutive
" to use an algorithm that walks
5739 over consecutive commits checking each one. Set to "skipping
" to
5740 use an algorithm that skips commits in an effort to converge
5741 faster, but may result in a larger-than-necessary packfile; or set
5742 to "noop
" to not send any information at all, which will almost
5743 certainly result in a larger-than-necessary packfile, but will skip
5744 the negotiation step. Set to "default
" to override settings made
5745 previously and use the default behaviour. The default is normally
5746 "consecutive
", but if <code>feature.experimental</code> is true, then the
5747 default is "skipping
". Unknown values will cause <em>git fetch</em> to
5750 <div class="paragraph
"><p>See also the <code>--negotiate-only</code> and <code>--negotiation-tip</code> options to
5751 <a href="git-fetch.html
">git-fetch(1)</a>.</p></div>
5753 <dt class="hdlist1
">
5754 fetch.showForcedUpdates
5758 Set to false to enable <code>--no-show-forced-updates</code> in
5759 <a href="git-fetch.html
">git-fetch(1)</a> and <a href="git-pull.html
">git-pull(1)</a> commands.
5763 <dt class="hdlist1
">
5768 Specifies the maximal number of fetch operations to be run in parallel
5769 at a time (submodules, or remotes when the <code>--multiple</code> option of
5770 <a href="git-fetch.html
">git-fetch(1)</a> is in effect).
5772 <div class="paragraph
"><p>A value of 0 will give some reasonable default. If unset, it defaults to 1.</p></div>
5773 <div class="paragraph
"><p>For submodules, this setting can be overridden using the <code>submodule.fetchJobs</code>
5774 config setting.</p></div>
5776 <dt class="hdlist1
">
5777 fetch.writeCommitGraph
5781 Set to true to write a commit-graph after every <code>git fetch</code> command
5782 that downloads a pack-file from a remote. Using the <code>--split</code> option,
5783 most executions will create a very small commit-graph file on top of
5784 the existing commit-graph file(s). Occasionally, these files will
5785 merge and the write may take longer. Having an updated commit-graph
5786 file helps performance of many Git commands, including <code>git merge-base</code>,
5787 <code>git push -f</code>, and <code>git log --graph</code>. Defaults to false.
5790 <dt class="hdlist1
">
5795 This value stores a URI for downloading Git object data from a bundle
5796 URI before performing an incremental fetch from the origin Git server.
5797 This is similar to how the <code>--bundle-uri</code> option behaves in
5798 <a href="git-clone.html
">git-clone(1)</a>. <code>git clone --bundle-uri</code> will set the
5799 <code>fetch.bundleURI</code> value if the supplied bundle URI contains a bundle
5800 list that is organized for incremental fetches.
5802 <div class="paragraph
"><p>If you modify this value and your repository has a <code>fetch.bundleCreationToken</code>
5803 value, then remove that <code>fetch.bundleCreationToken</code> value before fetching from
5804 the new bundle URI.</p></div>
5806 <dt class="hdlist1
">
5807 fetch.bundleCreationToken
5811 When using <code>fetch.bundleURI</code> to fetch incrementally from a bundle
5812 list that uses the "creationToken
" heuristic, this config value
5813 stores the maximum <code>creationToken</code> value of the downloaded bundles.
5814 This value is used to prevent downloading bundles in the future
5815 if the advertised <code>creationToken</code> is not strictly larger than this
5818 <div class="paragraph
"><p>The creation token values are chosen by the provider serving the specific
5819 bundle URI. If you modify the URI at <code>fetch.bundleURI</code>, then be sure to
5820 remove the value for the <code>fetch.bundleCreationToken</code> value before fetching.</p></div>
5822 <dt class="hdlist1
">
5823 filter.<driver>.clean
5827 The command which is used to convert the content of a worktree
5828 file to a blob upon checkin. See <a href="gitattributes.html
">gitattributes(5)</a> for
5832 <dt class="hdlist1
">
5833 filter.<driver>.smudge
5837 The command which is used to convert the content of a blob
5838 object to a worktree file upon checkout. See
5839 <a href="gitattributes.html
">gitattributes(5)</a> for details.
5842 <dt class="hdlist1
">
5847 Enable multipart/mixed attachments as the default for
5848 <em>format-patch</em>. The value can also be a double quoted string
5849 which will enable attachments as the default and set the
5850 value as the boundary. See the --attach option in
5851 <a href="git-format-patch.html
">git-format-patch(1)</a>. To countermand an earlier
5852 value, set it to an empty string.
5855 <dt class="hdlist1
">
5860 Provides the default value for the <code>--from</code> option to format-patch.
5861 Accepts a boolean value, or a name and email address. If false,
5862 format-patch defaults to <code>--no-from</code>, using commit authors directly in
5863 the "From:
" field of patch mails. If true, format-patch defaults to
5864 <code>--from</code>, using your committer identity in the "From:
" field of patch
5865 mails and including a "From:
" field in the body of the patch mail if
5866 different. If set to a non-boolean value, format-patch uses that
5867 value instead of your committer identity. Defaults to false.
5870 <dt class="hdlist1
">
5871 format.forceInBodyFrom
5875 Provides the default value for the <code>--[no-]force-in-body-from</code>
5876 option to format-patch. Defaults to false.
5879 <dt class="hdlist1
">
5884 A boolean which can enable or disable sequence numbers in patch
5885 subjects. It defaults to "auto
" which enables it only if there
5886 is more than one patch. It can be enabled or disabled for all
5887 messages by setting it to "true
" or "false
". See --numbered
5888 option in <a href="git-format-patch.html
">git-format-patch(1)</a>.
5891 <dt class="hdlist1
">
5896 Additional email headers to include in a patch to be submitted
5897 by mail. See <a href="git-format-patch.html
">git-format-patch(1)</a>.
5900 <dt class="hdlist1
">
5903 <dt class="hdlist1
">
5908 Additional recipients to include in a patch to be submitted
5909 by mail. See the --to and --cc options in
5910 <a href="git-format-patch.html
">git-format-patch(1)</a>.
5913 <dt class="hdlist1
">
5914 format.subjectPrefix
5918 The default for format-patch is to output files with the <em>[PATCH]</em>
5919 subject prefix. Use this variable to change that prefix.
5922 <dt class="hdlist1
">
5923 format.coverFromDescription
5927 The default mode for format-patch to determine which parts of
5928 the cover letter will be populated using the branch’s
5929 description. See the <code>--cover-from-description</code> option in
5930 <a href="git-format-patch.html
">git-format-patch(1)</a>.
5933 <dt class="hdlist1
">
5938 The default for format-patch is to output a signature containing
5939 the Git version number. Use this variable to change that default.
5940 Set this variable to the empty string ("") to suppress
5941 signature generation.
5944 <dt class="hdlist1
">
5945 format.signatureFile
5949 Works just like format.signature except the contents of the
5950 file specified by this variable will be used as the signature.
5953 <dt class="hdlist1
">
5958 The default for format-patch is to output files with the suffix
5959 <code>.patch</code>. Use this variable to change that suffix (make sure to
5960 include the dot if you want it).
5963 <dt class="hdlist1
">
5964 format.encodeEmailHeaders
5968 Encode email headers that have non-ASCII characters with
5969 "Q-encoding
" (described in RFC 2047) for email transmission.
5973 <dt class="hdlist1
">
5978 The default pretty format for log/show/whatchanged command.
5979 See <a href="git-log.html
">git-log(1)</a>, <a href="git-show.html
">git-show(1)</a>,
5980 <a href="git-whatchanged.html
">git-whatchanged(1)</a>.
5983 <dt class="hdlist1
">
5988 The default threading style for <em>git format-patch</em>. Can be
5989 a boolean value, or <code>shallow</code> or <code>deep</code>. <code>shallow</code> threading
5990 makes every mail a reply to the head of the series,
5991 where the head is chosen from the cover letter, the
5992 <code>--in-reply-to</code>, and the first patch mail, in this order.
5993 <code>deep</code> threading makes every mail a reply to the previous one.
5994 A true boolean value is the same as <code>shallow</code>, and a false
5995 value disables threading.
5998 <dt class="hdlist1
">
6003 A boolean value which lets you enable the <code>-s/--signoff</code> option of
6004 format-patch by default. <strong>Note:</strong> Adding the <code>Signed-off-by</code> trailer to a
6005 patch should be a conscious act and means that you certify you have
6006 the rights to submit this work under the same open source license.
6007 Please see the <em>SubmittingPatches</em> document for further discussion.
6010 <dt class="hdlist1
">
6015 A boolean that controls whether to generate a cover-letter when
6016 format-patch is invoked, but in addition can be set to "auto
", to
6017 generate a cover-letter only when there’s more than one patch.
6021 <dt class="hdlist1
">
6022 format.outputDirectory
6026 Set a custom directory to store the resulting files instead of the
6027 current working directory. All directory components will be created.
6030 <dt class="hdlist1
">
6031 format.filenameMaxLength
6035 The maximum length of the output filenames generated by the
6036 <code>format-patch</code> command; defaults to 64. Can be overridden
6037 by the <code>--filename-max-length=<n></code> command line option.
6040 <dt class="hdlist1
">
6045 A boolean value which lets you enable the <code>--base=auto</code> option of
6046 format-patch by default. Can also be set to "whenAble
" to allow
6047 enabling <code>--base=auto</code> if a suitable base is available, but to skip
6048 adding base info otherwise without the format dying.
6051 <dt class="hdlist1
">
6056 Provides the default value for the <code>--notes</code> option to
6057 format-patch. Accepts a boolean value, or a ref which specifies
6058 where to get notes. If false, format-patch defaults to
6059 <code>--no-notes</code>. If true, format-patch defaults to <code>--notes</code>. If
6060 set to a non-boolean value, format-patch defaults to
6061 <code>--notes=<ref></code>, where <code>ref</code> is the non-boolean value. Defaults
6064 <div class="paragraph
"><p>If one wishes to use the ref <code>refs/notes/true</code>, please use that literal
6066 <div class="paragraph
"><p>This configuration can be specified multiple times in order to allow
6067 multiple notes refs to be included. In that case, it will behave
6068 similarly to multiple <code>--[no-]notes[=]</code> options passed in. That is, a
6069 value of <code>true</code> will show the default notes, a value of <code><ref></code> will
6070 also show notes from that notes ref and a value of <code>false</code> will negate
6071 previous configurations and not show notes.</p></div>
6072 <div class="paragraph
"><p>For example,</p></div>
6073 <div class="listingblock
">
6074 <div class="content
">
6079 notes = bar</code></pre>
6081 <div class="paragraph
"><p>will only show notes from <code>refs/notes/bar</code>.</p></div>
6083 <dt class="hdlist1
">
6088 A boolean value which enables the robust "mboxrd
" format when
6089 <code>--stdout</code> is in use to escape "^
>+From
" lines.
6092 <dt class="hdlist1
">
6097 If set, do not show any source or destination prefix in patches.
6098 This is equivalent to the <code>diff.noprefix</code> option used by <code>git
6099 diff</code> (but which is not respected by <code>format-patch</code>). Note that
6100 by setting this, the receiver of any patches you generate will
6101 have to apply them using the <code>-p0</code> option.
6104 <dt class="hdlist1
">
6109 During fsck git may find issues with legacy data which
6110 wouldn’t be generated by current versions of git, and which
6111 wouldn’t be sent over the wire if <code>transfer.fsckObjects</code> was
6112 set. This feature is intended to support working with legacy
6113 repositories containing such data.
6115 <div class="paragraph
"><p>Setting <code>fsck.<msg-id></code> will be picked up by <a href="git-fsck.html
">git-fsck(1)</a>, but
6116 to accept pushes of such data set <code>receive.fsck.<msg-id></code> instead, or
6117 to clone or fetch it set <code>fetch.fsck.<msg-id></code>.</p></div>
6118 <div class="paragraph
"><p>The rest of the documentation discusses <code>fsck.*</code> for brevity, but the
6119 same applies for the corresponding <code>receive.fsck.*</code> and
6120 <code>fetch.fsck.*</code>. variables.</p></div>
6121 <div class="paragraph
"><p>Unlike variables like <code>color.ui</code> and <code>core.editor</code>, the
6122 <code>receive.fsck.<msg-id></code> and <code>fetch.fsck.<msg-id></code> variables will not
6123 fall back on the <code>fsck.<msg-id></code> configuration if they aren’t set. To
6124 uniformly configure the same fsck settings in different circumstances,
6125 all three of them must be set to the same values.</p></div>
6126 <div class="paragraph
"><p>When <code>fsck.<msg-id></code> is set, errors can be switched to warnings and
6127 vice versa by configuring the <code>fsck.<msg-id></code> setting where the
6128 <code><msg-id></code> is the fsck message ID and the value is one of <code>error</code>,
6129 <code>warn</code> or <code>ignore</code>. For convenience, fsck prefixes the error/warning
6130 with the message ID, e.g. "missingEmail: invalid author/committer
6131 line - missing email
" means that setting <code>fsck.missingEmail = ignore</code>
6132 will hide that issue.</p></div>
6133 <div class="paragraph
"><p>In general, it is better to enumerate existing objects with problems
6134 with <code>fsck.skipList</code>, instead of listing the kind of breakages these
6135 problematic objects share to be ignored, as doing the latter will
6136 allow new instances of the same breakages go unnoticed.</p></div>
6137 <div class="paragraph
"><p>Setting an unknown <code>fsck.<msg-id></code> value will cause fsck to die, but
6138 doing the same for <code>receive.fsck.<msg-id></code> and <code>fetch.fsck.<msg-id></code>
6139 will only cause git to warn.</p></div>
6140 <div class="paragraph
"><p>See the <code>Fsck Messages</code> section of <a href="git-fsck.html
">git-fsck(1)</a> for supported
6141 values of <code><msg-id></code>.</p></div>
6143 <dt class="hdlist1
">
6148 The path to a list of object names (i.e. one unabbreviated SHA-1 per
6149 line) that are known to be broken in a non-fatal way and should
6150 be ignored. On versions of Git 2.20 and later, comments (<em>#</em>), empty
6151 lines, and any leading and trailing whitespace are ignored. Everything
6152 but a SHA-1 per line will error out on older versions.
6154 <div class="paragraph
"><p>This feature is useful when an established project should be accepted
6155 despite early commits containing errors that can be safely ignored,
6156 such as invalid committer email addresses. Note: corrupt objects
6157 cannot be skipped with this setting.</p></div>
6158 <div class="paragraph
"><p>Like <code>fsck.<msg-id></code> this variable has corresponding
6159 <code>receive.fsck.skipList</code> and <code>fetch.fsck.skipList</code> variants.</p></div>
6160 <div class="paragraph
"><p>Unlike variables like <code>color.ui</code> and <code>core.editor</code> the
6161 <code>receive.fsck.skipList</code> and <code>fetch.fsck.skipList</code> variables will not
6162 fall back on the <code>fsck.skipList</code> configuration if they aren’t set. To
6163 uniformly configure the same fsck settings in different circumstances,
6164 all three of them must be set to the same values.</p></div>
6165 <div class="paragraph
"><p>Older versions of Git (before 2.20) documented that the object names
6166 list should be sorted. This was never a requirement; the object names
6167 could appear in any order, but when reading the list we tracked whether
6168 the list was sorted for the purposes of an internal binary search
6169 implementation, which could save itself some work with an already sorted
6170 list. Unless you had a humongous list there was no reason to go out of
6171 your way to pre-sort the list. After Git version 2.20 a hash implementation
6172 is used instead, so there’s now no reason to pre-sort the list.</p></div>
6174 <dt class="hdlist1
">
6175 fsmonitor.allowRemote
6179 By default, the fsmonitor daemon refuses to work with network-mounted
6180 repositories. Setting <code>fsmonitor.allowRemote</code> to <code>true</code> overrides this
6181 behavior. Only respected when <code>core.fsmonitor</code> is set to <code>true</code>.
6184 <dt class="hdlist1
">
6189 This Mac OS-specific option, if set, specifies the directory in
6190 which to create the Unix domain socket used for communication
6191 between the fsmonitor daemon and various Git commands. The directory must
6192 reside on a native Mac OS filesystem. Only respected when <code>core.fsmonitor</code>
6193 is set to <code>true</code>.
6196 <dt class="hdlist1
">
6201 The depth parameter used in the delta compression
6202 algorithm used by <em>git gc --aggressive</em>. This defaults
6203 to 50, which is the default for the <code>--depth</code> option when
6204 <code>--aggressive</code> isn’t in use.
6206 <div class="paragraph
"><p>See the documentation for the <code>--depth</code> option in
6207 <a href="git-repack.html
">git-repack(1)</a> for more details.</p></div>
6209 <dt class="hdlist1
">
6214 The window size parameter used in the delta compression
6215 algorithm used by <em>git gc --aggressive</em>. This defaults
6216 to 250, which is a much more aggressive window size than
6217 the default <code>--window</code> of 10.
6219 <div class="paragraph
"><p>See the documentation for the <code>--window</code> option in
6220 <a href="git-repack.html
">git-repack(1)</a> for more details.</p></div>
6222 <dt class="hdlist1
">
6227 When there are approximately more than this many loose
6228 objects in the repository, <code>git gc --auto</code> will pack them.
6229 Some Porcelain commands use this command to perform a
6230 light-weight garbage collection from time to time. The
6231 default value is 6700.
6233 <div class="paragraph
"><p>Setting this to 0 disables not only automatic packing based on the
6234 number of loose objects, but also any other heuristic <code>git gc --auto</code> will
6235 otherwise use to determine if there’s work to do, such as
6236 <code>gc.autoPackLimit</code>.</p></div>
6238 <dt class="hdlist1
">
6243 When there are more than this many packs that are not
6244 marked with <code>*.keep</code> file in the repository, <code>git gc
6245 --auto</code> consolidates them into one larger pack. The
6246 default value is 50. Setting this to 0 disables it.
6247 Setting <code>gc.auto</code> to 0 will also disable this.
6249 <div class="paragraph
"><p>See the <code>gc.bigPackThreshold</code> configuration variable below. When in
6250 use, it’ll affect how the auto pack limit works.</p></div>
6252 <dt class="hdlist1
">
6257 Make <code>git gc --auto</code> return immediately and run in the background
6258 if the system supports it. Default is true.
6261 <dt class="hdlist1
">
6266 If non-zero, all non-cruft packs larger than this limit are kept
6267 when <code>git gc</code> is run. This is very similar to
6268 <code>--keep-largest-pack</code> except that all non-cruft packs that meet
6269 the threshold are kept, not just the largest pack. Defaults to
6270 zero. Common unit suffixes of <em>k</em>, <em>m</em>, or <em>g</em> are supported.
6272 <div class="paragraph
"><p>Note that if the number of kept packs is more than gc.autoPackLimit,
6273 this configuration variable is ignored, all packs except the base pack
6274 will be repacked. After this the number of packs should go below
6275 gc.autoPackLimit and gc.bigPackThreshold should be respected again.</p></div>
6276 <div class="paragraph
"><p>If the amount of memory estimated for <code>git repack</code> to run smoothly is
6277 not available and <code>gc.bigPackThreshold</code> is not set, the largest pack
6278 will also be excluded (this is the equivalent of running <code>git gc</code> with
6279 <code>--keep-largest-pack</code>).</p></div>
6281 <dt class="hdlist1
">
6286 If true, then gc will rewrite the commit-graph file when
6287 <a href="git-gc.html
">git-gc(1)</a> is run. When using <code>git gc --auto</code>
6288 the commit-graph will be updated if housekeeping is
6289 required. Default is true. See <a href="git-commit-graph.html
">git-commit-graph(1)</a>
6293 <dt class="hdlist1
">
6298 If the file gc.log exists, then <code>git gc --auto</code> will print
6299 its content and exit with status zero instead of running
6300 unless that file is more than <em>gc.logExpiry</em> old. Default is
6301 "1.day
". See <code>gc.pruneExpire</code> for more ways to specify its
6305 <dt class="hdlist1
">
6310 Running <code>git pack-refs</code> in a repository renders it
6311 unclonable by Git versions prior to 1.5.1.2 over dumb
6312 transports such as HTTP. This variable determines whether
6313 <em>git gc</em> runs <code>git pack-refs</code>. This can be set to <code>notbare</code>
6314 to enable it within all non-bare repos or it can be set to a
6315 boolean value. The default is <code>true</code>.
6318 <dt class="hdlist1
">
6323 Store unreachable objects in a cruft pack (see
6324 <a href="git-repack.html
">git-repack(1)</a>) instead of as loose objects. The default
6325 is <code>true</code>.
6328 <dt class="hdlist1
">
6333 Limit the size of new cruft packs when repacking. When
6334 specified in addition to <code>--max-cruft-size</code>, the command line
6335 option takes priority. See the <code>--max-cruft-size</code> option of
6336 <a href="git-repack.html
">git-repack(1)</a>.
6339 <dt class="hdlist1
">
6344 When <em>git gc</em> is run, it will call <em>prune --expire 2.weeks.ago</em>
6345 (and <em>repack --cruft --cruft-expiration 2.weeks.ago</em> if using
6346 cruft packs via <code>gc.cruftPacks</code> or <code>--cruft</code>). Override the
6347 grace period with this config variable. The value "now
" may be
6348 used to disable this grace period and always prune unreachable
6349 objects immediately, or "never
" may be used to suppress pruning.
6350 This feature helps prevent corruption when <em>git gc</em> runs
6351 concurrently with another process writing to the repository; see
6352 the "NOTES
" section of <a href="git-gc.html
">git-gc(1)</a>.
6355 <dt class="hdlist1
">
6356 gc.worktreePruneExpire
6360 When <em>git gc</em> is run, it calls
6361 <em>git worktree prune --expire 3.months.ago</em>.
6362 This config variable can be used to set a different grace
6363 period. The value "now
" may be used to disable the grace
6364 period and prune <code>$GIT_DIR/worktrees</code> immediately, or "never
"
6365 may be used to suppress pruning.
6368 <dt class="hdlist1
">
6371 <dt class="hdlist1
">
6372 gc.<pattern>.reflogExpire
6376 <em>git reflog expire</em> removes reflog entries older than
6377 this time; defaults to 90 days. The value "now
" expires all
6378 entries immediately, and "never
" suppresses expiration
6379 altogether. With "<pattern
>" (e.g.
6380 "refs/stash
") in the middle the setting applies only to
6381 the refs that match the <pattern>.
6384 <dt class="hdlist1
">
6385 gc.reflogExpireUnreachable
6387 <dt class="hdlist1
">
6388 gc.<pattern>.reflogExpireUnreachable
6392 <em>git reflog expire</em> removes reflog entries older than
6393 this time and are not reachable from the current tip;
6394 defaults to 30 days. The value "now
" expires all entries
6395 immediately, and "never
" suppresses expiration altogether.
6396 With "<pattern
>" (e.g. "refs/stash
")
6397 in the middle, the setting applies only to the refs that
6398 match the <pattern>.
6400 <div class="paragraph
"><p>These types of entries are generally created as a result of using <code>git
6401 commit --amend</code> or <code>git rebase</code> and are the commits prior to the amend
6402 or rebase occurring. Since these changes are not part of the current
6403 project most users will want to expire them sooner, which is why the
6404 default is more aggressive than <code>gc.reflogExpire</code>.</p></div>
6406 <dt class="hdlist1
">
6407 gc.recentObjectsHook
6411 When considering whether or not to remove an object (either when
6412 generating a cruft pack or storing unreachable objects as
6413 loose), use the shell to execute the specified command(s).
6414 Interpret their output as object IDs which Git will consider as
6415 "recent
", regardless of their age. By treating their mtimes as
6416 "now
", any objects (and their descendants) mentioned in the
6417 output will be kept regardless of their true age.
6419 <div class="paragraph
"><p>Output must contain exactly one hex object ID per line, and nothing
6420 else. Objects which cannot be found in the repository are ignored.
6421 Multiple hooks are supported, but all must exit successfully, else the
6422 operation (either generating a cruft pack or unpacking unreachable
6423 objects) will be halted.</p></div>
6425 <dt class="hdlist1
">
6430 When repacking, use the specified filter to move certain
6431 objects into a separate packfile. See the
6432 <code>--filter=<filter-spec></code> option of <a href="git-repack.html
">git-repack(1)</a>.
6435 <dt class="hdlist1
">
6440 When repacking and using a filter, see <code>gc.repackFilter</code>, the
6441 specified location will be used to create the packfile
6442 containing the filtered out objects. <strong>WARNING:</strong> The
6443 specified location should be accessible, using for example the
6444 Git alternates mechanism, otherwise the repo could be
6445 considered corrupt by Git as it migh not be able to access the
6446 objects in that packfile. See the <code>--filter-to=<dir></code> option
6447 of <a href="git-repack.html
">git-repack(1)</a> and the <code>objects/info/alternates</code>
6448 section of <a href="gitrepository-layout.html
">gitrepository-layout(5)</a>.
6451 <dt class="hdlist1
">
6456 Records of conflicted merge you resolved earlier are
6457 kept for this many days when <em>git rerere gc</em> is run.
6458 You can also use more human-readable "1.month.ago
", etc.
6459 The default is 60 days. See <a href="git-rerere.html
">git-rerere(1)</a>.
6462 <dt class="hdlist1
">
6467 Records of conflicted merge you have not resolved are
6468 kept for this many days when <em>git rerere gc</em> is run.
6469 You can also use more human-readable "1.month.ago
", etc.
6470 The default is 15 days. See <a href="git-rerere.html
">git-rerere(1)</a>.
6473 <dt class="hdlist1
">
6474 gitcvs.commitMsgAnnotation
6478 Append this string to each commit message. Set to empty string
6479 to disable this feature. Defaults to "via git-CVS emulator
".
6482 <dt class="hdlist1
">
6487 Whether the CVS server interface is enabled for this repository.
6488 See <a href="git-cvsserver.html
">git-cvsserver(1)</a>.
6491 <dt class="hdlist1
">
6496 Path to a log file where the CVS server interface well… logs
6497 various stuff. See <a href="git-cvsserver.html
">git-cvsserver(1)</a>.
6500 <dt class="hdlist1
">
6505 If true, the server will look up the end-of-line conversion
6506 attributes for files to determine the <code>-k</code> modes to use. If
6507 the attributes force Git to treat a file as text,
6508 the <code>-k</code> mode will be left blank so CVS clients will
6509 treat it as text. If they suppress text conversion, the file
6510 will be set with <em>-kb</em> mode, which suppresses any newline munging
6511 the client might otherwise do. If the attributes do not allow
6512 the file type to be determined, then <code>gitcvs.allBinary</code> is
6513 used. See <a href="gitattributes.html
">gitattributes(5)</a>.
6516 <dt class="hdlist1
">
6521 This is used if <code>gitcvs.usecrlfattr</code> does not resolve
6522 the correct <em>-kb</em> mode to use. If true, all
6523 unresolved files are sent to the client in
6524 mode <em>-kb</em>. This causes the client to treat them
6525 as binary files, which suppresses any newline munging it
6526 otherwise might do. Alternatively, if it is set to "guess
",
6527 then the contents of the file are examined to decide if
6528 it is binary, similar to <code>core.autocrlf</code>.
6531 <dt class="hdlist1
">
6536 Database used by git-cvsserver to cache revision information
6537 derived from the Git repository. The exact meaning depends on the
6538 used database driver, for SQLite (which is the default driver) this
6539 is a filename. Supports variable substitution (see
6540 <a href="git-cvsserver.html
">git-cvsserver(1)</a> for details). May not contain semicolons (<code>;</code>).
6541 Default: <em>%Ggitcvs.%m.sqlite</em>
6544 <dt class="hdlist1
">
6549 Used Perl DBI driver. You can specify any available driver
6550 for this here, but it might not work. git-cvsserver is tested
6551 with <em>DBD::SQLite</em>, reported to work with <em>DBD::Pg</em>, and
6552 reported <strong>not</strong> to work with <em>DBD::mysql</em>. Experimental feature.
6553 May not contain double colons (<code>:</code>). Default: <em>SQLite</em>.
6554 See <a href="git-cvsserver.html
">git-cvsserver(1)</a>.
6557 <dt class="hdlist1
">
6558 gitcvs.dbUser, gitcvs.dbPass
6562 Database user and password. Only useful if setting <code>gitcvs.dbDriver</code>,
6563 since SQLite has no concept of database users and/or passwords.
6564 <em>gitcvs.dbUser</em> supports variable substitution (see
6565 <a href="git-cvsserver.html
">git-cvsserver(1)</a> for details).
6568 <dt class="hdlist1
">
6569 gitcvs.dbTableNamePrefix
6573 Database table name prefix. Prepended to the names of any
6574 database tables used, allowing a single database to be used
6575 for several repositories. Supports variable substitution (see
6576 <a href="git-cvsserver.html
">git-cvsserver(1)</a> for details). Any non-alphabetic
6577 characters will be replaced with underscores.
6581 <div class="paragraph
"><p>All gitcvs variables except for <code>gitcvs.usecrlfattr</code> and
6582 <code>gitcvs.allBinary</code> can also be specified as
6583 <em>gitcvs.<access_method>.<varname></em> (where <em>access_method</em>
6584 is one of "ext
" and "pserver
") to make them apply only for the given
6585 access method.</p></div>
6586 <div class="dlist
"><dl>
6587 <dt class="hdlist1
">
6590 <dt class="hdlist1
">
6593 <dt class="hdlist1
">
6596 <dt class="hdlist1
">
6601 See <a href="gitweb.html
">gitweb(1)</a> for description.
6604 <dt class="hdlist1
">
6607 <dt class="hdlist1
">
6610 <dt class="hdlist1
">
6613 <dt class="hdlist1
">
6616 <dt class="hdlist1
">
6619 <dt class="hdlist1
">
6622 <dt class="hdlist1
">
6625 <dt class="hdlist1
">
6628 <dt class="hdlist1
">
6633 See <a href="gitweb.conf.html
">gitweb.conf(5)</a> for description.
6636 <dt class="hdlist1
">
6641 Use this custom program instead of "<code>gpg
</code>" found on <code>$PATH</code> when
6642 making or verifying a PGP signature. The program must support the
6643 same command-line interface as GPG, namely, to verify a detached
6644 signature, "<code>gpg --verify $signature -
<$file
</code>" is run, and the
6645 program is expected to signal a good signature by exiting with
6646 code 0. To generate an ASCII-armored detached signature, the
6647 standard input of "<code>gpg -bsau $key
</code>" is fed with the contents to be
6648 signed, and the program is expected to send the result to its
6652 <dt class="hdlist1
">
6657 Specifies which key format to use when signing with <code>--gpg-sign</code>.
6658 Default is "openpgp
". Other possible values are "x509
", "ssh
".
6660 <div class="paragraph
"><p>See <a href="gitformat-signature.html
">gitformat-signature(5)</a> for the signature format, which differs
6661 based on the selected <code>gpg.format</code>.</p></div>
6663 <dt class="hdlist1
">
6664 gpg.<format>.program
6668 Use this to customize the program used for the signing format you
6669 chose. (see <code>gpg.program</code> and <code>gpg.format</code>) <code>gpg.program</code> can still
6670 be used as a legacy synonym for <code>gpg.openpgp.program</code>. The default
6671 value for <code>gpg.x509.program</code> is "gpgsm
" and <code>gpg.ssh.program</code> is "ssh-keygen
".
6674 <dt class="hdlist1
">
6679 Specifies a minimum trust level for signature verification. If
6680 this option is unset, then signature verification for merge
6681 operations requires a key with at least <code>marginal</code> trust. Other
6682 operations that perform signature verification require a key
6683 with at least <code>undefined</code> trust. Setting this option overrides
6684 the required trust-level for all operations. Supported values,
6685 in increasing order of significance:
6687 <div class="ulist
"><ul>
6690 <code>undefined</code>
6700 <code>marginal</code>
6710 <code>ultimate</code>
6715 <dt class="hdlist1
">
6716 gpg.ssh.defaultKeyCommand
6720 This command will be run when user.signingkey is not set and a ssh
6721 signature is requested. On successful exit a valid ssh public key
6722 prefixed with <code>key::</code> is expected in the first line of its output.
6723 This allows for a script doing a dynamic lookup of the correct public
6724 key when it is impractical to statically configure <code>user.signingKey</code>.
6725 For example when keys or SSH Certificates are rotated frequently or
6726 selection of the right key depends on external factors unknown to git.
6729 <dt class="hdlist1
">
6730 gpg.ssh.allowedSignersFile
6734 A file containing ssh public keys which you are willing to trust.
6735 The file consists of one or more lines of principals followed by an ssh
6737 e.g.: <code>user1@example.com,user2@example.com ssh-rsa AAAAX1...</code>
6738 See ssh-keygen(1) "ALLOWED SIGNERS
" for details.
6739 The principal is only used to identify the key and is available when
6740 verifying a signature.
6742 <div class="paragraph
"><p>SSH has no concept of trust levels like gpg does. To be able to differentiate
6743 between valid signatures and trusted signatures the trust level of a signature
6744 verification is set to <code>fully</code> when the public key is present in the allowedSignersFile.
6745 Otherwise the trust level is <code>undefined</code> and git verify-commit/tag will fail.</p></div>
6746 <div class="paragraph
"><p>This file can be set to a location outside of the repository and every developer
6747 maintains their own trust store. A central repository server could generate this
6748 file automatically from ssh keys with push access to verify the code against.
6749 In a corporate setting this file is probably generated at a global location
6750 from automation that already handles developer ssh keys.</p></div>
6751 <div class="paragraph
"><p>A repository that only allows signed commits can store the file
6752 in the repository itself using a path relative to the top-level of the working tree.
6753 This way only committers with an already valid key can add or change keys in the keyring.</p></div>
6754 <div class="paragraph
"><p>Since OpensSSH 8.8 this file allows specifying a key lifetime using valid-after &
6755 valid-before options. Git will mark signatures as valid if the signing key was
6756 valid at the time of the signature’s creation. This allows users to change a
6757 signing key without invalidating all previously made signatures.</p></div>
6758 <div class="paragraph
"><p>Using a SSH CA key with the cert-authority option
6759 (see ssh-keygen(1) "CERTIFICATES
") is also valid.</p></div>
6761 <dt class="hdlist1
">
6762 gpg.ssh.revocationFile
6766 Either a SSH KRL or a list of revoked public keys (without the principal prefix).
6767 See ssh-keygen(1) for details.
6768 If a public key is found in this file then it will always be treated
6769 as having trust level "never
" and signatures will show as invalid.
6772 <dt class="hdlist1
">
6777 If set to true, enable <code>-n</code> option by default.
6780 <dt class="hdlist1
">
6785 If set to true, enable the <code>--column</code> option by default.
6788 <dt class="hdlist1
">
6793 Set the default matching behavior. Using a value of <em>basic</em>, <em>extended</em>,
6794 <em>fixed</em>, or <em>perl</em> will enable the <code>--basic-regexp</code>, <code>--extended-regexp</code>,
6795 <code>--fixed-strings</code>, or <code>--perl-regexp</code> option accordingly, while the
6796 value <em>default</em> will use the <code>grep.extendedRegexp</code> option to choose
6797 between <em>basic</em> and <em>extended</em>.
6800 <dt class="hdlist1
">
6805 If set to true, enable <code>--extended-regexp</code> option by default. This
6806 option is ignored when the <code>grep.patternType</code> option is set to a value
6807 other than <em>default</em>.
6810 <dt class="hdlist1
">
6815 Number of grep worker threads to use. If unset (or set to 0), Git will
6816 use as many threads as the number of logical cores available.
6819 <dt class="hdlist1
">
6824 If set to true, enable <code>--full-name</code> option by default.
6827 <dt class="hdlist1
">
6828 grep.fallbackToNoIndex
6832 If set to true, fall back to git grep --no-index if git grep
6833 is executed outside of a git repository. Defaults to false.
6836 <dt class="hdlist1
">
6841 Defines how wide the commit message window is in the
6842 <a href="git-gui.html
">git-gui(1)</a>. "75" is the default.
6845 <dt class="hdlist1
">
6850 Specifies how many context lines should be used in calls to diff
6851 made by the <a href="git-gui.html
">git-gui(1)</a>. The default is "5".
6854 <dt class="hdlist1
">
6855 gui.displayUntracked
6859 Determines if <a href="git-gui.html
">git-gui(1)</a> shows untracked files
6860 in the file list. The default is "true
".
6863 <dt class="hdlist1
">
6868 Specifies the default character encoding to use for displaying of
6869 file contents in <a href="git-gui.html
">git-gui(1)</a> and <a href="gitk.html
">gitk(1)</a>.
6870 It can be overridden by setting the <em>encoding</em> attribute
6871 for relevant files (see <a href="gitattributes.html
">gitattributes(5)</a>).
6872 If this option is not set, the tools default to the
6876 <dt class="hdlist1
">
6877 gui.matchTrackingBranch
6881 Determines if new branches created with <a href="git-gui.html
">git-gui(1)</a> should
6882 default to tracking remote branches with matching names or
6883 not. Default: "false
".
6886 <dt class="hdlist1
">
6887 gui.newBranchTemplate
6891 Is used as a suggested name when creating new branches using the
6892 <a href="git-gui.html
">git-gui(1)</a>.
6895 <dt class="hdlist1
">
6896 gui.pruneDuringFetch
6900 "true
" if <a href="git-gui.html
">git-gui(1)</a> should prune remote-tracking branches when
6901 performing a fetch. The default value is "false
".
6904 <dt class="hdlist1
">
6909 Determines if <a href="git-gui.html
">git-gui(1)</a> should trust the file modification
6910 timestamp or not. By default the timestamps are not trusted.
6913 <dt class="hdlist1
">
6914 gui.spellingDictionary
6918 Specifies the dictionary used for spell checking commit messages in
6919 the <a href="git-gui.html
">git-gui(1)</a>. When set to "none
" spell checking is turned
6923 <dt class="hdlist1
">
6928 If true, <em>git gui blame</em> uses <code>-C</code> instead of <code>-C -C</code> for original
6929 location detection. It makes blame significantly faster on huge
6930 repositories at the expense of less thorough copy detection.
6933 <dt class="hdlist1
">
6934 gui.copyBlameThreshold
6938 Specifies the threshold to use in <em>git gui blame</em> original location
6939 detection, measured in alphanumeric characters. See the
6940 <a href="git-blame.html
">git-blame(1)</a> manual for more information on copy detection.
6943 <dt class="hdlist1
">
6948 Specifies the radius of history context in days to show in
6949 <a href="gitk.html
">gitk(1)</a> for the selected commit, when the <code>Show History
6950 Context</code> menu item is invoked from <em>git gui blame</em>. If this
6951 variable is set to zero, the whole history is shown.
6954 <dt class="hdlist1
">
6955 guitool.<name>.cmd
6959 Specifies the shell command line to execute when the corresponding item
6960 of the <a href="git-gui.html
">git-gui(1)</a> <code>Tools</code> menu is invoked. This option is
6961 mandatory for every tool. The command is executed from the root of
6962 the working directory, and in the environment it receives the name of
6963 the tool as <code>GIT_GUITOOL</code>, the name of the currently selected file as
6964 <em>FILENAME</em>, and the name of the current branch as <em>CUR_BRANCH</em> (if
6965 the head is detached, <em>CUR_BRANCH</em> is empty).
6968 <dt class="hdlist1
">
6969 guitool.<name>.needsFile
6973 Run the tool only if a diff is selected in the GUI. It guarantees
6974 that <em>FILENAME</em> is not empty.
6977 <dt class="hdlist1
">
6978 guitool.<name>.noConsole
6982 Run the command silently, without creating a window to display its
6986 <dt class="hdlist1
">
6987 guitool.<name>.noRescan
6991 Don’t rescan the working directory for changes after the tool
6995 <dt class="hdlist1
">
6996 guitool.<name>.confirm
7000 Show a confirmation dialog before actually running the tool.
7003 <dt class="hdlist1
">
7004 guitool.<name>.argPrompt
7008 Request a string argument from the user, and pass it to the tool
7009 through the <code>ARGS</code> environment variable. Since requesting an
7010 argument implies confirmation, the <em>confirm</em> option has no effect
7011 if this is enabled. If the option is set to <em>true</em>, <em>yes</em>, or <em>1</em>,
7012 the dialog uses a built-in generic prompt; otherwise the exact
7013 value of the variable is used.
7016 <dt class="hdlist1
">
7017 guitool.<name>.revPrompt
7021 Request a single valid revision from the user, and set the
7022 <code>REVISION</code> environment variable. In other aspects this option
7023 is similar to <em>argPrompt</em>, and can be used together with it.
7026 <dt class="hdlist1
">
7027 guitool.<name>.revUnmerged
7031 Show only unmerged branches in the <em>revPrompt</em> subdialog.
7032 This is useful for tools similar to merge or rebase, but not
7033 for things like checkout or reset.
7036 <dt class="hdlist1
">
7037 guitool.<name>.title
7041 Specifies the title to use for the prompt dialog. The default
7045 <dt class="hdlist1
">
7046 guitool.<name>.prompt
7050 Specifies the general prompt string to display at the top of
7051 the dialog, before subsections for <em>argPrompt</em> and <em>revPrompt</em>.
7052 The default value includes the actual command.
7055 <dt class="hdlist1
">
7060 Specify the browser that will be used to display help in the
7061 <em>web</em> format. See <a href="git-help.html
">git-help(1)</a>.
7064 <dt class="hdlist1
">
7069 Override the default help format used by <a href="git-help.html
">git-help(1)</a>.
7070 Values <em>man</em>, <em>info</em>, <em>web</em> and <em>html</em> are supported. <em>man</em> is
7071 the default. <em>web</em> and <em>html</em> are the same.
7074 <dt class="hdlist1
">
7079 If git detects typos and can identify exactly one valid command similar
7080 to the error, git will try to suggest the correct command or even
7081 run the suggestion automatically. Possible config values are:
7083 <div class="ulist
"><ul>
7086 0 (default): show the suggested command.
7091 positive number: run the suggested command after specified
7092 deciseconds (0.1 sec).
7097 "immediate
": run the suggested command immediately.
7102 "prompt
": show the suggestion and prompt for confirmation to run
7108 "never
": don’t run or show any suggested command.
7113 <dt class="hdlist1
">
7118 Specify the path where the HTML documentation resides. File system paths
7119 and URLs are supported. HTML pages will be prefixed with this path when
7120 help is displayed in the <em>web</em> format. This defaults to the documentation
7121 path of your Git installation.
7124 <dt class="hdlist1
">
7129 Override the HTTP proxy, normally configured using the <em>http_proxy</em>,
7130 <em>https_proxy</em>, and <em>all_proxy</em> environment variables (see <code>curl(1)</code>). In
7131 addition to the syntax understood by curl, it is possible to specify a
7132 proxy string with a user name but no password, in which case git will
7133 attempt to acquire one in the same way it does for other credentials. See
7134 <a href="gitcredentials.html
">gitcredentials(7)</a> for more information. The syntax thus is
7135 <em>[protocol://][user[:password]@]proxyhost[:port]</em>. This can be overridden
7136 on a per-remote basis; see remote.<name>.proxy
7139 <dt class="hdlist1
">
7140 http.proxyAuthMethod
7144 Set the method with which to authenticate against the HTTP proxy. This
7145 only takes effect if the configured proxy string contains a user name part
7146 (i.e. is of the form <em>user@host</em> or <em>user@host:port</em>). This can be
7147 overridden on a per-remote basis; see <code>remote.<name>.proxyAuthMethod</code>.
7148 Both can be overridden by the <code>GIT_HTTP_PROXY_AUTHMETHOD</code> environment
7149 variable. Possible values are:
7151 <div class="openblock
">
7152 <div class="content
">
7153 <div class="ulist
"><ul>
7156 <code>anyauth</code> - Automatically pick a suitable authentication method. It is
7157 assumed that the proxy answers an unauthenticated request with a 407
7158 status code and one or more Proxy-authenticate headers with supported
7159 authentication methods. This is the default.
7164 <code>basic</code> - HTTP Basic authentication
7169 <code>digest</code> - HTTP Digest authentication; this prevents the password from being
7170 transmitted to the proxy in clear text
7175 <code>negotiate</code> - GSS-Negotiate authentication (compare the --negotiate option
7176 of <code>curl(1)</code>)
7181 <code>ntlm</code> - NTLM authentication (compare the --ntlm option of <code>curl(1)</code>)
7187 <dt class="hdlist1
">
7192 The pathname of a file that stores a client certificate to use to authenticate
7193 with an HTTPS proxy. Can be overridden by the <code>GIT_PROXY_SSL_CERT</code> environment
7197 <dt class="hdlist1
">
7202 The pathname of a file that stores a private key to use to authenticate with
7203 an HTTPS proxy. Can be overridden by the <code>GIT_PROXY_SSL_KEY</code> environment
7207 <dt class="hdlist1
">
7208 http.proxySSLCertPasswordProtected
7212 Enable Git’s password prompt for the proxy SSL certificate. Otherwise OpenSSL
7213 will prompt the user, possibly many times, if the certificate or private key
7214 is encrypted. Can be overridden by the <code>GIT_PROXY_SSL_CERT_PASSWORD_PROTECTED</code>
7215 environment variable.
7218 <dt class="hdlist1
">
7223 Pathname to the file containing the certificate bundle that should be used to
7224 verify the proxy with when using an HTTPS proxy. Can be overridden by the
7225 <code>GIT_PROXY_SSL_CAINFO</code> environment variable.
7228 <dt class="hdlist1
">
7233 Attempt authentication without seeking a username or password. This
7234 can be used to attempt GSS-Negotiate authentication without specifying
7235 a username in the URL, as libcurl normally requires a username for
7239 <dt class="hdlist1
">
7244 Control GSSAPI credential delegation. The delegation is disabled
7245 by default in libcurl since version 7.21.7. Set parameter to tell
7246 the server what it is allowed to delegate when it comes to user
7247 credentials. Used with GSS/kerberos. Possible values are:
7249 <div class="openblock
">
7250 <div class="content
">
7251 <div class="ulist
"><ul>
7254 <code>none</code> - Don’t allow any delegation.
7259 <code>policy</code> - Delegates if and only if the OK-AS-DELEGATE flag is set in the
7260 Kerberos service ticket, which is a matter of realm policy.
7265 <code>always</code> - Unconditionally allow the server to delegate.
7271 <dt class="hdlist1
">
7276 Pass an additional HTTP header when communicating with a server. If
7277 more than one such entry exists, all of them are added as extra
7278 headers. To allow overriding the settings inherited from the system
7279 config, an empty value will reset the extra headers to the empty list.
7282 <dt class="hdlist1
">
7287 The pathname of a file containing previously stored cookie lines,
7288 which should be used
7289 in the Git http session, if they match the server. The file format
7290 of the file to read cookies from should be plain HTTP headers or
7291 the Netscape/Mozilla cookie file format (see <code>curl(1)</code>).
7292 NOTE that the file specified with http.cookieFile is used only as
7293 input unless http.saveCookies is set.
7296 <dt class="hdlist1
">
7301 If set, store cookies received during requests to the file specified by
7302 http.cookieFile. Has no effect if http.cookieFile is unset.
7305 <dt class="hdlist1
">
7310 Use the specified HTTP protocol version when communicating with a server.
7311 If you want to force the default. The available and default version depend
7312 on libcurl. Currently the possible values of
7315 <div class="ulist
"><ul>
7328 <dt class="hdlist1
">
7333 Hostname resolution information that will be used first by
7334 libcurl when sending HTTP requests. This information should
7335 be in one of the following formats:
7337 <div class="ulist
"><ul>
7340 [+]HOST:PORT:ADDRESS[,ADDRESS]
7349 <div class="paragraph
"><p>The first format redirects all requests to the given <code>HOST:PORT</code>
7350 to the provided <code>ADDRESS</code>(s). The second format clears all
7351 previous config values for that <code>HOST:PORT</code> combination. To
7352 allow easy overriding of all the settings inherited from the
7353 system config, an empty value will reset all resolution
7354 information to the empty list.</p></div>
7356 <dt class="hdlist1
">
7361 The SSL version to use when negotiating an SSL connection, if you
7362 want to force the default. The available and default version
7363 depend on whether libcurl was built against NSS or OpenSSL and the
7364 particular configuration of the crypto library in use. Internally
7365 this sets the <em>CURLOPT_SSL_VERSION</em> option; see the libcurl
7366 documentation for more details on the format of this option and
7367 for the ssl version supported. Currently the possible values of
7370 <div class="ulist
"><ul>
7407 <div class="paragraph
"><p>Can be overridden by the <code>GIT_SSL_VERSION</code> environment variable.
7408 To force git to use libcurl’s default ssl version and ignore any
7409 explicit http.sslversion option, set <code>GIT_SSL_VERSION</code> to the
7410 empty string.</p></div>
7412 <dt class="hdlist1
">
7417 A list of SSL ciphers to use when negotiating an SSL connection.
7418 The available ciphers depend on whether libcurl was built against
7419 NSS or OpenSSL and the particular configuration of the crypto
7420 library in use. Internally this sets the <em>CURLOPT_SSL_CIPHER_LIST</em>
7421 option; see the libcurl documentation for more details on the format
7424 <div class="paragraph
"><p>Can be overridden by the <code>GIT_SSL_CIPHER_LIST</code> environment variable.
7425 To force git to use libcurl’s default cipher list and ignore any
7426 explicit http.sslCipherList option, set <code>GIT_SSL_CIPHER_LIST</code> to the
7427 empty string.</p></div>
7429 <dt class="hdlist1
">
7434 Whether to verify the SSL certificate when fetching or pushing
7435 over HTTPS. Defaults to true. Can be overridden by the
7436 <code>GIT_SSL_NO_VERIFY</code> environment variable.
7439 <dt class="hdlist1
">
7444 File containing the SSL certificate when fetching or pushing
7445 over HTTPS. Can be overridden by the <code>GIT_SSL_CERT</code> environment
7449 <dt class="hdlist1
">
7454 File containing the SSL private key when fetching or pushing
7455 over HTTPS. Can be overridden by the <code>GIT_SSL_KEY</code> environment
7459 <dt class="hdlist1
">
7460 http.sslCertPasswordProtected
7464 Enable Git’s password prompt for the SSL certificate. Otherwise
7465 OpenSSL will prompt the user, possibly many times, if the
7466 certificate or private key is encrypted. Can be overridden by the
7467 <code>GIT_SSL_CERT_PASSWORD_PROTECTED</code> environment variable.
7470 <dt class="hdlist1
">
7475 File containing the certificates to verify the peer with when
7476 fetching or pushing over HTTPS. Can be overridden by the
7477 <code>GIT_SSL_CAINFO</code> environment variable.
7480 <dt class="hdlist1
">
7485 Path containing files with the CA certificates to verify the peer
7486 with when fetching or pushing over HTTPS. Can be overridden
7487 by the <code>GIT_SSL_CAPATH</code> environment variable.
7490 <dt class="hdlist1
">
7495 Name of the SSL backend to use (e.g. "openssl
" or "schannel
").
7496 This option is ignored if cURL lacks support for choosing the SSL
7500 <dt class="hdlist1
">
7501 http.schannelCheckRevoke
7505 Used to enforce or disable certificate revocation checks in cURL
7506 when http.sslBackend is set to "schannel
". Defaults to <code>true</code> if
7507 unset. Only necessary to disable this if Git consistently errors
7508 and the message is about checking the revocation status of a
7509 certificate. This option is ignored if cURL lacks support for
7510 setting the relevant SSL option at runtime.
7513 <dt class="hdlist1
">
7514 http.schannelUseSSLCAInfo
7518 As of cURL v7.60.0, the Secure Channel backend can use the
7519 certificate bundle provided via <code>http.sslCAInfo</code>, but that would
7520 override the Windows Certificate Store. Since this is not desirable
7521 by default, Git will tell cURL not to use that bundle by default
7522 when the <code>schannel</code> backend was configured via <code>http.sslBackend</code>,
7523 unless <code>http.schannelUseSSLCAInfo</code> overrides this behavior.
7526 <dt class="hdlist1
">
7531 Public key of the https service. It may either be the filename of
7532 a PEM or DER encoded public key file or a string starting with
7533 <em>sha256//</em> followed by the base64 encoded sha256 hash of the
7534 public key. See also libcurl <em>CURLOPT_PINNEDPUBLICKEY</em>. git will
7535 exit with an error if this option is set but not supported by
7539 <dt class="hdlist1
">
7544 Attempt to use AUTH SSL/TLS and encrypted data transfers
7545 when connecting via regular FTP protocol. This might be needed
7546 if the FTP server requires it for security reasons or you wish
7547 to connect securely whenever remote FTP server supports it.
7548 Default is false since it might trigger certificate verification
7549 errors on misconfigured servers.
7552 <dt class="hdlist1
">
7557 How many HTTP requests to launch in parallel. Can be overridden
7558 by the <code>GIT_HTTP_MAX_REQUESTS</code> environment variable. Default is 5.
7561 <dt class="hdlist1
">
7566 The number of curl sessions (counted across slots) to be kept across
7567 requests. They will not be ended with curl_easy_cleanup() until
7568 http_cleanup() is invoked. If USE_CURL_MULTI is not defined, this
7569 value will be capped at 1. Defaults to 1.
7572 <dt class="hdlist1
">
7577 Maximum size in bytes of the buffer used by smart HTTP
7578 transports when POSTing data to the remote system.
7579 For requests larger than this buffer size, HTTP/1.1 and
7580 Transfer-Encoding: chunked is used to avoid creating a
7581 massive pack file locally. Default is 1 MiB, which is
7582 sufficient for most requests.
7584 <div class="paragraph
"><p>Note that raising this limit is only effective for disabling chunked
7585 transfer encoding and therefore should be used only where the remote
7586 server or a proxy only supports HTTP/1.0 or is noncompliant with the
7587 HTTP standard. Raising this is not, in general, an effective solution
7588 for most push problems, but can increase memory consumption
7589 significantly since the entire buffer is allocated even for small
7592 <dt class="hdlist1
">
7593 http.lowSpeedLimit, http.lowSpeedTime
7597 If the HTTP transfer speed, in bytes per second, is less than
7598 <em>http.lowSpeedLimit</em> for longer than <em>http.lowSpeedTime</em> seconds,
7599 the transfer is aborted.
7600 Can be overridden by the <code>GIT_HTTP_LOW_SPEED_LIMIT</code> and
7601 <code>GIT_HTTP_LOW_SPEED_TIME</code> environment variables.
7604 <dt class="hdlist1
">
7609 A boolean which disables using of EPSV ftp command by curl.
7610 This can be helpful with some "poor
" ftp servers which don’t
7611 support EPSV mode. Can be overridden by the <code>GIT_CURL_FTP_NO_EPSV</code>
7612 environment variable. Default is false (curl will use EPSV).
7615 <dt class="hdlist1
">
7620 The HTTP USER_AGENT string presented to an HTTP server. The default
7621 value represents the version of the Git client such as git/1.7.1.
7622 This option allows you to override this value to a more common value
7623 such as Mozilla/4.0. This may be necessary, for instance, if
7624 connecting through a firewall that restricts HTTP connections to a set
7625 of common USER_AGENT strings (but not including those like git/1.7.1).
7626 Can be overridden by the <code>GIT_HTTP_USER_AGENT</code> environment variable.
7629 <dt class="hdlist1
">
7630 http.followRedirects
7634 Whether git should follow HTTP redirects. If set to <code>true</code>, git
7635 will transparently follow any redirect issued by a server it
7636 encounters. If set to <code>false</code>, git will treat all redirects as
7637 errors. If set to <code>initial</code>, git will follow redirects only for
7638 the initial request to a remote, but not for subsequent
7639 follow-up HTTP requests. Since git uses the redirected URL as
7640 the base for the follow-up requests, this is generally
7641 sufficient. The default is <code>initial</code>.
7644 <dt class="hdlist1
">
7649 Any of the http.* options above can be applied selectively to some URLs.
7650 For a config key to match a URL, each element of the config key is
7651 compared to that of the URL, in the following order:
7653 <div class="openblock
">
7654 <div class="content
">
7655 <div class="olist arabic
"><ol class="arabic
">
7658 Scheme (e.g., <code>https</code> in <code>https://example.com/</code>). This field
7659 must match exactly between the config key and the URL.
7664 Host/domain name (e.g., <code>example.com</code> in <code>https://example.com/</code>).
7665 This field must match between the config key and the URL. It is
7666 possible to specify a <code>*</code> as part of the host name to match all subdomains
7667 at this level. <code>https://*.example.com/</code> for example would match
7668 <code>https://foo.example.com/</code>, but not <code>https://foo.bar.example.com/</code>.
7673 Port number (e.g., <code>8080</code> in <code>http://example.com:8080/</code>).
7674 This field must match exactly between the config key and the URL.
7675 Omitted port numbers are automatically converted to the correct
7676 default for the scheme before matching.
7681 Path (e.g., <code>repo.git</code> in <code>https://example.com/repo.git</code>). The
7682 path field of the config key must match the path field of the URL
7683 either exactly or as a prefix of slash-delimited path elements. This means
7684 a config key with path <code>foo/</code> matches URL path <code>foo/bar</code>. A prefix can only
7685 match on a slash (<code>/</code>) boundary. Longer matches take precedence (so a config
7686 key with path <code>foo/bar</code> is a better match to URL path <code>foo/bar</code> than a config
7687 key with just path <code>foo/</code>).
7692 User name (e.g., <code>user</code> in <code>https://user@example.com/repo.git</code>). If
7693 the config key has a user name it must match the user name in the
7694 URL exactly. If the config key does not have a user name, that
7695 config key will match a URL with any user name (including none),
7696 but at a lower precedence than a config key with a user name.
7701 <div class="paragraph
"><p>The list above is ordered by decreasing precedence; a URL that matches
7702 a config key’s path is preferred to one that matches its user name. For example,
7703 if the URL is <code>https://user@example.com/foo/bar</code> a config key match of
7704 <code>https://example.com/foo</code> will be preferred over a config key match of
7705 <code>https://user@example.com</code>.</p></div>
7706 <div class="paragraph
"><p>All URLs are normalized before attempting any matching (the password part,
7707 if embedded in the URL, is always ignored for matching purposes) so that
7708 equivalent URLs that are simply spelled differently will match properly.
7709 Environment variable settings always override any matches. The URLs that are
7710 matched against are those given directly to Git commands. This means any URLs
7711 visited as a result of a redirection do not participate in matching.</p></div>
7713 <dt class="hdlist1
">
7718 Character encoding the commit messages are stored in; Git itself
7719 does not care per se, but this information is necessary e.g. when
7720 importing commits from emails or in the gitk graphical history
7721 browser (and possibly in other places in the future or in other
7722 porcelains). See e.g. <a href="git-mailinfo.html
">git-mailinfo(1)</a>. Defaults to <em>utf-8</em>.
7725 <dt class="hdlist1
">
7726 i18n.logOutputEncoding
7730 Character encoding the commit messages are converted to when
7731 running <em>git log</em> and friends.
7734 <dt class="hdlist1
">
7739 The folder to drop the mails into, which is typically the Drafts
7740 folder. For example: "INBOX.Drafts
", "INBOX/Drafts
" or
7741 "[Gmail]/Drafts
". Required.
7744 <dt class="hdlist1
">
7749 Command used to set up a tunnel to the IMAP server through which
7750 commands will be piped instead of using a direct network connection
7751 to the server. Required when imap.host is not set.
7754 <dt class="hdlist1
">
7759 A URL identifying the server. Use an <code>imap://</code> prefix for non-secure
7760 connections and an <code>imaps://</code> prefix for secure connections.
7761 Ignored when imap.tunnel is set, but required otherwise.
7764 <dt class="hdlist1
">
7769 The username to use when logging in to the server.
7772 <dt class="hdlist1
">
7777 The password to use when logging in to the server.
7780 <dt class="hdlist1
">
7785 An integer port number to connect to on the server.
7786 Defaults to 143 for imap:// hosts and 993 for imaps:// hosts.
7787 Ignored when imap.tunnel is set.
7790 <dt class="hdlist1
">
7795 A boolean to enable/disable verification of the server certificate
7796 used by the SSL/TLS connection. Default is <code>true</code>. Ignored when
7800 <dt class="hdlist1
">
7801 imap.preformattedHTML
7805 A boolean to enable/disable the use of html encoding when sending
7806 a patch. An html encoded patch will be bracketed with <pre>
7807 and have a content type of text/html. Ironically, enabling this
7808 option causes Thunderbird to send the patch as a plain/text,
7809 format=fixed email. Default is <code>false</code>.
7812 <dt class="hdlist1
">
7817 Specify the authentication method for authenticating with the IMAP server.
7818 If Git was built with the NO_CURL option, or if your curl version is older
7819 than 7.34.0, or if you’re running git-imap-send with the <code>--no-curl</code>
7820 option, the only supported method is <em>CRAM-MD5</em>. If this is not set
7821 then <em>git imap-send</em> uses the basic IMAP plaintext LOGIN command.
7824 <dt class="hdlist1
">
7827 <dt class="hdlist1
">
7828 includeIf.<condition>.path
7832 Special variables to include other configuration files. See
7833 the "CONFIGURATION FILE
" section in the main
7834 <a href="git-config.html
">git-config(1)</a> documentation,
7835 specifically the "Includes
" and "Conditional Includes
" subsections.
7838 <dt class="hdlist1
">
7839 index.recordEndOfIndexEntries
7843 Specifies whether the index file should include an "End Of Index
7844 Entry
" section. This reduces index load time on multiprocessor
7845 machines but produces a message "ignoring EOIE extension
" when
7846 reading the index using Git versions before 2.20. Defaults to
7847 <em>true</em> if index.threads has been explicitly enabled, <em>false</em>
7851 <dt class="hdlist1
">
7852 index.recordOffsetTable
7856 Specifies whether the index file should include an "Index Entry
7857 Offset Table
" section. This reduces index load time on
7858 multiprocessor machines but produces a message "ignoring IEOT
7859 extension
" when reading the index using Git versions before 2.20.
7860 Defaults to <em>true</em> if index.threads has been explicitly enabled,
7861 <em>false</em> otherwise.
7864 <dt class="hdlist1
">
7869 When enabled, write the index using sparse-directory entries. This
7870 has no effect unless <code>core.sparseCheckout</code> and
7871 <code>core.sparseCheckoutCone</code> are both enabled. Defaults to <em>false</em>.
7874 <dt class="hdlist1
">
7879 Specifies the number of threads to spawn when loading the index.
7880 This is meant to reduce index load time on multiprocessor machines.
7881 Specifying 0 or <em>true</em> will cause Git to auto-detect the number of
7882 CPUs and set the number of threads accordingly. Specifying 1 or
7883 <em>false</em> will disable multithreading. Defaults to <em>true</em>.
7886 <dt class="hdlist1
">
7891 Specify the version with which new index files should be
7892 initialized. This does not affect existing repositories.
7893 If <code>feature.manyFiles</code> is enabled, then the default is 4.
7896 <dt class="hdlist1
">
7901 When enabled, do not compute the trailing hash for the index file.
7902 This accelerates Git commands that manipulate the index, such as
7903 <code>git add</code>, <code>git commit</code>, or <code>git status</code>. Instead of storing the
7904 checksum, write a trailing set of bytes with value zero, indicating
7905 that the computation was skipped.
7907 <div class="paragraph
"><p>If you enable <code>index.skipHash</code>, then Git clients older than 2.13.0 will
7908 refuse to parse the index and Git clients older than 2.40.0 will report an
7909 error during <code>git fsck</code>.</p></div>
7912 <div class="dlist
"><dl>
7913 <dt class="hdlist1
">
7918 Specify the directory from which templates will be copied. (See the "TEMPLATE DIRECTORY
" section of <a href="git-init.html
">git-init(1)</a>.)
7921 <dt class="hdlist1
">
7926 Allows overriding the default branch name e.g. when initializing
7930 <dt class="hdlist1
">
7935 Specify the program that will be used to browse your working
7936 repository in gitweb. See <a href="git-instaweb.html
">git-instaweb(1)</a>.
7939 <dt class="hdlist1
">
7944 The HTTP daemon command-line to start gitweb on your working
7945 repository. See <a href="git-instaweb.html
">git-instaweb(1)</a>.
7948 <dt class="hdlist1
">
7953 If true the web server started by <a href="git-instaweb.html
">git-instaweb(1)</a> will
7954 be bound to the local IP (127.0.0.1).
7957 <dt class="hdlist1
">
7962 The default module path for <a href="git-instaweb.html
">git-instaweb(1)</a> to use
7963 instead of /usr/lib/apache2/modules. Only used if httpd
7967 <dt class="hdlist1
">
7972 The port number to bind the gitweb httpd to. See
7973 <a href="git-instaweb.html
">git-instaweb(1)</a>.
7976 <dt class="hdlist1
">
7977 interactive.singleKey
7981 In interactive commands, allow the user to provide one-letter
7982 input with a single key (i.e., without hitting enter).
7983 Currently this is used by the <code>--patch</code> mode of
7984 <a href="git-add.html
">git-add(1)</a>, <a href="git-checkout.html
">git-checkout(1)</a>,
7985 <a href="git-restore.html
">git-restore(1)</a>, <a href="git-commit.html
">git-commit(1)</a>,
7986 <a href="git-reset.html
">git-reset(1)</a>, and <a href="git-stash.html
">git-stash(1)</a>.
7989 <dt class="hdlist1
">
7990 interactive.diffFilter
7994 When an interactive command (such as <code>git add --patch</code>) shows
7995 a colorized diff, git will pipe the diff through the shell
7996 command defined by this configuration variable. The command may
7997 mark up the diff further for human consumption, provided that it
7998 retains a one-to-one correspondence with the lines in the
7999 original diff. Defaults to disabled (no filtering).
8002 <dt class="hdlist1
">
8007 If true, makes <a href="git-log.html
">git-log(1)</a>, <a href="git-show.html
">git-show(1)</a>, and
8008 <a href="git-whatchanged.html
">git-whatchanged(1)</a> assume <code>--abbrev-commit</code>. You may
8009 override this option with <code>--no-abbrev-commit</code>.
8012 <dt class="hdlist1
">
8017 Set the default date-time mode for the <em>log</em> command.
8018 Setting a value for log.date is similar to using <em>git log</em>'s
8019 <code>--date</code> option. See <a href="git-log.html
">git-log(1)</a> for details.
8021 <div class="paragraph
"><p>If the format is set to "auto:foo
" and the pager is in use, format
8022 "foo
" will be used for the date format. Otherwise, "default
" will
8025 <dt class="hdlist1
">
8030 Print out the ref names of any commits that are shown by the log
8031 command. If <em>short</em> is specified, the ref name prefixes <em>refs/heads/</em>,
8032 <em>refs/tags/</em> and <em>refs/remotes/</em> will not be printed. If <em>full</em> is
8033 specified, the full ref name (including prefix) will be printed.
8034 If <em>auto</em> is specified, then if the output is going to a terminal,
8035 the ref names are shown as if <em>short</em> were given, otherwise no ref
8036 names are shown. This is the same as the <code>--decorate</code> option
8037 of the <code>git log</code>.
8040 <dt class="hdlist1
">
8041 log.initialDecorationSet
8045 By default, <code>git log</code> only shows decorations for certain known ref
8046 namespaces. If <em>all</em> is specified, then show all refs as
8050 <dt class="hdlist1
">
8051 log.excludeDecoration
8055 Exclude the specified patterns from the log decorations. This is
8056 similar to the <code>--decorate-refs-exclude</code> command-line option, but
8057 the config option can be overridden by the <code>--decorate-refs</code>
8061 <dt class="hdlist1
">
8066 Set diff format to be used when <code>--diff-merges=on</code> is
8067 specified, see <code>--diff-merges</code> in <a href="git-log.html
">git-log(1)</a> for
8068 details. Defaults to <code>separate</code>.
8071 <dt class="hdlist1
">
8076 If <code>true</code>, <code>git log</code> will act as if the <code>--follow</code> option was used when
8077 a single <path> is given. This has the same limitations as <code>--follow</code>,
8078 i.e. it cannot be used to follow multiple files and does not work well
8079 on non-linear history.
8082 <dt class="hdlist1
">
8087 A list of colors, separated by commas, that can be used to draw
8088 history lines in <code>git log --graph</code>.
8091 <dt class="hdlist1
">
8096 If true, the initial commit will be shown as a big creation event.
8097 This is equivalent to a diff against an empty tree.
8098 Tools like <a href="git-log.html
">git-log(1)</a> or <a href="git-whatchanged.html
">git-whatchanged(1)</a>, which
8099 normally hide the root commit will now show it. True by default.
8102 <dt class="hdlist1
">
8107 If true, makes <a href="git-log.html
">git-log(1)</a>, <a href="git-show.html
">git-show(1)</a>, and
8108 <a href="git-whatchanged.html
">git-whatchanged(1)</a> assume <code>--show-signature</code>.
8111 <dt class="hdlist1
">
8116 If true, makes <a href="git-log.html
">git-log(1)</a>, <a href="git-show.html
">git-show(1)</a>, and
8117 <a href="git-whatchanged.html
">git-whatchanged(1)</a> assume <code>--use-mailmap</code>, otherwise
8118 assume <code>--no-use-mailmap</code>. True by default.
8121 <dt class="hdlist1
">
8126 May be "advertise
" (the default), "allow
", or "ignore
". If "advertise
",
8127 the server will respond to the client sending "unborn
" (as described in
8128 <a href="gitprotocol-v2.html
">gitprotocol-v2(5)</a>) and will advertise support for this feature during the
8129 protocol v2 capability advertisement. "allow
" is the same as
8130 "advertise
" except that the server will not advertise support for this
8131 feature; this is useful for load-balanced servers that cannot be
8132 updated atomically (for example), since the administrator could
8133 configure "allow
", then after a delay, configure "advertise
".
8136 <dt class="hdlist1
">
8141 If true, makes <a href="git-mailinfo.html
">git-mailinfo(1)</a> (and therefore
8142 <a href="git-am.html
">git-am(1)</a>) act by default as if the --scissors option
8143 was provided on the command-line. When active, this feature
8144 removes everything from the message body before a scissors
8145 line (i.e. consisting mainly of ">8", "8<" and "-
").
8148 <dt class="hdlist1
">
8153 The location of an augmenting mailmap file. The default
8154 mailmap, located in the root of the repository, is loaded
8155 first, then the mailmap file pointed to by this variable.
8156 The location of the mailmap file may be in a repository
8157 subdirectory, or somewhere outside of the repository itself.
8158 See <a href="git-shortlog.html
">git-shortlog(1)</a> and <a href="git-blame.html
">git-blame(1)</a>.
8161 <dt class="hdlist1
">
8166 Like <code>mailmap.file</code>, but consider the value as a reference to a
8167 blob in the repository. If both <code>mailmap.file</code> and
8168 <code>mailmap.blob</code> are given, both are parsed, with entries from
8169 <code>mailmap.file</code> taking precedence. In a bare repository, this
8170 defaults to <code>HEAD:.mailmap</code>. In a non-bare repository, it
8174 <dt class="hdlist1
">
8179 This boolean config option controls whether some commands run
8180 <code>git maintenance run --auto</code> after doing their normal work. Defaults
8184 <dt class="hdlist1
">
8185 maintenance.strategy
8189 This string config option provides a way to specify one of a few
8190 recommended schedules for background maintenance. This only affects
8191 which tasks are run during <code>git maintenance run --schedule=X</code>
8192 commands, provided no <code>--task=<task></code> arguments are provided.
8193 Further, if a <code>maintenance.<task>.schedule</code> config value is set,
8194 then that value is used instead of the one provided by
8195 <code>maintenance.strategy</code>. The possible strategy strings are:
8197 <div class="ulist
"><ul>
8200 <code>none</code>: This default setting implies no tasks are run at any schedule.
8205 <code>incremental</code>: This setting optimizes for performing small maintenance
8206 activities that do not delete any data. This does not schedule the <code>gc</code>
8207 task, but runs the <code>prefetch</code> and <code>commit-graph</code> tasks hourly, the
8208 <code>loose-objects</code> and <code>incremental-repack</code> tasks daily, and the <code>pack-refs</code>
8214 <dt class="hdlist1
">
8215 maintenance.<task>.enabled
8219 This boolean config option controls whether the maintenance task
8220 with name <code><task></code> is run when no <code>--task</code> option is specified to
8221 <code>git maintenance run</code>. These config values are ignored if a
8222 <code>--task</code> option exists. By default, only <code>maintenance.gc.enabled</code>
8226 <dt class="hdlist1
">
8227 maintenance.<task>.schedule
8231 This config option controls whether or not the given <code><task></code> runs
8232 during a <code>git maintenance run --schedule=<frequency></code> command. The
8233 value must be one of "hourly
", "daily
", or "weekly
".
8236 <dt class="hdlist1
">
8237 maintenance.commit-graph.auto
8241 This integer config option controls how often the <code>commit-graph</code> task
8242 should be run as part of <code>git maintenance run --auto</code>. If zero, then
8243 the <code>commit-graph</code> task will not run with the <code>--auto</code> option. A
8244 negative value will force the task to run every time. Otherwise, a
8245 positive value implies the command should run when the number of
8246 reachable commits that are not in the commit-graph file is at least
8247 the value of <code>maintenance.commit-graph.auto</code>. The default value is
8251 <dt class="hdlist1
">
8252 maintenance.loose-objects.auto
8256 This integer config option controls how often the <code>loose-objects</code> task
8257 should be run as part of <code>git maintenance run --auto</code>. If zero, then
8258 the <code>loose-objects</code> task will not run with the <code>--auto</code> option. A
8259 negative value will force the task to run every time. Otherwise, a
8260 positive value implies the command should run when the number of
8261 loose objects is at least the value of <code>maintenance.loose-objects.auto</code>.
8262 The default value is 100.
8265 <dt class="hdlist1
">
8266 maintenance.incremental-repack.auto
8270 This integer config option controls how often the <code>incremental-repack</code>
8271 task should be run as part of <code>git maintenance run --auto</code>. If zero,
8272 then the <code>incremental-repack</code> task will not run with the <code>--auto</code>
8273 option. A negative value will force the task to run every time.
8274 Otherwise, a positive value implies the command should run when the
8275 number of pack-files not in the multi-pack-index is at least the value
8276 of <code>maintenance.incremental-repack.auto</code>. The default value is 10.
8279 <dt class="hdlist1
">
8284 Specify the programs that may be used to display help in the
8285 <em>man</em> format. See <a href="git-help.html
">git-help(1)</a>.
8288 <dt class="hdlist1
">
8289 man.<tool>.cmd
8293 Specify the command to invoke the specified man viewer. The
8294 specified command is evaluated in shell with the man page
8295 passed as an argument. (See <a href="git-help.html
">git-help(1)</a>.)
8298 <dt class="hdlist1
">
8299 man.<tool>.path
8303 Override the path for the given tool that may be used to
8304 display help in the <em>man</em> format. See <a href="git-help.html
">git-help(1)</a>.
8307 <dt class="hdlist1
">
8312 Specify the style in which conflicted hunks are written out to
8313 working tree files upon merge. The default is "merge
", which
8314 shows a <code><<<<<<<</code> conflict marker, changes made by one side,
8315 a <code>=======</code> marker, changes made by the other side, and then
8316 a <code>>>>>>>></code> marker. An alternate style, "diff3
", adds a <code>|||||||</code>
8317 marker and the original text before the <code>=======</code> marker. The
8318 "merge
" style tends to produce smaller conflict regions than diff3,
8319 both because of the exclusion of the original text, and because
8320 when a subset of lines match on the two sides, they are just pulled
8321 out of the conflict region. Another alternate style, "zdiff3
", is
8322 similar to diff3 but removes matching lines on the two sides from
8323 the conflict region when those matching lines appear near either
8324 the beginning or end of a conflict region.
8327 <dt class="hdlist1
">
8328 merge.defaultToUpstream
8332 If merge is called without any commit argument, merge the upstream
8333 branches configured for the current branch by using their last
8334 observed values stored in their remote-tracking branches.
8335 The values of the <code>branch.<current branch>.merge</code> that name the
8336 branches at the remote named by <code>branch.<current branch>.remote</code>
8337 are consulted, and then they are mapped via <code>remote.<remote>.fetch</code>
8338 to their corresponding remote-tracking branches, and the tips of
8339 these tracking branches are merged. Defaults to true.
8342 <dt class="hdlist1
">
8347 By default, Git does not create an extra merge commit when merging
8348 a commit that is a descendant of the current commit. Instead, the
8349 tip of the current branch is fast-forwarded. When set to <code>false</code>,
8350 this variable tells Git to create an extra merge commit in such
8351 a case (equivalent to giving the <code>--no-ff</code> option from the command
8352 line). When set to <code>only</code>, only such fast-forward merges are
8353 allowed (equivalent to giving the <code>--ff-only</code> option from the
8357 <dt class="hdlist1
">
8358 merge.verifySignatures
8362 If true, this is equivalent to the --verify-signatures command
8363 line option. See <a href="git-merge.html
">git-merge(1)</a> for details.
8366 <dt class="hdlist1
">
8371 In addition to branch names, populate the log message with
8372 the branch description text associated with them. Defaults
8376 <dt class="hdlist1
">
8381 In addition to branch names, populate the log message with at
8382 most the specified number of one-line descriptions from the
8383 actual commits that are being merged. Defaults to false, and
8384 true is a synonym for 20.
8387 <dt class="hdlist1
">
8392 By adding a glob that matches the names of integration
8393 branches to this multi-valued configuration variable, the
8394 default merge message computed for merges into these
8395 integration branches will omit "into
<branch name
>" from
8398 <div class="paragraph
"><p>An element with an empty value can be used to clear the list
8399 of globs accumulated from previous configuration entries.
8400 When there is no <code>merge.suppressDest</code> variable defined, the
8401 default value of <code>master</code> is used for backward compatibility.</p></div>
8403 <dt class="hdlist1
">
8408 The number of files to consider in the exhaustive portion of
8409 rename detection during a merge. If not specified, defaults
8410 to the value of diff.renameLimit. If neither
8411 merge.renameLimit nor diff.renameLimit are specified,
8412 currently defaults to 7000. This setting has no effect if
8413 rename detection is turned off.
8416 <dt class="hdlist1
">
8421 Whether Git detects renames. If set to "false
", rename detection
8422 is disabled. If set to "true
", basic rename detection is enabled.
8423 Defaults to the value of diff.renames.
8426 <dt class="hdlist1
">
8427 merge.directoryRenames
8431 Whether Git detects directory renames, affecting what happens at
8432 merge time to new files added to a directory on one side of
8433 history when that directory was renamed on the other side of
8434 history. If merge.directoryRenames is set to "false
", directory
8435 rename detection is disabled, meaning that such new files will be
8436 left behind in the old directory. If set to "true
", directory
8437 rename detection is enabled, meaning that such new files will be
8438 moved into the new directory. If set to "conflict
", a conflict
8439 will be reported for such paths. If merge.renames is false,
8440 merge.directoryRenames is ignored and treated as false. Defaults
8444 <dt class="hdlist1
">
8449 Tell Git that canonical representation of files in the
8450 repository has changed over time (e.g. earlier commits record
8451 text files with CRLF line endings, but recent ones use LF line
8452 endings). In such a repository, Git can convert the data
8453 recorded in commits to a canonical form before performing a
8454 merge to reduce unnecessary conflicts. For more information,
8455 see section "Merging branches with differing checkin/checkout
8456 attributes
" in <a href="gitattributes.html
">gitattributes(5)</a>.
8459 <dt class="hdlist1
">
8464 Whether to print the diffstat between ORIG_HEAD and the merge result
8465 at the end of the merge. True by default.
8468 <dt class="hdlist1
">
8473 When set to true, automatically create a temporary stash entry
8474 before the operation begins, and apply it after the operation
8475 ends. This means that you can run merge on a dirty worktree.
8476 However, use with care: the final stash application after a
8477 successful merge might result in non-trivial conflicts.
8478 This option can be overridden by the <code>--no-autostash</code> and
8479 <code>--autostash</code> options of <a href="git-merge.html
">git-merge(1)</a>.
8483 <dt class="hdlist1
">
8488 Controls which merge tool is used by <a href="git-mergetool.html
">git-mergetool(1)</a>.
8489 The list below shows the valid built-in values.
8490 Any other value is treated as a custom merge tool and requires
8491 that a corresponding mergetool.<tool>.cmd variable is defined.
8494 <dt class="hdlist1
">
8499 Controls which merge tool is used by <a href="git-mergetool.html
">git-mergetool(1)</a> when the
8500 -g/--gui flag is specified. The list below shows the valid built-in values.
8501 Any other value is treated as a custom merge tool and requires that a
8502 corresponding mergetool.<guitool>.cmd variable is defined.
8504 <div class="dlist
"><dl>
8505 <dt class="hdlist1
">
8510 Use Araxis Merge (requires a graphical session)
8513 <dt class="hdlist1
">
8518 Use Beyond Compare (requires a graphical session)
8521 <dt class="hdlist1
">
8526 Use Beyond Compare (requires a graphical session)
8529 <dt class="hdlist1
">
8534 Use Beyond Compare (requires a graphical session)
8537 <dt class="hdlist1
">
8538 <code>codecompare</code>
8542 Use Code Compare (requires a graphical session)
8545 <dt class="hdlist1
">
8546 <code>deltawalker</code>
8550 Use DeltaWalker (requires a graphical session)
8553 <dt class="hdlist1
">
8554 <code>diffmerge</code>
8558 Use DiffMerge (requires a graphical session)
8561 <dt class="hdlist1
">
8562 <code>diffuse</code>
8566 Use Diffuse (requires a graphical session)
8569 <dt class="hdlist1
">
8570 <code>ecmerge</code>
8574 Use ECMerge (requires a graphical session)
8577 <dt class="hdlist1
">
8585 <dt class="hdlist1
">
8586 <code>examdiff</code>
8590 Use ExamDiff Pro (requires a graphical session)
8593 <dt class="hdlist1
">
8598 Use Guiffy’s Diff Tool (requires a graphical session)
8601 <dt class="hdlist1
">
8602 <code>gvimdiff</code>
8606 Use gVim (requires a graphical session) with a custom layout (see <code>git help mergetool</code>'s <code>BACKEND SPECIFIC HINTS</code> section)
8609 <dt class="hdlist1
">
8610 <code>gvimdiff1</code>
8614 Use gVim (requires a graphical session) with a 2 panes layout (LOCAL and REMOTE)
8617 <dt class="hdlist1
">
8618 <code>gvimdiff2</code>
8622 Use gVim (requires a graphical session) with a 3 panes layout (LOCAL, MERGED and REMOTE)
8625 <dt class="hdlist1
">
8626 <code>gvimdiff3</code>
8630 Use gVim (requires a graphical session) where only the MERGED file is shown
8633 <dt class="hdlist1
">
8638 Use KDiff3 (requires a graphical session)
8641 <dt class="hdlist1
">
8646 Use Meld (requires a graphical session) with optional <code>auto merge</code> (see <code>git help mergetool</code>'s <code>CONFIGURATION</code> section)
8649 <dt class="hdlist1
">
8650 <code>nvimdiff</code>
8654 Use Neovim with a custom layout (see <code>git help mergetool</code>'s <code>BACKEND SPECIFIC HINTS</code> section)
8657 <dt class="hdlist1
">
8658 <code>nvimdiff1</code>
8662 Use Neovim with a 2 panes layout (LOCAL and REMOTE)
8665 <dt class="hdlist1
">
8666 <code>nvimdiff2</code>
8670 Use Neovim with a 3 panes layout (LOCAL, MERGED and REMOTE)
8673 <dt class="hdlist1
">
8674 <code>nvimdiff3</code>
8678 Use Neovim where only the MERGED file is shown
8681 <dt class="hdlist1
">
8682 <code>opendiff</code>
8686 Use FileMerge (requires a graphical session)
8689 <dt class="hdlist1
">
8690 <code>p4merge</code>
8694 Use HelixCore P4Merge (requires a graphical session)
8697 <dt class="hdlist1
">
8702 Use Sublime Merge (requires a graphical session)
8705 <dt class="hdlist1
">
8710 Use TkDiff (requires a graphical session)
8713 <dt class="hdlist1
">
8714 <code>tortoisemerge</code>
8718 Use TortoiseMerge (requires a graphical session)
8721 <dt class="hdlist1
">
8722 <code>vimdiff</code>
8726 Use Vim with a custom layout (see <code>git help mergetool</code>'s <code>BACKEND SPECIFIC HINTS</code> section)
8729 <dt class="hdlist1
">
8730 <code>vimdiff1</code>
8734 Use Vim with a 2 panes layout (LOCAL and REMOTE)
8737 <dt class="hdlist1
">
8738 <code>vimdiff2</code>
8742 Use Vim with a 3 panes layout (LOCAL, MERGED and REMOTE)
8745 <dt class="hdlist1
">
8746 <code>vimdiff3</code>
8750 Use Vim where only the MERGED file is shown
8753 <dt class="hdlist1
">
8754 <code>winmerge</code>
8758 Use WinMerge (requires a graphical session)
8761 <dt class="hdlist1
">
8766 Use xxdiff (requires a graphical session)
8771 <dt class="hdlist1
">
8776 Controls the amount of output shown by the recursive merge
8777 strategy. Level 0 outputs nothing except a final error
8778 message if conflicts were detected. Level 1 outputs only
8779 conflicts, 2 outputs conflicts and file changes. Level 5 and
8780 above outputs debugging information. The default is level 2.
8781 Can be overridden by the <code>GIT_MERGE_VERBOSITY</code> environment variable.
8784 <dt class="hdlist1
">
8785 merge.<driver>.name
8789 Defines a human-readable name for a custom low-level
8790 merge driver. See <a href="gitattributes.html
">gitattributes(5)</a> for details.
8793 <dt class="hdlist1
">
8794 merge.<driver>.driver
8798 Defines the command that implements a custom low-level
8799 merge driver. See <a href="gitattributes.html
">gitattributes(5)</a> for details.
8802 <dt class="hdlist1
">
8803 merge.<driver>.recursive
8807 Names a low-level merge driver to be used when
8808 performing an internal merge between common ancestors.
8809 See <a href="gitattributes.html
">gitattributes(5)</a> for details.
8812 <dt class="hdlist1
">
8813 mergetool.<tool>.path
8817 Override the path for the given tool. This is useful in case
8818 your tool is not in the PATH.
8821 <dt class="hdlist1
">
8822 mergetool.<tool>.cmd
8826 Specify the command to invoke the specified merge tool. The
8827 specified command is evaluated in shell with the following
8828 variables available: <em>BASE</em> is the name of a temporary file
8829 containing the common base of the files to be merged, if available;
8830 <em>LOCAL</em> is the name of a temporary file containing the contents of
8831 the file on the current branch; <em>REMOTE</em> is the name of a temporary
8832 file containing the contents of the file from the branch being
8833 merged; <em>MERGED</em> contains the name of the file to which the merge
8834 tool should write the results of a successful merge.
8837 <dt class="hdlist1
">
8838 mergetool.<tool>.hideResolved
8842 Allows the user to override the global <code>mergetool.hideResolved</code> value
8843 for a specific tool. See <code>mergetool.hideResolved</code> for the full
8847 <dt class="hdlist1
">
8848 mergetool.<tool>.trustExitCode
8852 For a custom merge command, specify whether the exit code of
8853 the merge command can be used to determine whether the merge was
8854 successful. If this is not set to true then the merge target file
8855 timestamp is checked, and the merge is assumed to have been successful
8856 if the file has been updated; otherwise, the user is prompted to
8857 indicate the success of the merge.
8860 <dt class="hdlist1
">
8861 mergetool.meld.hasOutput
8865 Older versions of <code>meld</code> do not support the <code>--output</code> option.
8866 Git will attempt to detect whether <code>meld</code> supports <code>--output</code>
8867 by inspecting the output of <code>meld --help</code>. Configuring
8868 <code>mergetool.meld.hasOutput</code> will make Git skip these checks and
8869 use the configured value instead. Setting <code>mergetool.meld.hasOutput</code>
8870 to <code>true</code> tells Git to unconditionally use the <code>--output</code> option,
8871 and <code>false</code> avoids using <code>--output</code>.
8874 <dt class="hdlist1
">
8875 mergetool.meld.useAutoMerge
8879 When the <code>--auto-merge</code> is given, meld will merge all non-conflicting
8880 parts automatically, highlight the conflicting parts, and wait for
8881 user decision. Setting <code>mergetool.meld.useAutoMerge</code> to <code>true</code> tells
8882 Git to unconditionally use the <code>--auto-merge</code> option with <code>meld</code>.
8883 Setting this value to <code>auto</code> makes git detect whether <code>--auto-merge</code>
8884 is supported and will only use <code>--auto-merge</code> when available. A
8885 value of <code>false</code> avoids using <code>--auto-merge</code> altogether, and is the
8889 <dt class="hdlist1
">
8890 mergetool.<vimdiff variant>.layout
8894 Configure the split window layout for vimdiff’s <code><variant></code>, which is any of <code>vimdiff</code>,
8895 <code>nvimdiff</code>, <code>gvimdiff</code>.
8896 Upon launching <code>git mergetool</code> with <code>--tool=<variant></code> (or without <code>--tool</code>
8897 if <code>merge.tool</code> is configured as <code><variant></code>), Git will consult
8898 <code>mergetool.<variant>.layout</code> to determine the tool’s layout. If the
8899 variant-specific configuration is not available, <code>vimdiff</code>'s is used as
8900 fallback. If that too is not available, a default layout with 4 windows
8901 will be used. To configure the layout, see the <code>BACKEND SPECIFIC HINTS</code>
8902 section in <a href="git-mergetool.html
">git-mergetool(1)</a>.
8905 <dt class="hdlist1
">
8906 mergetool.hideResolved
8910 During a merge, Git will automatically resolve as many conflicts as
8911 possible and write the <em>MERGED</em> file containing conflict markers around
8912 any conflicts that it cannot resolve; <em>LOCAL</em> and <em>REMOTE</em> normally
8913 represent the versions of the file from before Git’s conflict
8914 resolution. This flag causes <em>LOCAL</em> and <em>REMOTE</em> to be overwritten so
8915 that only the unresolved conflicts are presented to the merge tool. Can
8916 be configured per-tool via the <code>mergetool.<tool>.hideResolved</code>
8917 configuration variable. Defaults to <code>false</code>.
8920 <dt class="hdlist1
">
8921 mergetool.keepBackup
8925 After performing a merge, the original file with conflict markers
8926 can be saved as a file with a <code>.orig</code> extension. If this variable
8927 is set to <code>false</code> then this file is not preserved. Defaults to
8928 <code>true</code> (i.e. keep the backup files).
8931 <dt class="hdlist1
">
8932 mergetool.keepTemporaries
8936 When invoking a custom merge tool, Git uses a set of temporary
8937 files to pass to the tool. If the tool returns an error and this
8938 variable is set to <code>true</code>, then these temporary files will be
8939 preserved; otherwise, they will be removed after the tool has
8940 exited. Defaults to <code>false</code>.
8943 <dt class="hdlist1
">
8944 mergetool.writeToTemp
8948 Git writes temporary <em>BASE</em>, <em>LOCAL</em>, and <em>REMOTE</em> versions of
8949 conflicting files in the worktree by default. Git will attempt
8950 to use a temporary directory for these files when set <code>true</code>.
8951 Defaults to <code>false</code>.
8954 <dt class="hdlist1
">
8959 Prompt before each invocation of the merge resolution program.
8962 <dt class="hdlist1
">
8963 mergetool.guiDefault
8967 Set <code>true</code> to use the <code>merge.guitool</code> by default (equivalent to
8968 specifying the <code>--gui</code> argument), or <code>auto</code> to select <code>merge.guitool</code>
8969 or <code>merge.tool</code> depending on the presence of a <code>DISPLAY</code> environment
8970 variable value. The default is <code>false</code>, where the <code>--gui</code> argument
8971 must be provided explicitly for the <code>merge.guitool</code> to be used.
8974 <dt class="hdlist1
">
8979 Which merge strategy to choose by default when resolving notes
8980 conflicts. Must be one of <code>manual</code>, <code>ours</code>, <code>theirs</code>, <code>union</code>, or
8981 <code>cat_sort_uniq</code>. Defaults to <code>manual</code>. See the "NOTES MERGE STRATEGIES
"
8982 section of <a href="git-notes.html
">git-notes(1)</a> for more information on each strategy.
8984 <div class="paragraph
"><p>This setting can be overridden by passing the <code>--strategy</code> option to
8985 <a href="git-notes.html
">git-notes(1)</a>.</p></div>
8987 <dt class="hdlist1
">
8988 notes.<name>.mergeStrategy
8992 Which merge strategy to choose when doing a notes merge into
8993 refs/notes/<name>. This overrides the more general
8994 "notes.mergeStrategy
". See the "NOTES MERGE STRATEGIES
" section in
8995 <a href="git-notes.html
">git-notes(1)</a> for more information on the available strategies.
8998 <dt class="hdlist1
">
9003 Which ref (or refs, if a glob or specified more than once), in
9004 addition to the default set by <code>core.notesRef</code> or
9005 <code>GIT_NOTES_REF</code>, to read notes from when showing commit
9006 messages with the <em>git log</em> family of commands.
9008 <div class="paragraph
"><p>This setting can be overridden with the <code>GIT_NOTES_DISPLAY_REF</code>
9009 environment variable, which must be a colon separated list of refs or
9011 <div class="paragraph
"><p>A warning will be issued for refs that do not exist,
9012 but a glob that does not match any refs is silently ignored.</p></div>
9013 <div class="paragraph
"><p>This setting can be disabled by the <code>--no-notes</code> option to the <em>git
9014 log</em> family of commands, or by the <code>--notes=<ref></code> option accepted by
9015 those commands.</p></div>
9016 <div class="paragraph
"><p>The effective value of "core.notesRef
" (possibly overridden by
9017 GIT_NOTES_REF) is also implicitly added to the list of refs to be
9018 displayed.</p></div>
9020 <dt class="hdlist1
">
9021 notes.rewrite.<command>
9025 When rewriting commits with <command> (currently <code>amend</code> or
9026 <code>rebase</code>), if this variable is <code>false</code>, git will not copy
9027 notes from the original to the rewritten commit. Defaults to
9028 <code>true</code>. See also "<code>notes.rewriteRef
</code>" below.
9030 <div class="paragraph
"><p>This setting can be overridden with the <code>GIT_NOTES_REWRITE_REF</code>
9031 environment variable, which must be a colon separated list of refs or
9034 <dt class="hdlist1
">
9039 When copying notes during a rewrite (see the
9040 "notes.rewrite.
<command
>" option), determines what to do if
9041 the target commit already has a note. Must be one of
9042 <code>overwrite</code>, <code>concatenate</code>, <code>cat_sort_uniq</code>, or <code>ignore</code>.
9043 Defaults to <code>concatenate</code>.
9045 <div class="paragraph
"><p>This setting can be overridden with the <code>GIT_NOTES_REWRITE_MODE</code>
9046 environment variable.</p></div>
9048 <dt class="hdlist1
">
9053 When copying notes during a rewrite, specifies the (fully
9054 qualified) ref whose notes should be copied. May be a glob,
9055 in which case notes in all matching refs will be copied. You
9056 may also specify this configuration several times.
9058 <div class="paragraph
"><p>Does not have a default value; you must configure this variable to
9059 enable note rewriting. Set it to <code>refs/notes/commits</code> to enable
9060 rewriting for the default commit notes.</p></div>
9061 <div class="paragraph
"><p>Can be overridden with the <code>GIT_NOTES_REWRITE_REF</code> environment variable.
9062 See <code>notes.rewrite.<command></code> above for a further description of its format.</p></div>
9064 <dt class="hdlist1
">
9069 The size of the window used by <a href="git-pack-objects.html
">git-pack-objects(1)</a> when no
9070 window size is given on the command line. Defaults to 10.
9073 <dt class="hdlist1
">
9078 The maximum delta depth used by <a href="git-pack-objects.html
">git-pack-objects(1)</a> when no
9079 maximum depth is given on the command line. Defaults to 50.
9080 Maximum value is 4095.
9083 <dt class="hdlist1
">
9088 The maximum size of memory that is consumed by each thread
9089 in <a href="git-pack-objects.html
">git-pack-objects(1)</a> for pack window memory when
9090 no limit is given on the command line. The value can be
9091 suffixed with "k
", "m
", or "g
". When left unconfigured (or
9092 set explicitly to 0), there will be no limit.
9095 <dt class="hdlist1
">
9100 An integer -1..9, indicating the compression level for objects
9101 in a pack file. -1 is the zlib default. 0 means no
9102 compression, and 1..9 are various speed/size tradeoffs, 9 being
9103 slowest. If not set, defaults to core.compression. If that is
9104 not set, defaults to -1, the zlib default, which is "a default
9105 compromise between speed and compression (currently equivalent
9108 <div class="paragraph
"><p>Note that changing the compression level will not automatically recompress
9109 all existing objects. You can force recompression by passing the -F option
9110 to <a href="git-repack.html
">git-repack(1)</a>.</p></div>
9112 <dt class="hdlist1
">
9117 When true or "single
", and when reachability bitmaps are
9118 enabled, pack-objects will try to send parts of the bitmapped
9119 packfile verbatim. When "multi
", and when a multi-pack
9120 reachability bitmap is available, pack-objects will try to send
9121 parts of all packs in the MIDX.
9123 <div class="paragraph
"><p>If only a single pack bitmap is available, and <code>pack.allowPackReuse</code>
9124 is set to "multi
", reuse parts of just the bitmapped packfile. This
9125 can reduce memory and CPU usage to serve fetches, but might result in
9126 sending a slightly larger pack. Defaults to true.</p></div>
9128 <dt class="hdlist1
">
9133 An extended regular expression configuring a set of delta
9134 islands. See "DELTA ISLANDS
" in <a href="git-pack-objects.html
">git-pack-objects(1)</a>
9138 <dt class="hdlist1
">
9143 Specify an island name which gets to have its objects be
9144 packed first. This creates a kind of pseudo-pack at the front
9145 of one pack, so that the objects from the specified island are
9146 hopefully faster to copy into any pack that should be served
9147 to a user requesting these objects. In practice this means
9148 that the island specified should likely correspond to what is
9149 the most commonly cloned in the repo. See also "DELTA ISLANDS
"
9150 in <a href="git-pack-objects.html
">git-pack-objects(1)</a>.
9153 <dt class="hdlist1
">
9158 The maximum memory in bytes used for caching deltas in
9159 <a href="git-pack-objects.html
">git-pack-objects(1)</a> before writing them out to a pack.
9160 This cache is used to speed up the writing object phase by not
9161 having to recompute the final delta result once the best match
9162 for all objects is found. Repacking large repositories on machines
9163 which are tight with memory might be badly impacted by this though,
9164 especially if this cache pushes the system into swapping.
9165 A value of 0 means no limit. The smallest size of 1 byte may be
9166 used to virtually disable this cache. Defaults to 256 MiB.
9169 <dt class="hdlist1
">
9170 pack.deltaCacheLimit
9174 The maximum size of a delta, that is cached in
9175 <a href="git-pack-objects.html
">git-pack-objects(1)</a>. This cache is used to speed up the
9176 writing object phase by not having to recompute the final delta
9177 result once the best match for all objects is found.
9178 Defaults to 1000. Maximum value is 65535.
9181 <dt class="hdlist1
">
9186 Specifies the number of threads to spawn when searching for best
9187 delta matches. This requires that <a href="git-pack-objects.html
">git-pack-objects(1)</a>
9188 be compiled with pthreads otherwise this option is ignored with a
9189 warning. This is meant to reduce packing time on multiprocessor
9190 machines. The required amount of memory for the delta search window
9191 is however multiplied by the number of threads.
9192 Specifying 0 will cause Git to auto-detect the number of CPUs
9193 and set the number of threads accordingly.
9196 <dt class="hdlist1
">
9201 Specify the default pack index version. Valid values are 1 for
9202 legacy pack index used by Git versions prior to 1.5.2, and 2 for
9203 the new pack index with capabilities for packs larger than 4 GB
9204 as well as proper protection against the repacking of corrupted
9205 packs. Version 2 is the default. Note that version 2 is enforced
9206 and this config option is ignored whenever the corresponding pack is
9209 <div class="paragraph
"><p>If you have an old Git that does not understand the version 2 <code>*.idx</code> file,
9210 cloning or fetching over a non-native protocol (e.g. "http
")
9211 that will copy both <code>*.pack</code> file and corresponding <code>*.idx</code> file from the
9212 other side may give you a repository that cannot be accessed with your
9213 older version of Git. If the <code>*.pack</code> file is smaller than 2 GB, however,
9214 you can use <a href="git-index-pack.html
">git-index-pack(1)</a> on the *.pack file to regenerate
9215 the <code>*.idx</code> file.</p></div>
9217 <dt class="hdlist1
">
9222 The maximum size of a pack. This setting only affects
9223 packing to a file when repacking, i.e. the git:// protocol
9224 is unaffected. It can be overridden by the <code>--max-pack-size</code>
9225 option of <a href="git-repack.html
">git-repack(1)</a>. Reaching this limit results
9226 in the creation of multiple packfiles.
9228 <div class="paragraph
"><p>Note that this option is rarely useful, and may result in a larger total
9229 on-disk size (because Git will not store deltas between packs) and
9230 worse runtime performance (object lookup within multiple packs is
9231 slower than a single pack, and optimizations like reachability bitmaps
9232 cannot cope with multiple packs).</p></div>
9233 <div class="paragraph
"><p>If you need to actively run Git using smaller packfiles (e.g., because your
9234 filesystem does not support large files), this option may help. But if
9235 your goal is to transmit a packfile over a medium that supports limited
9236 sizes (e.g., removable media that cannot store the whole repository),
9237 you are likely better off creating a single large packfile and splitting
9238 it using a generic multi-volume archive tool (e.g., Unix <code>split</code>).</p></div>
9239 <div class="paragraph
"><p>The minimum size allowed is limited to 1 MiB. The default is unlimited.
9240 Common unit suffixes of <em>k</em>, <em>m</em>, or <em>g</em> are supported.</p></div>
9242 <dt class="hdlist1
">
9247 When true, git will use pack bitmaps (if available) when packing
9248 to stdout (e.g., during the server side of a fetch). Defaults to
9249 true. You should not generally need to turn this off unless
9250 you are debugging pack bitmaps.
9253 <dt class="hdlist1
">
9254 pack.useBitmapBoundaryTraversal
9258 When true, Git will use an experimental algorithm for computing
9259 reachability queries with bitmaps. Instead of building up
9260 complete bitmaps for all of the negated tips and then OR-ing
9261 them together, consider negated tips with existing bitmaps as
9262 additive (i.e. OR-ing them into the result if they exist,
9263 ignoring them otherwise), and build up a bitmap at the boundary
9266 <div class="paragraph
"><p>When using this algorithm, Git may include too many objects as a result
9267 of not opening up trees belonging to certain UNINTERESTING commits. This
9268 inexactness matches the non-bitmap traversal algorithm.</p></div>
9269 <div class="paragraph
"><p>In many cases, this can provide a speed-up over the exact algorithm,
9270 particularly when there is poor bitmap coverage of the negated side of
9271 the query.</p></div>
9273 <dt class="hdlist1
">
9278 When true, git will default to using the <em>--sparse</em> option in
9279 <em>git pack-objects</em> when the <em>--revs</em> option is present. This
9280 algorithm only walks trees that appear in paths that introduce new
9281 objects. This can have significant performance benefits when
9282 computing a pack to send a small change. However, it is possible
9283 that extra objects are added to the pack-file if the included
9284 commits contain certain types of direct renames. Default is
9288 <dt class="hdlist1
">
9289 pack.preferBitmapTips
9293 When selecting which commits will receive bitmaps, prefer a
9294 commit at the tip of any reference that is a suffix of any value
9295 of this configuration over any other commits in the "selection
9298 <div class="paragraph
"><p>Note that setting this configuration to <code>refs/foo</code> does not mean that
9299 the commits at the tips of <code>refs/foo/bar</code> and <code>refs/foo/baz</code> will
9300 necessarily be selected. This is because commits are selected for
9301 bitmaps from within a series of windows of variable length.</p></div>
9302 <div class="paragraph
"><p>If a commit at the tip of any reference which is a suffix of any value
9303 of this configuration is seen in a window, it is immediately given
9304 preference over any other commit in that window.</p></div>
9306 <dt class="hdlist1
">
9307 pack.writeBitmaps (deprecated)
9311 This is a deprecated synonym for <code>repack.writeBitmaps</code>.
9314 <dt class="hdlist1
">
9315 pack.writeBitmapHashCache
9319 When true, git will include a "hash cache
" section in the bitmap
9320 index (if one is written). This cache can be used to feed git’s
9321 delta heuristics, potentially leading to better deltas between
9322 bitmapped and non-bitmapped objects (e.g., when serving a fetch
9323 between an older, bitmapped pack and objects that have been
9324 pushed since the last gc). The downside is that it consumes 4
9325 bytes per object of disk space. Defaults to true.
9327 <div class="paragraph
"><p>When writing a multi-pack reachability bitmap, no new namehashes are
9328 computed; instead, any namehashes stored in an existing bitmap are
9329 permuted into their appropriate location when writing a new bitmap.</p></div>
9331 <dt class="hdlist1
">
9332 pack.writeBitmapLookupTable
9336 When true, Git will include a "lookup table
" section in the
9337 bitmap index (if one is written). This table is used to defer
9338 loading individual bitmaps as late as possible. This can be
9339 beneficial in repositories that have relatively large bitmap
9340 indexes. Defaults to false.
9343 <dt class="hdlist1
">
9344 pack.readReverseIndex
9348 When true, git will read any .rev file(s) that may be available
9349 (see: <a href="gitformat-pack.html
">gitformat-pack(5)</a>). When false, the reverse index
9350 will be generated from scratch and stored in memory. Defaults to
9354 <dt class="hdlist1
">
9355 pack.writeReverseIndex
9359 When true, git will write a corresponding .rev file (see:
9360 <a href="gitformat-pack.html
">gitformat-pack(5)</a>)
9361 for each new packfile that it writes in all places except for
9362 <a href="git-fast-import.html
">git-fast-import(1)</a> and in the bulk checkin mechanism.
9366 <dt class="hdlist1
">
9371 If the value is boolean, turns on or off pagination of the
9372 output of a particular Git subcommand when writing to a tty.
9373 Otherwise, turns on pagination for the subcommand using the
9374 pager specified by the value of <code>pager.<cmd></code>. If <code>--paginate</code>
9375 or <code>--no-pager</code> is specified on the command line, it takes
9376 precedence over this option. To disable pagination for all
9377 commands, set <code>core.pager</code> or <code>GIT_PAGER</code> to <code>cat</code>.
9380 <dt class="hdlist1
">
9385 Alias for a --pretty= format string, as specified in
9386 <a href="git-log.html
">git-log(1)</a>. Any aliases defined here can be used just
9387 as the built-in pretty formats could. For example,
9388 running <code>git config pretty.changelog "format:* %H %s
"</code>
9389 would cause the invocation <code>git log --pretty=changelog</code>
9390 to be equivalent to running <code>git log "--pretty=format:* %H %s
"</code>.
9391 Note that an alias with the same name as a built-in format
9392 will be silently ignored.
9395 <dt class="hdlist1
">
9400 If set, provide a user defined default policy for all protocols which
9401 don’t explicitly have a policy (<code>protocol.<name>.allow</code>). By default,
9402 if unset, known-safe protocols (http, https, git, ssh) have a
9403 default policy of <code>always</code>, known-dangerous protocols (ext) have a
9404 default policy of <code>never</code>, and all other protocols (including file)
9405 have a default policy of <code>user</code>. Supported policies:
9407 <div class="openblock
">
9408 <div class="content
">
9409 <div class="ulist
"><ul>
9412 <code>always</code> - protocol is always able to be used.
9417 <code>never</code> - protocol is never able to be used.
9422 <code>user</code> - protocol is only able to be used when <code>GIT_PROTOCOL_FROM_USER</code> is
9423 either unset or has a value of 1. This policy should be used when you want a
9424 protocol to be directly usable by the user but don’t want it used by commands which
9425 execute clone/fetch/push commands without user input, e.g. recursive
9426 submodule initialization.
9432 <dt class="hdlist1
">
9433 protocol.<name>.allow
9437 Set a policy to be used by protocol <code><name></code> with clone/fetch/push
9438 commands. See <code>protocol.allow</code> above for the available policies.
9440 <div class="paragraph
"><p>The protocol names currently used by git are:</p></div>
9441 <div class="openblock
">
9442 <div class="content
">
9443 <div class="ulist
"><ul>
9446 <code>file</code>: any local file-based path (including <code>file://</code> URLs,
9452 <code>git</code>: the anonymous git protocol over a direct TCP
9453 connection (or proxy, if configured)
9458 <code>ssh</code>: git over ssh (including <code>host:path</code> syntax,
9459 <code>ssh://</code>, etc).
9464 <code>http</code>: git over http, both "smart http
" and "dumb http
".
9465 Note that this does <em>not</em> include <code>https</code>; if you want to configure
9466 both, you must do so individually.
9471 any external helpers are named by their protocol (e.g., use
9472 <code>hg</code> to allow the <code>git-remote-hg</code> helper)
9478 <dt class="hdlist1
">
9483 If set, clients will attempt to communicate with a server
9484 using the specified protocol version. If the server does
9485 not support it, communication falls back to version 0.
9486 If unset, the default is <code>2</code>.
9489 <div class="openblock
">
9490 <div class="content
">
9491 <div class="ulist
"><ul>
9494 <code>0</code> - the original wire protocol.
9499 <code>1</code> - the original wire protocol with the addition of a version string
9500 in the initial response from the server.
9505 <code>2</code> - Wire protocol version 2, see <a href="gitprotocol-v2.html
">gitprotocol-v2(5)</a>.
9511 <dt class="hdlist1
">
9516 By default, Git does not create an extra merge commit when merging
9517 a commit that is a descendant of the current commit. Instead, the
9518 tip of the current branch is fast-forwarded. When set to <code>false</code>,
9519 this variable tells Git to create an extra merge commit in such
9520 a case (equivalent to giving the <code>--no-ff</code> option from the command
9521 line). When set to <code>only</code>, only such fast-forward merges are
9522 allowed (equivalent to giving the <code>--ff-only</code> option from the
9523 command line). This setting overrides <code>merge.ff</code> when pulling.
9526 <dt class="hdlist1
">
9531 When true, rebase branches on top of the fetched branch, instead
9532 of merging the default branch from the default remote when "git
9533 pull
" is run. See "branch.
<name
>.rebase
" for setting this on a
9536 <div class="paragraph
"><p>When <code>merges</code> (or just <em>m</em>), pass the <code>--rebase-merges</code> option to <em>git rebase</em>
9537 so that the local merge commits are included in the rebase (see
9538 <a href="git-rebase.html
">git-rebase(1)</a> for details).</p></div>
9539 <div class="paragraph
"><p>When the value is <code>interactive</code> (or just <em>i</em>), the rebase is run in interactive
9541 <div class="paragraph
"><p><strong>NOTE</strong>: this is a possibly dangerous operation; do <strong>not</strong> use
9542 it unless you understand the implications (see <a href="git-rebase.html
">git-rebase(1)</a>
9543 for details).</p></div>
9545 <dt class="hdlist1
">
9550 The default merge strategy to use when pulling multiple branches
9554 <dt class="hdlist1
">
9559 The default merge strategy to use when pulling a single branch.
9562 <dt class="hdlist1
">
9563 push.autoSetupRemote
9567 If set to "true
" assume <code>--set-upstream</code> on default push when no
9568 upstream tracking exists for the current branch; this option
9569 takes effect with push.default options <em>simple</em>, <em>upstream</em>,
9570 and <em>current</em>. It is useful if by default you want new branches
9571 to be pushed to the default remote (like the behavior of
9572 <em>push.default=current</em>) and you also want the upstream tracking
9573 to be set. Workflows most likely to benefit from this option are
9574 <em>simple</em> central workflows where all branches are expected to
9575 have the same name on the remote.
9578 <dt class="hdlist1
">
9583 Defines the action <code>git push</code> should take if no refspec is
9584 given (whether from the command-line, config, or elsewhere).
9585 Different values are well-suited for
9586 specific workflows; for instance, in a purely central workflow
9587 (i.e. the fetch source is equal to the push destination),
9588 <code>upstream</code> is probably what you want. Possible values are:
9590 <div class="openblock
">
9591 <div class="content
">
9592 <div class="ulist
"><ul>
9595 <code>nothing</code> - do not push anything (error out) unless a refspec is
9596 given. This is primarily meant for people who want to
9597 avoid mistakes by always being explicit.
9602 <code>current</code> - push the current branch to update a branch with the same
9603 name on the receiving end. Works in both central and non-central
9609 <code>upstream</code> - push the current branch back to the branch whose
9610 changes are usually integrated into the current branch (which is
9611 called <code>@{upstream}</code>). This mode only makes sense if you are
9612 pushing to the same repository you would normally pull from
9613 (i.e. central workflow).
9618 <code>tracking</code> - This is a deprecated synonym for <code>upstream</code>.
9623 <code>simple</code> - push the current branch with the same name on the remote.
9625 <div class="paragraph
"><p>If you are working on a centralized workflow (pushing to the same repository you
9626 pull from, which is typically <code>origin</code>), then you need to configure an upstream
9627 branch with the same name.</p></div>
9628 <div class="paragraph
"><p>This mode is the default since Git 2.0, and is the safest option suited for
9629 beginners.</p></div>
9633 <code>matching</code> - push all branches having the same name on both ends.
9634 This makes the repository you are pushing to remember the set of
9635 branches that will be pushed out (e.g. if you always push <em>maint</em>
9636 and <em>master</em> there and no other branches, the repository you push
9637 to will have these two branches, and your local <em>maint</em> and
9638 <em>master</em> will be pushed there).
9640 <div class="paragraph
"><p>To use this mode effectively, you have to make sure <em>all</em> the
9641 branches you would push out are ready to be pushed out before
9642 running <em>git push</em>, as the whole point of this mode is to allow you
9643 to push all of the branches in one go. If you usually finish work
9644 on only one branch and push out the result, while other branches are
9645 unfinished, this mode is not for you. Also this mode is not
9646 suitable for pushing into a shared central repository, as other
9647 people may add new branches there, or update the tip of existing
9648 branches outside your control.</p></div>
9649 <div class="paragraph
"><p>This used to be the default, but not since Git 2.0 (<code>simple</code> is the
9650 new default).</p></div>
9655 <dt class="hdlist1
">
9660 If set to true, enable <code>--follow-tags</code> option by default. You
9661 may override this configuration at time of push by specifying
9662 <code>--no-follow-tags</code>.
9665 <dt class="hdlist1
">
9670 May be set to a boolean value, or the string <em>if-asked</em>. A true
9671 value causes all pushes to be GPG signed, as if <code>--signed</code> is
9672 passed to <a href="git-push.html
">git-push(1)</a>. The string <em>if-asked</em> causes
9673 pushes to be signed if the server supports it, as if
9674 <code>--signed=if-asked</code> is passed to <em>git push</em>. A false value may
9675 override a value from a lower-priority config file. An explicit
9676 command-line flag always overrides this config option.
9679 <dt class="hdlist1
">
9684 When no <code>--push-option=<option></code> argument is given from the
9685 command line, <code>git push</code> behaves as if each <value> of
9686 this variable is given as <code>--push-option=<value></code>.
9688 <div class="paragraph
"><p>This is a multi-valued variable, and an empty value can be used in a
9689 higher priority configuration file (e.g. <code>.git/config</code> in a
9690 repository) to clear the values inherited from a lower priority
9691 configuration files (e.g. <code>$HOME/.gitconfig</code>).</p></div>
9692 <div class="listingblock
">
9693 <div class="content
">
9707 This will result in only b (a and c are cleared).</code></pre>
9710 <dt class="hdlist1
">
9711 push.recurseSubmodules
9715 May be "check
", "on-demand
", "only
", or "no
", with the same behavior
9716 as that of "push --recurse-submodules
".
9717 If not set, <em>no</em> is used by default, unless <em>submodule.recurse</em> is
9718 set (in which case a <em>true</em> value means <em>on-demand</em>).
9721 <dt class="hdlist1
">
9722 push.useForceIfIncludes
9726 If set to "true
", it is equivalent to specifying
9727 <code>--force-if-includes</code> as an option to <a href="git-push.html
">git-push(1)</a>
9728 in the command line. Adding <code>--no-force-if-includes</code> at the
9729 time of push overrides this configuration setting.
9732 <dt class="hdlist1
">
9737 If set to "true
", attempt to reduce the size of the packfile
9738 sent by rounds of negotiation in which the client and the
9739 server attempt to find commits in common. If "false
", Git will
9740 rely solely on the server’s ref advertisement to find commits
9744 <dt class="hdlist1
">
9749 If set to "false
", disable use of bitmaps for "git push
" even if
9750 <code>pack.useBitmaps</code> is "true
", without preventing other git operations
9751 from using bitmaps. Default is true.
9754 <dt class="hdlist1
">
9759 Default backend to use for rebasing. Possible choices are
9760 <em>apply</em> or <em>merge</em>. In the future, if the merge backend gains
9761 all remaining capabilities of the apply backend, this setting
9765 <dt class="hdlist1
">
9770 Whether to show a diffstat of what changed upstream since the last
9771 rebase. False by default.
9774 <dt class="hdlist1
">
9779 If set to true, enable the <code>--autosquash</code> option of
9780 <a href="git-rebase.html
">git-rebase(1)</a> by default for interactive mode.
9781 This can be overridden with the <code>--no-autosquash</code> option.
9784 <dt class="hdlist1
">
9789 When set to true, automatically create a temporary stash entry
9790 before the operation begins, and apply it after the operation
9791 ends. This means that you can run rebase on a dirty worktree.
9792 However, use with care: the final stash application after a
9793 successful rebase might result in non-trivial conflicts.
9794 This option can be overridden by the <code>--no-autostash</code> and
9795 <code>--autostash</code> options of <a href="git-rebase.html
">git-rebase(1)</a>.
9799 <dt class="hdlist1
">
9804 If set to true enable <code>--update-refs</code> option by default.
9807 <dt class="hdlist1
">
9808 rebase.missingCommitsCheck
9812 If set to "warn
", git rebase -i will print a warning if some
9813 commits are removed (e.g. a line was deleted), however the
9814 rebase will still proceed. If set to "error
", it will print
9815 the previous warning and stop the rebase, <em>git rebase
9816 --edit-todo</em> can then be used to correct the error. If set to
9817 "ignore
", no checking is done.
9818 To drop a commit without warning or error, use the <code>drop</code>
9819 command in the todo list.
9820 Defaults to "ignore
".
9823 <dt class="hdlist1
">
9824 rebase.instructionFormat
9828 A format string, as specified in <a href="git-log.html
">git-log(1)</a>, to be used for the
9829 todo list during an interactive rebase. The format will
9830 automatically have the commit hash prepended to the format.
9833 <dt class="hdlist1
">
9834 rebase.abbreviateCommands
9838 If set to true, <code>git rebase</code> will use abbreviated command names in the
9839 todo list resulting in something like this:
9841 <div class="listingblock
">
9842 <div class="content
">
9843 <pre><code> p deadbee The oneline of the commit
9844 p fa1afe1 The oneline of the next commit
9847 <div class="paragraph
"><p>instead of:</p></div>
9848 <div class="listingblock
">
9849 <div class="content
">
9850 <pre><code> pick deadbee The oneline of the commit
9851 pick fa1afe1 The oneline of the next commit
9854 <div class="paragraph
"><p>Defaults to false.</p></div>
9856 <dt class="hdlist1
">
9857 rebase.rescheduleFailedExec
9861 Automatically reschedule <code>exec</code> commands that failed. This only makes
9862 sense in interactive mode (or when an <code>--exec</code> option was provided).
9863 This is the same as specifying the <code>--reschedule-failed-exec</code> option.
9866 <dt class="hdlist1
">
9871 If set to false set <code>--no-fork-point</code> option by default.
9874 <dt class="hdlist1
">
9879 Whether and how to set the <code>--rebase-merges</code> option by default. Can
9880 be <code>rebase-cousins</code>, <code>no-rebase-cousins</code>, or a boolean. Setting to
9881 true or to <code>no-rebase-cousins</code> is equivalent to
9882 <code>--rebase-merges=no-rebase-cousins</code>, setting to <code>rebase-cousins</code> is
9883 equivalent to <code>--rebase-merges=rebase-cousins</code>, and setting to false is
9884 equivalent to <code>--no-rebase-merges</code>. Passing <code>--rebase-merges</code> on the
9885 command line, with or without an argument, overrides any
9886 <code>rebase.rebaseMerges</code> configuration.
9889 <dt class="hdlist1
">
9890 rebase.maxLabelLength
9894 When generating label names from commit subjects, truncate the names to
9895 this length. By default, the names are truncated to a little less than
9896 <code>NAME_MAX</code> (to allow e.g. <code>.lock</code> files to be written for the
9897 corresponding loose refs).
9900 <dt class="hdlist1
">
9901 receive.advertiseAtomic
9905 By default, git-receive-pack will advertise the atomic push
9906 capability to its clients. If you don’t want to advertise this
9907 capability, set this variable to false.
9910 <dt class="hdlist1
">
9911 receive.advertisePushOptions
9915 When set to true, git-receive-pack will advertise the push options
9916 capability to its clients. False by default.
9919 <dt class="hdlist1
">
9924 By default, git-receive-pack will run "git-gc --auto
" after
9925 receiving data from git-push and updating refs. You can stop
9926 it by setting this variable to false.
9929 <dt class="hdlist1
">
9930 receive.certNonceSeed
9934 By setting this variable to a string, <code>git receive-pack</code>
9935 will accept a <code>git push --signed</code> and verify it by using
9936 a "nonce
" protected by HMAC using this string as a secret
9940 <dt class="hdlist1
">
9941 receive.certNonceSlop
9945 When a <code>git push --signed</code> sends a push certificate with a
9946 "nonce
" that was issued by a receive-pack serving the same
9947 repository within this many seconds, export the "nonce
"
9948 found in the certificate to <code>GIT_PUSH_CERT_NONCE</code> to the
9949 hooks (instead of what the receive-pack asked the sending
9950 side to include). This may allow writing checks in
9951 <code>pre-receive</code> and <code>post-receive</code> a bit easier. Instead of
9952 checking <code>GIT_PUSH_CERT_NONCE_SLOP</code> environment variable
9953 that records by how many seconds the nonce is stale to
9954 decide if they want to accept the certificate, they only
9955 can check <code>GIT_PUSH_CERT_NONCE_STATUS</code> is <code>OK</code>.
9958 <dt class="hdlist1
">
9963 If it is set to true, git-receive-pack will check all received
9964 objects. See <code>transfer.fsckObjects</code> for what’s checked.
9965 Defaults to false. If not set, the value of
9966 <code>transfer.fsckObjects</code> is used instead.
9969 <dt class="hdlist1
">
9970 receive.fsck.<msg-id>
9974 Acts like <code>fsck.<msg-id></code>, but is used by
9975 <a href="git-receive-pack.html
">git-receive-pack(1)</a> instead of
9976 <a href="git-fsck.html
">git-fsck(1)</a>. See the <code>fsck.<msg-id></code> documentation for
9980 <dt class="hdlist1
">
9981 receive.fsck.skipList
9985 Acts like <code>fsck.skipList</code>, but is used by
9986 <a href="git-receive-pack.html
">git-receive-pack(1)</a> instead of
9987 <a href="git-fsck.html
">git-fsck(1)</a>. See the <code>fsck.skipList</code> documentation for
9991 <dt class="hdlist1
">
9996 After receiving the pack from the client, <code>receive-pack</code> may
9997 produce no output (if <code>--quiet</code> was specified) while processing
9998 the pack, causing some networks to drop the TCP connection.
9999 With this option set, if <code>receive-pack</code> does not transmit
10000 any data in this phase for <code>receive.keepAlive</code> seconds, it will
10001 send a short keepalive packet. The default is 5 seconds; set
10002 to 0 to disable keepalives entirely.
10005 <dt class="hdlist1
">
10006 receive.unpackLimit
10010 If the number of objects received in a push is below this
10011 limit then the objects will be unpacked into loose object
10012 files. However if the number of received objects equals or
10013 exceeds this limit then the received pack will be stored as
10014 a pack, after adding any missing delta bases. Storing the
10015 pack from a push can make the push operation complete faster,
10016 especially on slow filesystems. If not set, the value of
10017 <code>transfer.unpackLimit</code> is used instead.
10020 <dt class="hdlist1
">
10021 receive.maxInputSize
10025 If the size of the incoming pack stream is larger than this
10026 limit, then git-receive-pack will error out, instead of
10027 accepting the pack file. If not set or set to 0, then the size
10031 <dt class="hdlist1
">
10032 receive.denyDeletes
10036 If set to true, git-receive-pack will deny a ref update that deletes
10037 the ref. Use this to prevent such a ref deletion via a push.
10040 <dt class="hdlist1
">
10041 receive.denyDeleteCurrent
10045 If set to true, git-receive-pack will deny a ref update that
10046 deletes the currently checked out branch of a non-bare repository.
10049 <dt class="hdlist1
">
10050 receive.denyCurrentBranch
10054 If set to true or "refuse
", git-receive-pack will deny a ref update
10055 to the currently checked out branch of a non-bare repository.
10056 Such a push is potentially dangerous because it brings the HEAD
10057 out of sync with the index and working tree. If set to "warn
",
10058 print a warning of such a push to stderr, but allow the push to
10059 proceed. If set to false or "ignore
", allow such pushes with no
10060 message. Defaults to "refuse
".
10062 <div class="paragraph
"><p>Another option is "updateInstead
" which will update the working
10063 tree if pushing into the current branch. This option is
10064 intended for synchronizing working directories when one side is not easily
10065 accessible via interactive ssh (e.g. a live web site, hence the requirement
10066 that the working directory be clean). This mode also comes in handy when
10067 developing inside a VM to test and fix code on different Operating Systems.</p></div>
10068 <div class="paragraph
"><p>By default, "updateInstead
" will refuse the push if the working tree or
10069 the index have any difference from the HEAD, but the <code>push-to-checkout</code>
10070 hook can be used to customize this. See <a href="githooks.html
">githooks(5)</a>.</p></div>
10072 <dt class="hdlist1
">
10073 receive.denyNonFastForwards
10077 If set to true, git-receive-pack will deny a ref update which is
10078 not a fast-forward. Use this to prevent such an update via a push,
10079 even if that push is forced. This configuration variable is
10080 set when initializing a shared repository.
10083 <dt class="hdlist1
">
10088 This variable is the same as <code>transfer.hideRefs</code>, but applies
10089 only to <code>receive-pack</code> (and so affects pushes, but not fetches).
10090 An attempt to update or delete a hidden ref by <code>git push</code> is
10094 <dt class="hdlist1
">
10095 receive.procReceiveRefs
10099 This is a multi-valued variable that defines reference prefixes
10100 to match the commands in <code>receive-pack</code>. Commands matching the
10101 prefixes will be executed by an external hook "proc-receive
",
10102 instead of the internal <code>execute_commands</code> function. If this
10103 variable is not defined, the "proc-receive
" hook will never be
10104 used, and all commands will be executed by the internal
10105 <code>execute_commands</code> function.
10107 <div class="paragraph
"><p>For example, if this variable is set to "refs/for
", pushing to reference
10108 such as "refs/for/master
" will not create or update a reference named
10109 "refs/for/master
", but may create or update a pull request directly by
10110 running the hook "proc-receive
".</p></div>
10111 <div class="paragraph
"><p>Optional modifiers can be provided in the beginning of the value to filter
10112 commands for specific actions: create (a), modify (m), delete (d).
10113 A <code>!</code> can be included in the modifiers to negate the reference prefix entry.
10115 <div class="literalblock
">
10116 <div class="content
">
10117 <pre><code>git config --system --add receive.procReceiveRefs ad:refs/heads
10118 git config --system --add receive.procReceiveRefs !:refs/heads</code></pre>
10121 <dt class="hdlist1
">
10122 receive.updateServerInfo
10126 If set to true, git-receive-pack will run git-update-server-info
10127 after receiving data from git-push and updating refs.
10130 <dt class="hdlist1
">
10131 receive.shallowUpdate
10135 If set to true, .git/shallow can be updated when new refs
10136 require new shallow roots. Otherwise those refs are rejected.
10139 <dt class="hdlist1
">
10144 The remote to push to by default. Overrides
10145 <code>branch.<name>.remote</code> for all branches, and is overridden by
10146 <code>branch.<name>.pushRemote</code> for specific branches.
10149 <dt class="hdlist1
">
10150 remote.<name>.url
10154 The URL of a remote repository. See <a href="git-fetch.html
">git-fetch(1)</a> or
10155 <a href="git-push.html
">git-push(1)</a>.
10158 <dt class="hdlist1
">
10159 remote.<name>.pushurl
10163 The push URL of a remote repository. See <a href="git-push.html
">git-push(1)</a>.
10166 <dt class="hdlist1
">
10167 remote.<name>.proxy
10171 For remotes that require curl (http, https and ftp), the URL to
10172 the proxy to use for that remote. Set to the empty string to
10173 disable proxying for that remote.
10176 <dt class="hdlist1
">
10177 remote.<name>.proxyAuthMethod
10181 For remotes that require curl (http, https and ftp), the method to use for
10182 authenticating against the proxy in use (probably set in
10183 <code>remote.<name>.proxy</code>). See <code>http.proxyAuthMethod</code>.
10186 <dt class="hdlist1
">
10187 remote.<name>.fetch
10191 The default set of "refspec
" for <a href="git-fetch.html
">git-fetch(1)</a>. See
10192 <a href="git-fetch.html
">git-fetch(1)</a>.
10195 <dt class="hdlist1
">
10196 remote.<name>.push
10200 The default set of "refspec
" for <a href="git-push.html
">git-push(1)</a>. See
10201 <a href="git-push.html
">git-push(1)</a>.
10204 <dt class="hdlist1
">
10205 remote.<name>.mirror
10209 If true, pushing to this remote will automatically behave
10210 as if the <code>--mirror</code> option was given on the command line.
10213 <dt class="hdlist1
">
10214 remote.<name>.skipDefaultUpdate
10218 If true, this remote will be skipped by default when updating
10219 using <a href="git-fetch.html
">git-fetch(1)</a> or the <code>update</code> subcommand of
10220 <a href="git-remote.html
">git-remote(1)</a>.
10223 <dt class="hdlist1
">
10224 remote.<name>.skipFetchAll
10228 If true, this remote will be skipped by default when updating
10229 using <a href="git-fetch.html
">git-fetch(1)</a> or the <code>update</code> subcommand of
10230 <a href="git-remote.html
">git-remote(1)</a>.
10233 <dt class="hdlist1
">
10234 remote.<name>.receivepack
10238 The default program to execute on the remote side when pushing. See
10239 option --receive-pack of <a href="git-push.html
">git-push(1)</a>.
10242 <dt class="hdlist1
">
10243 remote.<name>.uploadpack
10247 The default program to execute on the remote side when fetching. See
10248 option --upload-pack of <a href="git-fetch-pack.html
">git-fetch-pack(1)</a>.
10251 <dt class="hdlist1
">
10252 remote.<name>.tagOpt
10256 Setting this value to --no-tags disables automatic tag following when
10257 fetching from remote <name>. Setting it to --tags will fetch every
10258 tag from remote <name>, even if they are not reachable from remote
10259 branch heads. Passing these flags directly to <a href="git-fetch.html
">git-fetch(1)</a> can
10260 override this setting. See options --tags and --no-tags of
10261 <a href="git-fetch.html
">git-fetch(1)</a>.
10264 <dt class="hdlist1
">
10265 remote.<name>.vcs
10269 Setting this to a value <vcs> will cause Git to interact with
10270 the remote with the git-remote-<vcs> helper.
10273 <dt class="hdlist1
">
10274 remote.<name>.prune
10278 When set to true, fetching from this remote by default will also
10279 remove any remote-tracking references that no longer exist on the
10280 remote (as if the <code>--prune</code> option was given on the command line).
10281 Overrides <code>fetch.prune</code> settings, if any.
10284 <dt class="hdlist1
">
10285 remote.<name>.pruneTags
10289 When set to true, fetching from this remote by default will also
10290 remove any local tags that no longer exist on the remote if pruning
10291 is activated in general via <code>remote.<name>.prune</code>, <code>fetch.prune</code> or
10292 <code>--prune</code>. Overrides <code>fetch.pruneTags</code> settings, if any.
10294 <div class="paragraph
"><p>See also <code>remote.<name>.prune</code> and the PRUNING section of
10295 <a href="git-fetch.html
">git-fetch(1)</a>.</p></div>
10297 <dt class="hdlist1
">
10298 remote.<name>.promisor
10302 When set to true, this remote will be used to fetch promisor
10306 <dt class="hdlist1
">
10307 remote.<name>.partialclonefilter
10311 The filter that will be applied when fetching from this promisor remote.
10312 Changing or clearing this value will only affect fetches for new commits.
10313 To fetch associated objects for commits already present in the local object
10314 database, use the <code>--refetch</code> option of <a href="git-fetch.html
">git-fetch(1)</a>.
10317 <dt class="hdlist1
">
10318 remotes.<group>
10322 The list of remotes which are fetched by "git remote update
10323 <group
>". See <a href="git-remote.html
">git-remote(1)</a>.
10326 <dt class="hdlist1
">
10327 repack.useDeltaBaseOffset
10331 By default, <a href="git-repack.html
">git-repack(1)</a> creates packs that use
10332 delta-base offset. If you need to share your repository with
10333 Git older than version 1.4.4, either directly or via a dumb
10334 protocol such as http, then you need to set this option to
10335 "false
" and repack. Access from old Git versions over the
10336 native protocol are unaffected by this option.
10339 <dt class="hdlist1
">
10340 repack.packKeptObjects
10344 If set to true, makes <code>git repack</code> act as if
10345 <code>--pack-kept-objects</code> was passed. See <a href="git-repack.html
">git-repack(1)</a> for
10346 details. Defaults to <code>false</code> normally, but <code>true</code> if a bitmap
10347 index is being written (either via <code>--write-bitmap-index</code> or
10348 <code>repack.writeBitmaps</code>).
10351 <dt class="hdlist1
">
10352 repack.useDeltaIslands
10356 If set to true, makes <code>git repack</code> act as if <code>--delta-islands</code>
10357 was passed. Defaults to <code>false</code>.
10360 <dt class="hdlist1
">
10361 repack.writeBitmaps
10365 When true, git will write a bitmap index when packing all
10366 objects to disk (e.g., when <code>git repack -a</code> is run). This
10367 index can speed up the "counting objects
" phase of subsequent
10368 packs created for clones and fetches, at the cost of some disk
10369 space and extra time spent on the initial repack. This has
10370 no effect if multiple packfiles are created.
10371 Defaults to true on bare repos, false otherwise.
10374 <dt class="hdlist1
">
10375 repack.updateServerInfo
10379 If set to false, <a href="git-repack.html
">git-repack(1)</a> will not run
10380 <a href="git-update-server-info.html
">git-update-server-info(1)</a>. Defaults to true. Can be overridden
10381 when true by the <code>-n</code> option of <a href="git-repack.html
">git-repack(1)</a>.
10384 <dt class="hdlist1
">
10387 <dt class="hdlist1
">
10388 repack.cruftWindowMemory
10390 <dt class="hdlist1
">
10393 <dt class="hdlist1
">
10394 repack.cruftThreads
10398 Parameters used by <a href="git-pack-objects.html
">git-pack-objects(1)</a> when generating
10399 a cruft pack and the respective parameters are not given over
10400 the command line. See similarly named <code>pack.*</code> configuration
10401 variables for defaults and meaning.
10404 <dt class="hdlist1
">
10409 When set to true, <code>git-rerere</code> updates the index with the
10410 resulting contents after it cleanly resolves conflicts using
10411 previously recorded resolutions. Defaults to false.
10414 <dt class="hdlist1
">
10419 Activate recording of resolved conflicts, so that identical
10420 conflict hunks can be resolved automatically, should they be
10421 encountered again. By default, <a href="git-rerere.html
">git-rerere(1)</a> is
10422 enabled if there is an <code>rr-cache</code> directory under the
10423 <code>$GIT_DIR</code>, e.g. if "rerere
" was previously used in the
10427 <dt class="hdlist1
">
10432 Setting this variable to true makes <code>git revert</code> behave
10433 as if the <code>--reference</code> option is given.
10436 <dt class="hdlist1
">
10437 safe.bareRepository
10441 Specifies which bare repositories Git will work with. The currently
10442 supported values are:
10444 <div class="ulist
"><ul>
10447 <code>all</code>: Git works with all bare repositories. This is the default.
10452 <code>explicit</code>: Git only works with bare repositories specified via
10453 the top-level <code>--git-dir</code> command-line option, or the <code>GIT_DIR</code>
10454 environment variable (see <a href="git.html
">git(1)</a>).
10456 <div class="paragraph
"><p>If you do not use bare repositories in your workflow, then it may be
10457 beneficial to set <code>safe.bareRepository</code> to <code>explicit</code> in your global
10458 config. This will protect you from attacks that involve cloning a
10459 repository that contains a bare repository and running a Git command
10460 within that directory.</p></div>
10461 <div class="paragraph
"><p>This config setting is only respected in protected configuration (see
10462 <a href="#SCOPES
">[SCOPES]</a>). This prevents untrusted repositories from tampering with
10463 this value.</p></div>
10467 <dt class="hdlist1
">
10472 These config entries specify Git-tracked directories that are
10473 considered safe even if they are owned by someone other than the
10474 current user. By default, Git will refuse to even parse a Git
10475 config of a repository owned by someone else, let alone run its
10476 hooks, and this config setting allows users to specify exceptions,
10477 e.g. for intentionally shared repositories (see the <code>--shared</code>
10478 option in <a href="git-init.html
">git-init(1)</a>).
10480 <div class="paragraph
"><p>This is a multi-valued setting, i.e. you can add more than one directory
10481 via <code>git config --add</code>. To reset the list of safe directories (e.g. to
10482 override any such directories specified in the system config), add a
10483 <code>safe.directory</code> entry with an empty value.</p></div>
10484 <div class="paragraph
"><p>This config setting is only respected in protected configuration (see
10485 <a href="#SCOPES
">[SCOPES]</a>). This prevents untrusted repositories from tampering with this
10487 <div class="paragraph
"><p>The value of this setting is interpolated, i.e. <code>~/<path></code> expands to a
10488 path relative to the home directory and <code>%(prefix)/<path></code> expands to a
10489 path relative to Git’s (runtime) prefix.</p></div>
10490 <div class="paragraph
"><p>To completely opt-out of this security check, set <code>safe.directory</code> to the
10491 string <code>*</code>. This will allow all repositories to be treated as if their
10492 directory was listed in the <code>safe.directory</code> list. If <code>safe.directory=*</code>
10493 is set in system config and you want to re-enable this protection, then
10494 initialize your list with an empty value before listing the repositories
10495 that you deem safe.</p></div>
10496 <div class="paragraph
"><p>As explained, Git only allows you to access repositories owned by
10497 yourself, i.e. the user who is running Git, by default. When Git
10498 is running as <em>root</em> in a non Windows platform that provides sudo,
10499 however, git checks the SUDO_UID environment variable that sudo creates
10500 and will allow access to the uid recorded as its value in addition to
10501 the id from <em>root</em>.
10502 This is to make it easy to perform a common sequence during installation
10503 "make
&& sudo make install
". A git process running under <em>sudo</em> runs as
10504 <em>root</em> but the <em>sudo</em> command exports the environment variable to record
10505 which id the original user has.
10506 If that is not what you would prefer and want git to only trust
10507 repositories that are owned by root instead, then you can remove
10508 the <code>SUDO_UID</code> variable from root’s environment before invoking git.</p></div>
10510 <dt class="hdlist1
">
10515 A configuration identity. When given, causes values in the
10516 <em>sendemail.<identity></em> subsection to take precedence over
10517 values in the <em>sendemail</em> section. The default identity is
10518 the value of <code>sendemail.identity</code>.
10521 <dt class="hdlist1
">
10522 sendemail.smtpEncryption
10526 See <a href="git-send-email.html
">git-send-email(1)</a> for description. Note that this
10527 setting is not subject to the <em>identity</em> mechanism.
10530 <dt class="hdlist1
">
10531 sendemail.smtpSSLCertPath
10535 Path to ca-certificates (either a directory or a single file).
10536 Set it to an empty string to disable certificate verification.
10539 <dt class="hdlist1
">
10540 sendemail.<identity>.*
10544 Identity-specific versions of the <em>sendemail.*</em> parameters
10545 found below, taking precedence over those when this
10546 identity is selected, through either the command-line or
10547 <code>sendemail.identity</code>.
10550 <dt class="hdlist1
">
10551 sendemail.multiEdit
10555 If true (default), a single editor instance will be spawned to edit
10556 files you have to edit (patches when <code>--annotate</code> is used, and the
10557 summary when <code>--compose</code> is used). If false, files will be edited one
10558 after the other, spawning a new editor each time.
10561 <dt class="hdlist1
">
10566 Sets the default for whether to confirm before sending. Must be
10567 one of <em>always</em>, <em>never</em>, <em>cc</em>, <em>compose</em>, or <em>auto</em>. See <code>--confirm</code>
10568 in the <a href="git-send-email.html
">git-send-email(1)</a> documentation for the meaning of these
10572 <dt class="hdlist1
">
10573 sendemail.aliasesFile
10577 To avoid typing long email addresses, point this to one or more
10578 email aliases files. You must also supply <code>sendemail.aliasFileType</code>.
10581 <dt class="hdlist1
">
10582 sendemail.aliasFileType
10586 Format of the file(s) specified in sendemail.aliasesFile. Must be
10587 one of <em>mutt</em>, <em>mailrc</em>, <em>pine</em>, <em>elm</em>, <em>gnus</em>, or <em>sendmail</em>.
10589 <div class="paragraph
"><p>What an alias file in each format looks like can be found in
10590 the documentation of the email program of the same name. The
10591 differences and limitations from the standard formats are
10592 described below:</p></div>
10593 <div class="openblock
">
10594 <div class="content
">
10595 <div class="dlist
"><dl>
10596 <dt class="hdlist1
">
10600 <div class="ulist
"><ul>
10603 Quoted aliases and quoted addresses are not supported: lines that
10604 contain a <code>"</code> symbol are ignored.
10609 Redirection to a file (
<code>/path/name
</code>) or pipe (
<code>|command
</code>) is not
10615 File inclusion (
<code>:include: /path/name
</code>) is not supported.
10620 Warnings are printed on the standard error output for any
10621 explicitly unsupported constructs, and any other lines that are not
10622 recognized by the parser.
10630 <dt class=
"hdlist1">
10633 <dt class=
"hdlist1">
10636 <dt class=
"hdlist1">
10639 <dt class=
"hdlist1">
10642 <dt class=
"hdlist1">
10643 sendemail.chainReplyTo
10645 <dt class=
"hdlist1">
10646 sendemail.envelopeSender
10648 <dt class=
"hdlist1">
10651 <dt class=
"hdlist1">
10652 sendemail.headerCmd
10654 <dt class=
"hdlist1">
10655 sendemail.signedOffByCc
10657 <dt class=
"hdlist1">
10660 <dt class=
"hdlist1">
10661 sendemail.suppressCc
10663 <dt class=
"hdlist1">
10664 sendemail.suppressFrom
10666 <dt class=
"hdlist1">
10669 <dt class=
"hdlist1">
10672 <dt class=
"hdlist1">
10673 sendemail.smtpDomain
10675 <dt class=
"hdlist1">
10676 sendemail.smtpServer
10678 <dt class=
"hdlist1">
10679 sendemail.smtpServerPort
10681 <dt class=
"hdlist1">
10682 sendemail.smtpServerOption
10684 <dt class=
"hdlist1">
10687 <dt class=
"hdlist1">
10690 <dt class=
"hdlist1">
10691 sendemail.transferEncoding
10693 <dt class=
"hdlist1">
10696 <dt class=
"hdlist1">
10701 These configuration variables all provide a default for
10702 <a href=
"git-send-email.html">git-send-email(
1)
</a> command-line options. See its
10703 documentation for details.
10706 <dt class=
"hdlist1">
10707 sendemail.signedOffCc (deprecated)
10711 Deprecated alias for
<code>sendemail.signedOffByCc
</code>.
10714 <dt class=
"hdlist1">
10715 sendemail.smtpBatchSize
10719 Number of messages to be sent per connection, after that a relogin
10720 will happen. If the value is
0 or undefined, send all messages in
10722 See also the
<code>--batch-size
</code> option of
<a href=
"git-send-email.html">git-send-email(
1)
</a>.
10725 <dt class=
"hdlist1">
10726 sendemail.smtpReloginDelay
10730 Seconds to wait before reconnecting to the smtp server.
10731 See also the
<code>--relogin-delay
</code> option of
<a href=
"git-send-email.html">git-send-email(
1)
</a>.
10734 <dt class=
"hdlist1">
10735 sendemail.forbidSendmailVariables
10739 To avoid common misconfiguration mistakes,
<a href=
"git-send-email.html">git-send-email(
1)
</a>
10740 will abort with a warning if any configuration options for
"sendmail"
10741 exist. Set this variable to bypass the check.
10744 <dt class=
"hdlist1">
10749 Text editor used by
<code>git rebase -i
</code> for editing the rebase instruction file.
10750 The value is meant to be interpreted by the shell when it is used.
10751 It can be overridden by the
<code>GIT_SEQUENCE_EDITOR
</code> environment variable.
10752 When not configured, the default commit message editor is used instead.
10755 <dt class=
"hdlist1">
10760 The default set of branches for
<a href=
"git-show-branch.html">git-show-branch(
1)
</a>.
10761 See
<a href=
"git-show-branch.html">git-show-branch(
1)
</a>.
10764 <dt class=
"hdlist1">
10765 sparse.expectFilesOutsideOfPatterns
10769 Typically with sparse checkouts, files not matching any
10770 sparsity patterns are marked with a SKIP_WORKTREE bit in the
10771 index and are missing from the working tree. Accordingly, Git
10772 will ordinarily check whether files with the SKIP_WORKTREE bit
10773 are in fact present in the working tree contrary to
10774 expectations. If Git finds any, it marks those paths as
10775 present by clearing the relevant SKIP_WORKTREE bits. This
10776 option can be used to tell Git that such
10777 present-despite-skipped files are expected and to stop
10780 <div class=
"paragraph"><p>The default is
<code>false
</code>, which allows Git to automatically recover
10781 from the list of files in the index and working tree falling out of
10783 <div class=
"paragraph"><p>Set this to
<code>true
</code> if you are in a setup where some external factor
10784 relieves Git of the responsibility for maintaining the consistency
10785 between the presence of working tree files and sparsity patterns. For
10786 example, if you have a Git-aware virtual file system that has a robust
10787 mechanism for keeping the working tree and the sparsity patterns up to
10788 date based on access patterns.
</p></div>
10789 <div class=
"paragraph"><p>Regardless of this setting, Git does not check for
10790 present-despite-skipped files unless sparse checkout is enabled, so
10791 this config option has no effect unless
<code>core.sparseCheckout
</code> is
10792 <code>true
</code>.
</p></div>
10794 <dt class=
"hdlist1">
10795 splitIndex.maxPercentChange
10799 When the split index feature is used, this specifies the
10800 percent of entries the split index can contain compared to the
10801 total number of entries in both the split index and the shared
10802 index before a new shared index is written.
10803 The value should be between
0 and
100. If the value is
0, then
10804 a new shared index is always written; if it is
100, a new
10805 shared index is never written.
10806 By default, the value is
20, so a new shared index is written
10807 if the number of entries in the split index would be greater
10808 than
20 percent of the total number of entries.
10809 See
<a href=
"git-update-index.html">git-update-index(
1)
</a>.
10812 <dt class=
"hdlist1">
10813 splitIndex.sharedIndexExpire
10817 When the split index feature is used, shared index files that
10818 were not modified since the time this variable specifies will
10819 be removed when a new shared index file is created. The value
10820 "now" expires all entries immediately, and
"never" suppresses
10821 expiration altogether.
10822 The default value is
"2.weeks.ago".
10823 Note that a shared index file is considered modified (for the
10824 purpose of expiration) each time a new split-index file is
10825 either created based on it or read from it.
10826 See
<a href=
"git-update-index.html">git-update-index(
1)
</a>.
10829 <dt class=
"hdlist1">
10834 By default, Git determines the command line arguments to use
10835 based on the basename of the configured SSH command (configured
10836 using the environment variable
<code>GIT_SSH
</code> or
<code>GIT_SSH_COMMAND
</code> or
10837 the config setting
<code>core.sshCommand
</code>). If the basename is
10838 unrecognized, Git will attempt to detect support of OpenSSH
10839 options by first invoking the configured SSH command with the
10840 <code>-G
</code> (print configuration) option and will subsequently use
10841 OpenSSH options (if that is successful) or no options besides
10842 the host and remote command (if it fails).
10844 <div class=
"paragraph"><p>The config variable
<code>ssh.variant
</code> can be set to override this detection.
10845 Valid values are
<code>ssh
</code> (to use OpenSSH options),
<code>plink
</code>,
<code>putty
</code>,
10846 <code>tortoiseplink
</code>,
<code>simple
</code> (no options except the host and remote command).
10847 The default auto-detection can be explicitly requested using the value
10848 <code>auto
</code>. Any other value is treated as
<code>ssh
</code>. This setting can also be
10849 overridden via the environment variable
<code>GIT_SSH_VARIANT
</code>.
</p></div>
10850 <div class=
"paragraph"><p>The current command-line parameters used for each variant are as
10852 <div class=
"openblock">
10853 <div class=
"content">
10854 <div class=
"ulist"><ul>
10857 <code>ssh
</code> - [-p port] [-
4] [-
6] [-o option] [username@]host command
10862 <code>simple
</code> - [username@]host command
10867 <code>plink
</code> or
<code>putty
</code> - [-P port] [-
4] [-
6] [username@]host command
10872 <code>tortoiseplink
</code> - [-P port] [-
4] [-
6] -batch [username@]host command
10877 <div class=
"paragraph"><p>Except for the
<code>simple
</code> variant, command-line parameters are likely to
10878 change as git gains new features.
</p></div>
10880 <dt class=
"hdlist1">
10881 stash.showIncludeUntracked
10885 If this is set to true, the
<code>git stash show
</code> command will show
10886 the untracked files of a stash entry. Defaults to false. See
10887 the description of the
<em>show
</em> command in
<a href=
"git-stash.html">git-stash(
1)
</a>.
10890 <dt class=
"hdlist1">
10895 If this is set to true, the
<code>git stash show
</code> command without an
10896 option will show the stash entry in patch form. Defaults to false.
10897 See the description of the
<em>show
</em> command in
<a href=
"git-stash.html">git-stash(
1)
</a>.
10900 <dt class=
"hdlist1">
10905 If this is set to true, the
<code>git stash show
</code> command without an
10906 option will show a diffstat of the stash entry. Defaults to true.
10907 See the description of the
<em>show
</em> command in
<a href=
"git-stash.html">git-stash(
1)
</a>.
10910 <dt class=
"hdlist1">
10911 status.relativePaths
10915 By default,
<a href=
"git-status.html">git-status(
1)
</a> shows paths relative to the
10916 current directory. Setting this variable to
<code>false
</code> shows paths
10917 relative to the repository root (this was the default for Git
10921 <dt class=
"hdlist1">
10926 Set to true to enable --short by default in
<a href=
"git-status.html">git-status(
1)
</a>.
10927 The option --no-short takes precedence over this variable.
10930 <dt class=
"hdlist1">
10935 Set to true to enable --branch by default in
<a href=
"git-status.html">git-status(
1)
</a>.
10936 The option --no-branch takes precedence over this variable.
10939 <dt class=
"hdlist1">
10944 Set to true to enable
<code>--ahead-behind
</code> and false to enable
10945 <code>--no-ahead-behind
</code> by default in
<a href=
"git-status.html">git-status(
1)
</a> for
10946 non-porcelain status formats. Defaults to true.
10949 <dt class=
"hdlist1">
10950 status.displayCommentPrefix
10954 If set to true,
<a href=
"git-status.html">git-status(
1)
</a> will insert a comment
10955 prefix before each output line (starting with
10956 <code>core.commentChar
</code>, i.e.
<code>#
</code> by default). This was the
10957 behavior of
<a href=
"git-status.html">git-status(
1)
</a> in Git
1.8.4 and previous.
10961 <dt class=
"hdlist1">
10966 The number of files to consider when performing rename detection
10967 in
<a href=
"git-status.html">git-status(
1)
</a> and
<a href=
"git-commit.html">git-commit(
1)
</a>. Defaults to
10968 the value of diff.renameLimit.
10971 <dt class=
"hdlist1">
10976 Whether and how Git detects renames in
<a href=
"git-status.html">git-status(
1)
</a> and
10977 <a href=
"git-commit.html">git-commit(
1)
</a> . If set to
"false", rename detection is
10978 disabled. If set to
"true", basic rename detection is enabled.
10979 If set to
"copies" or
"copy", Git will detect copies, as well.
10980 Defaults to the value of diff.renames.
10983 <dt class=
"hdlist1">
10988 If set to true,
<a href=
"git-status.html">git-status(
1)
</a> will display the number of
10989 entries currently stashed away.
10993 <dt class=
"hdlist1">
10994 status.showUntrackedFiles
10998 By default,
<a href=
"git-status.html">git-status(
1)
</a> and
<a href=
"git-commit.html">git-commit(
1)
</a> show
10999 files which are not currently tracked by Git. Directories which
11000 contain only untracked files, are shown with the directory name
11001 only. Showing untracked files means that Git needs to lstat() all
11002 the files in the whole repository, which might be slow on some
11003 systems. So, this variable controls how the commands display
11004 the untracked files. Possible values are:
11006 <div class=
"openblock">
11007 <div class=
"content">
11008 <div class=
"ulist"><ul>
11011 <code>no
</code> - Show no untracked files.
11016 <code>normal
</code> - Show untracked files and directories.
11021 <code>all
</code> - Show also individual files in untracked directories.
11026 <div class=
"paragraph"><p>If this variable is not specified, it defaults to
<em>normal
</em>.
11027 All usual spellings for Boolean value
<code>true
</code> are taken as
<code>normal
</code>
11028 and
<code>false
</code> as
<code>no
</code>.
11029 This variable can be overridden with the -u|--untracked-files option
11030 of
<a href=
"git-status.html">git-status(
1)
</a> and
<a href=
"git-commit.html">git-commit(
1)
</a>.
</p></div>
11032 <dt class=
"hdlist1">
11033 status.submoduleSummary
11038 If this is set to a non-zero number or true (identical to -
1 or an
11039 unlimited number), the submodule summary will be enabled and a
11040 summary of commits for modified submodules will be shown (see
11041 --summary-limit option of
<a href=
"git-submodule.html">git-submodule(
1)
</a>). Please note
11042 that the summary output command will be suppressed for all
11043 submodules when
<code>diff.ignoreSubmodules
</code> is set to
<em>all
</em> or only
11044 for those submodules where
<code>submodule.
<name
>.ignore=all
</code>. The only
11045 exception to that rule is that status and commit will show staged
11046 submodule changes. To
11047 also view the summary for ignored submodules you can either use
11048 the --ignore-submodules=dirty command-line option or the
<em>git
11049 submodule summary
</em> command, which shows a similar output but does
11050 not honor these settings.
11053 <dt class=
"hdlist1">
11054 submodule.
<name
>.url
11058 The URL for a submodule. This variable is copied from the .gitmodules
11059 file to the git config via
<em>git submodule init
</em>. The user can change
11060 the configured URL before obtaining the submodule via
<em>git submodule
11061 update
</em>. If neither submodule.
<name
>.active nor submodule.active are
11062 set, the presence of this variable is used as a fallback to indicate
11063 whether the submodule is of interest to git commands.
11064 See
<a href=
"git-submodule.html">git-submodule(
1)
</a> and
<a href=
"gitmodules.html">gitmodules(
5)
</a> for details.
11067 <dt class=
"hdlist1">
11068 submodule.
<name
>.update
11072 The method by which a submodule is updated by
<em>git submodule update
</em>,
11073 which is the only affected command, others such as
11074 <em>git checkout --recurse-submodules
</em> are unaffected. It exists for
11075 historical reasons, when
<em>git submodule
</em> was the only command to
11076 interact with submodules; settings like
<code>submodule.active
</code>
11077 and
<code>pull.rebase
</code> are more specific. It is populated by
11078 <code>git submodule init
</code> from the
<a href=
"gitmodules.html">gitmodules(
5)
</a> file.
11079 See description of
<em>update
</em> command in
<a href=
"git-submodule.html">git-submodule(
1)
</a>.
11082 <dt class=
"hdlist1">
11083 submodule.
<name
>.branch
11087 The remote branch name for a submodule, used by
<code>git submodule
11088 update --remote
</code>. Set this option to override the value found in
11089 the
<code>.gitmodules
</code> file. See
<a href=
"git-submodule.html">git-submodule(
1)
</a> and
11090 <a href=
"gitmodules.html">gitmodules(
5)
</a> for details.
11093 <dt class=
"hdlist1">
11094 submodule.
<name
>.fetchRecurseSubmodules
11098 This option can be used to control recursive fetching of this
11099 submodule. It can be overridden by using the --[no-]recurse-submodules
11100 command-line option to
"git fetch" and
"git pull".
11101 This setting will override that from in the
<a href=
"gitmodules.html">gitmodules(
5)
</a>
11105 <dt class=
"hdlist1">
11106 submodule.
<name
>.ignore
11110 Defines under what circumstances
"git status" and the diff family show
11111 a submodule as modified. When set to
"all", it will never be considered
11112 modified (but it will nonetheless show up in the output of status and
11113 commit when it has been staged),
"dirty" will ignore all changes
11114 to the submodule
’s work tree and
11115 takes only differences between the HEAD of the submodule and the commit
11116 recorded in the superproject into account.
"untracked" will additionally
11117 let submodules with modified tracked files in their work tree show up.
11118 Using
"none" (the default when this option is not set) also shows
11119 submodules that have untracked files in their work tree as changed.
11120 This setting overrides any setting made in .gitmodules for this submodule,
11121 both settings can be overridden on the command line by using the
11122 "--ignore-submodules" option. The
<em>git submodule
</em> commands are not
11123 affected by this setting.
11126 <dt class=
"hdlist1">
11127 submodule.
<name
>.active
11131 Boolean value indicating if the submodule is of interest to git
11132 commands. This config option takes precedence over the
11133 submodule.active config option. See
<a href=
"gitsubmodules.html">gitsubmodules(
7)
</a> for
11137 <dt class=
"hdlist1">
11142 A repeated field which contains a pathspec used to match against a
11143 submodule
’s path to determine if the submodule is of interest to git
11144 commands. See
<a href=
"gitsubmodules.html">gitsubmodules(
7)
</a> for details.
11147 <dt class=
"hdlist1">
11152 A boolean indicating if commands should enable the
<code>--recurse-submodules
</code>
11153 option by default. Defaults to false.
11155 <div class=
"paragraph"><p>When set to true, it can be deactivated via the
11156 <code>--no-recurse-submodules
</code> option. Note that some Git commands
11157 lacking this option may call some of the above commands affected by
11158 <code>submodule.recurse
</code>; for instance
<code>git remote update
</code> will call
11159 <code>git fetch
</code> but does not have a
<code>--no-recurse-submodules
</code> option.
11160 For these commands a workaround is to temporarily change the
11161 configuration value by using
<code>git -c submodule.recurse=
0</code>.
</p></div>
11162 <div class=
"paragraph"><p>The following list shows the commands that accept
11163 <code>--recurse-submodules
</code> and whether they are supported by this
11165 <div class=
"ulist"><ul>
11168 <code>checkout
</code>,
<code>fetch
</code>,
<code>grep
</code>,
<code>pull
</code>,
<code>push
</code>,
<code>read-tree
</code>,
11169 <code>reset
</code>,
<code>restore
</code> and
<code>switch
</code> are always supported.
11174 <code>clone
</code> and
<code>ls-files
</code> are not supported.
11179 <code>branch
</code> is supported only if
<code>submodule.propagateBranches
</code> is
11185 <dt class=
"hdlist1">
11186 submodule.propagateBranches
11190 [EXPERIMENTAL] A boolean that enables branching support when
11191 using
<code>--recurse-submodules
</code> or
<code>submodule.recurse=true
</code>.
11192 Enabling this will allow certain commands to accept
11193 <code>--recurse-submodules
</code> and certain commands that already accept
11194 <code>--recurse-submodules
</code> will now consider branches.
11198 <dt class=
"hdlist1">
11199 submodule.fetchJobs
11203 Specifies how many submodules are fetched/cloned at the same time.
11204 A positive integer allows up to that number of submodules fetched
11205 in parallel. A value of
0 will give some reasonable default.
11206 If unset, it defaults to
1.
11209 <dt class=
"hdlist1">
11210 submodule.alternateLocation
11214 Specifies how the submodules obtain alternates when submodules are
11215 cloned. Possible values are
<code>no
</code>,
<code>superproject
</code>.
11216 By default
<code>no
</code> is assumed, which doesn
’t add references. When the
11217 value is set to
<code>superproject
</code> the submodule to be cloned computes
11218 its alternates location relative to the superprojects alternate.
11221 <dt class=
"hdlist1">
11222 submodule.alternateErrorStrategy
11226 Specifies how to treat errors with the alternates for a submodule
11227 as computed via
<code>submodule.alternateLocation
</code>. Possible values are
11228 <code>ignore
</code>,
<code>info
</code>,
<code>die
</code>. Default is
<code>die
</code>. Note that if set to
<code>ignore
</code>
11229 or
<code>info
</code>, and if there is an error with the computed alternate, the
11230 clone proceeds as if no alternate was specified.
11233 <dt class=
"hdlist1">
11234 tag.forceSignAnnotated
11238 A boolean to specify whether annotated tags created should be GPG signed.
11239 If
<code>--annotate
</code> is specified on the command line, it takes
11240 precedence over this option.
11243 <dt class=
"hdlist1">
11248 This variable controls the sort ordering of tags when displayed by
11249 <a href=
"git-tag.html">git-tag(
1)
</a>. Without the
"--sort=<value>" option provided, the
11250 value of this variable will be used as the default.
11253 <dt class=
"hdlist1">
11258 A boolean to specify whether all tags should be GPG signed.
11259 Use of this option when running in an automated script can
11260 result in a large number of tags being signed. It is therefore
11261 convenient to use an agent to avoid typing your gpg passphrase
11262 several times. Note that this option doesn
’t affect tag signing
11263 behavior enabled by
"-u <keyid>" or
"--local-user=<keyid>" options.
11266 <dt class=
"hdlist1">
11271 This variable can be used to restrict the permission bits of
11272 tar archive entries. The default is
0002, which turns off the
11273 world write bit. The special value
"user" indicates that the
11274 archiving user
’s umask will be used instead. See umask(
2) and
11275 <a href=
"git-archive.html">git-archive(
1)
</a>.
11279 <div class=
"paragraph"><p>Trace2 config settings are only read from the system and global
11280 config files; repository local and worktree config files and
<code>-c
</code>
11281 command line arguments are not respected.
</p></div>
11282 <div class=
"dlist"><dl>
11283 <dt class=
"hdlist1">
11284 trace2.normalTarget
11288 This variable controls the normal target destination.
11289 It may be overridden by the
<code>GIT_TRACE2
</code> environment variable.
11290 The following table shows possible values.
11293 <dt class=
"hdlist1">
11298 This variable controls the performance target destination.
11299 It may be overridden by the
<code>GIT_TRACE2_PERF
</code> environment variable.
11300 The following table shows possible values.
11303 <dt class=
"hdlist1">
11308 This variable controls the event target destination.
11309 It may be overridden by the
<code>GIT_TRACE2_EVENT
</code> environment variable.
11310 The following table shows possible values.
11312 <div class=
"openblock">
11313 <div class=
"content">
11314 <div class=
"ulist"><ul>
11317 <code>0</code> or
<code>false
</code> - Disables the target.
11322 <code>1</code> or
<code>true
</code> - Writes to
<code>STDERR
</code>.
11327 <code>[
2-
9]
</code> - Writes to the already opened file descriptor.
11332 <code><absolute-pathname
></code> - Writes to the file in append mode. If the target
11333 already exists and is a directory, the traces will be written to files (one
11334 per process) underneath the given directory.
11339 <code>af_unix:[
<socket-type
>:]
<absolute-pathname
></code> - Write to a
11340 Unix DomainSocket (on platforms that support them). Socket
11341 type can be either
<code>stream
</code> or
<code>dgram
</code>; if omitted Git will
11348 <dt class=
"hdlist1">
11353 Boolean. When true
<code>time
</code>,
<code>filename
</code>, and
<code>line
</code> fields are
11354 omitted from normal output. May be overridden by the
11355 <code>GIT_TRACE2_BRIEF
</code> environment variable. Defaults to false.
11358 <dt class=
"hdlist1">
11363 Boolean. When true
<code>time
</code>,
<code>filename
</code>, and
<code>line
</code> fields are
11364 omitted from PERF output. May be overridden by the
11365 <code>GIT_TRACE2_PERF_BRIEF
</code> environment variable. Defaults to false.
11368 <dt class=
"hdlist1">
11373 Boolean. When true
<code>time
</code>,
<code>filename
</code>, and
<code>line
</code> fields are
11374 omitted from event output. May be overridden by the
11375 <code>GIT_TRACE2_EVENT_BRIEF
</code> environment variable. Defaults to false.
11378 <dt class=
"hdlist1">
11379 trace2.eventNesting
11383 Integer. Specifies desired depth of nested regions in the
11384 event output. Regions deeper than this value will be
11385 omitted. May be overridden by the
<code>GIT_TRACE2_EVENT_NESTING
</code>
11386 environment variable. Defaults to
2.
11389 <dt class=
"hdlist1">
11390 trace2.configParams
11394 A comma-separated list of patterns of
"important" config
11395 settings that should be recorded in the trace2 output.
11396 For example,
<code>core.*,remote.*.url
</code> would cause the trace2
11397 output to contain events listing each configured remote.
11398 May be overridden by the
<code>GIT_TRACE2_CONFIG_PARAMS
</code> environment
11399 variable. Unset by default.
11402 <dt class=
"hdlist1">
11407 A comma-separated list of
"important" environment variables that should
11408 be recorded in the trace2 output. For example,
11409 <code>GIT_HTTP_USER_AGENT,GIT_CONFIG
</code> would cause the trace2 output to
11410 contain events listing the overrides for HTTP user agent and the
11411 location of the Git configuration file (assuming any are set). May be
11412 overridden by the
<code>GIT_TRACE2_ENV_VARS
</code> environment variable. Unset by
11416 <dt class=
"hdlist1">
11417 trace2.destinationDebug
11421 Boolean. When true Git will print error messages when a
11422 trace target destination cannot be opened for writing.
11423 By default, these errors are suppressed and tracing is
11424 silently disabled. May be overridden by the
11425 <code>GIT_TRACE2_DST_DEBUG
</code> environment variable.
11428 <dt class=
"hdlist1">
11433 Integer. When writing trace files to a target directory, do not
11434 write additional traces if doing so would exceed this many files. Instead,
11435 write a sentinel file that will block further tracing to this
11436 directory. Defaults to
0, which disables this check.
11439 <dt class=
"hdlist1">
11440 transfer.credentialsInUrl
11444 A configured URL can contain plaintext credentials in the form
11445 <code><protocol
>://
<user
>:
<password
>@
<domain
>/
<path
></code>. You may want
11446 to warn or forbid the use of such configuration (in favor of
11447 using
<a href=
"git-credential.html">git-credential(
1)
</a>). This will be used on
11448 <a href=
"git-clone.html">git-clone(
1)
</a>,
<a href=
"git-fetch.html">git-fetch(
1)
</a>,
<a href=
"git-push.html">git-push(
1)
</a>,
11449 and any other direct use of the configured URL.
11451 <div class=
"paragraph"><p>Note that this is currently limited to detecting credentials in
11452 <code>remote.
<name
>.url
</code> configuration; it won
’t detect credentials in
11453 <code>remote.
<name
>.pushurl
</code> configuration.
</p></div>
11454 <div class=
"paragraph"><p>You might want to enable this to prevent inadvertent credentials
11455 exposure, e.g. because:
</p></div>
11456 <div class=
"ulist"><ul>
11459 The OS or system where you
’re running git may not provide a way or
11460 otherwise allow you to configure the permissions of the
11461 configuration file where the username and/or password are stored.
11466 Even if it does, having such data stored
"at rest" might expose you
11467 in other ways, e.g. a backup process might copy the data to another
11473 The git programs will pass the full URL to one another as arguments
11474 on the command-line, meaning the credentials will be exposed to other
11475 unprivileged users on systems that allow them to see the full
11476 process list of other users. On linux the
"hidepid" setting
11477 documented in procfs(
5) allows for configuring this behavior.
11479 <div class=
"paragraph"><p>If such concerns don
’t apply to you then you probably don
’t need to be
11480 concerned about credentials exposure due to storing sensitive
11481 data in git
’s configuration files. If you do want to use this, set
11482 <code>transfer.credentialsInUrl
</code> to one of these values:
</p></div>
11486 <code>allow
</code> (default): Git will proceed with its activity without warning.
11491 <code>warn
</code>: Git will write a warning message to
<code>stderr
</code> when parsing a URL
11492 with a plaintext credential.
11497 <code>die
</code>: Git will write a failure message to
<code>stderr
</code> when parsing a URL
11498 with a plaintext credential.
11503 <dt class=
"hdlist1">
11504 transfer.fsckObjects
11508 When
<code>fetch.fsckObjects
</code> or
<code>receive.fsckObjects
</code> are
11509 not set, the value of this variable is used instead.
11512 <div class=
"paragraph"><p>When set, the fetch or receive will abort in the case of a malformed
11513 object or a link to a nonexistent object. In addition, various other
11514 issues are checked for, including legacy issues (see
<code>fsck.
<msg-id
></code>),
11515 and potential security issues like the existence of a
<code>.GIT
</code> directory
11516 or a malicious
<code>.gitmodules
</code> file (see the release notes for v2.2
.1
11517 and v2.17
.1 for details). Other sanity and security checks may be
11518 added in future releases.
</p></div>
11519 <div class=
"paragraph"><p>On the receiving side, failing fsckObjects will make those objects
11520 unreachable, see
"QUARANTINE ENVIRONMENT" in
11521 <a href=
"git-receive-pack.html">git-receive-pack(
1)
</a>. On the fetch side, malformed objects will
11522 instead be left unreferenced in the repository.
</p></div>
11523 <div class=
"paragraph"><p>Due to the non-quarantine nature of the
<code>fetch.fsckObjects
</code>
11524 implementation it cannot be relied upon to leave the object store
11525 clean like
<code>receive.fsckObjects
</code> can.
</p></div>
11526 <div class=
"paragraph"><p>As objects are unpacked they
’re written to the object store, so there
11527 can be cases where malicious objects get introduced even though the
11528 "fetch" failed, only to have a subsequent
"fetch" succeed because only
11529 new incoming objects are checked, not those that have already been
11530 written to the object store. That difference in behavior should not be
11531 relied upon. In the future, such objects may be quarantined for
11532 "fetch" as well.
</p></div>
11533 <div class=
"paragraph"><p>For now, the paranoid need to find some way to emulate the quarantine
11534 environment if they
’d like the same protection as
"push". E.g. in the
11535 case of an internal mirror do the mirroring in two steps, one to fetch
11536 the untrusted objects, and then do a second
"push" (which will use the
11537 quarantine) to another internal repo, and have internal clients
11538 consume this pushed-to repository, or embargo internal fetches and
11539 only allow them once a full
"fsck" has run (and no new fetches have
11540 happened in the meantime).
</p></div>
11542 <dt class=
"hdlist1">
11547 String(s)
<code>receive-pack
</code> and
<code>upload-pack
</code> use to decide which
11548 refs to omit from their initial advertisements. Use more than
11549 one definition to specify multiple prefix strings. A ref that is
11550 under the hierarchies listed in the value of this variable is
11551 excluded, and is hidden when responding to
<code>git push
</code> or
<code>git
11552 fetch
</code>. See
<code>receive.hideRefs
</code> and
<code>uploadpack.hideRefs
</code> for
11553 program-specific versions of this config.
11555 <div class=
"paragraph"><p>You may also include a
<code>!
</code> in front of the ref name to negate the entry,
11556 explicitly exposing it, even if an earlier entry marked it as hidden.
11557 If you have multiple hideRefs values, later entries override earlier ones
11558 (and entries in more-specific config files override less-specific ones).
</p></div>
11559 <div class=
"paragraph"><p>If a namespace is in use, the namespace prefix is stripped from each
11560 reference before it is matched against
<code>transfer.hiderefs
</code> patterns. In
11561 order to match refs before stripping, add a
<code>^
</code> in front of the ref name. If
11562 you combine
<code>!
</code> and
<code>^
</code>,
<code>!
</code> must be specified first.
</p></div>
11563 <div class=
"paragraph"><p>For example, if
<code>refs/heads/master
</code> is specified in
<code>transfer.hideRefs
</code> and
11564 the current namespace is
<code>foo
</code>, then
<code>refs/namespaces/foo/refs/heads/master
</code>
11565 is omitted from the advertisements. If
<code>uploadpack.allowRefInWant
</code> is set,
11566 <code>upload-pack
</code> will treat
<code>want-ref refs/heads/master
</code> in a protocol v2
11567 <code>fetch
</code> command as if
<code>refs/namespaces/foo/refs/heads/master
</code> did not exist.
11568 <code>receive-pack
</code>, on the other hand, will still advertise the object id the
11569 ref is pointing to without mentioning its name (a so-called
".have" line).
</p></div>
11570 <div class=
"paragraph"><p>Even if you hide refs, a client may still be able to steal the target
11571 objects via the techniques described in the
"SECURITY" section of the
11572 <a href=
"gitnamespaces.html">gitnamespaces(
7)
</a> man page; it
’s best to keep private data in a
11573 separate repository.
</p></div>
11575 <dt class=
"hdlist1">
11576 transfer.unpackLimit
11580 When
<code>fetch.unpackLimit
</code> or
<code>receive.unpackLimit
</code> are
11581 not set, the value of this variable is used instead.
11582 The default value is
100.
11585 <dt class=
"hdlist1">
11586 transfer.advertiseSID
11590 Boolean. When true, client and server processes will advertise their
11591 unique session IDs to their remote counterpart. Defaults to false.
11594 <dt class=
"hdlist1">
11599 When
<code>true
</code>, local
<code>git clone
</code> commands will request bundle
11600 information from the remote server (if advertised) and download
11601 bundles before continuing the clone through the Git protocol.
11602 Defaults to
<code>false
</code>.
11605 <dt class=
"hdlist1">
11606 transfer.advertiseObjectInfo
11610 When
<code>true
</code>, the
<code>object-info
</code> capability is advertised by
11611 servers. Defaults to false.
11614 <dt class=
"hdlist1">
11615 uploadarchive.allowUnreachable
11619 If true, allow clients to use
<code>git archive --remote
</code> to request
11620 any tree, whether reachable from the ref tips or not. See the
11621 discussion in the
"SECURITY" section of
11622 <a href=
"git-upload-archive.html">git-upload-archive(
1)
</a> for more details. Defaults to
11623 <code>false
</code>.
11626 <dt class=
"hdlist1">
11627 uploadpack.hideRefs
11631 This variable is the same as
<code>transfer.hideRefs
</code>, but applies
11632 only to
<code>upload-pack
</code> (and so affects only fetches, not pushes).
11633 An attempt to fetch a hidden ref by
<code>git fetch
</code> will fail. See
11634 also
<code>uploadpack.allowTipSHA1InWant
</code>.
11637 <dt class=
"hdlist1">
11638 uploadpack.allowTipSHA1InWant
11642 When
<code>uploadpack.hideRefs
</code> is in effect, allow
<code>upload-pack
</code>
11643 to accept a fetch request that asks for an object at the tip
11644 of a hidden ref (by default, such a request is rejected).
11645 See also
<code>uploadpack.hideRefs
</code>. Even if this is false, a client
11646 may be able to steal objects via the techniques described in the
11647 "SECURITY" section of the
<a href=
"gitnamespaces.html">gitnamespaces(
7)
</a> man page; it
’s
11648 best to keep private data in a separate repository.
11651 <dt class=
"hdlist1">
11652 uploadpack.allowReachableSHA1InWant
11656 Allow
<code>upload-pack
</code> to accept a fetch request that asks for an
11657 object that is reachable from any ref tip. However, note that
11658 calculating object reachability is computationally expensive.
11659 Defaults to
<code>false
</code>. Even if this is false, a client may be able
11660 to steal objects via the techniques described in the
"SECURITY"
11661 section of the
<a href=
"gitnamespaces.html">gitnamespaces(
7)
</a> man page; it
’s best to
11662 keep private data in a separate repository.
11665 <dt class=
"hdlist1">
11666 uploadpack.allowAnySHA1InWant
11670 Allow
<code>upload-pack
</code> to accept a fetch request that asks for any
11672 Defaults to
<code>false
</code>.
11675 <dt class=
"hdlist1">
11676 uploadpack.keepAlive
11680 When
<code>upload-pack
</code> has started
<code>pack-objects
</code>, there may be a
11681 quiet period while
<code>pack-objects
</code> prepares the pack. Normally
11682 it would output progress information, but if
<code>--quiet
</code> was used
11683 for the fetch,
<code>pack-objects
</code> will output nothing at all until
11684 the pack data begins. Some clients and networks may consider
11685 the server to be hung and give up. Setting this option instructs
11686 <code>upload-pack
</code> to send an empty keepalive packet every
11687 <code>uploadpack.keepAlive
</code> seconds. Setting this option to
0
11688 disables keepalive packets entirely. The default is
5 seconds.
11691 <dt class=
"hdlist1">
11692 uploadpack.packObjectsHook
11696 If this option is set, when
<code>upload-pack
</code> would run
11697 <code>git pack-objects
</code> to create a packfile for a client, it will
11698 run this shell command instead. The
<code>pack-objects
</code> command and
11699 arguments it
<em>would
</em> have run (including the
<code>git pack-objects
</code>
11700 at the beginning) are appended to the shell command. The stdin
11701 and stdout of the hook are treated as if
<code>pack-objects
</code> itself
11702 was run. I.e.,
<code>upload-pack
</code> will feed input intended for
11703 <code>pack-objects
</code> to the hook, and expects a completed packfile on
11706 <div class=
"paragraph"><p>Note that this configuration variable is only respected when it is specified
11707 in protected configuration (see
<a href=
"#SCOPES">[SCOPES]
</a>). This is a safety measure
11708 against fetching from untrusted repositories.
</p></div>
11710 <dt class=
"hdlist1">
11711 uploadpack.allowFilter
11715 If this option is set,
<code>upload-pack
</code> will support partial
11716 clone and partial fetch object filtering.
11719 <dt class=
"hdlist1">
11720 uploadpackfilter.allow
11724 Provides a default value for unspecified object filters (see: the
11725 below configuration variable). If set to
<code>true
</code>, this will also
11726 enable all filters which get added in the future.
11727 Defaults to
<code>true
</code>.
11730 <dt class=
"hdlist1">
11731 uploadpackfilter.
<filter
>.allow
11735 Explicitly allow or ban the object filter corresponding to
11736 <code><filter
></code>, where
<code><filter
></code> may be one of:
<code>blob:none
</code>,
11737 <code>blob:limit
</code>,
<code>object:type
</code>,
<code>tree
</code>,
<code>sparse:oid
</code>, or
<code>combine
</code>.
11738 If using combined filters, both
<code>combine
</code> and all of the nested
11739 filter kinds must be allowed. Defaults to
<code>uploadpackfilter.allow
</code>.
11742 <dt class=
"hdlist1">
11743 uploadpackfilter.tree.maxDepth
11747 Only allow
<code>--filter=tree:
<n
></code> when
<code><n
></code> is no more than the value of
11748 <code>uploadpackfilter.tree.maxDepth
</code>. If set, this also implies
11749 <code>uploadpackfilter.tree.allow=true
</code>, unless this configuration
11750 variable had already been set. Has no effect if unset.
11753 <dt class=
"hdlist1">
11754 uploadpack.allowRefInWant
11758 If this option is set,
<code>upload-pack
</code> will support the
<code>ref-in-want
</code>
11759 feature of the protocol version
2 <code>fetch
</code> command. This feature
11760 is intended for the benefit of load-balanced servers which may
11761 not have the same view of what OIDs their refs point to due to
11765 <dt class=
"hdlist1">
11766 url.
<base
>.insteadOf
11770 Any URL that starts with this value will be rewritten to
11771 start, instead, with
<base
>. In cases where some site serves a
11772 large number of repositories, and serves them with multiple
11773 access methods, and some users need to use different access
11774 methods, this feature allows people to specify any of the
11775 equivalent URLs and have Git automatically rewrite the URL to
11776 the best alternative for the particular user, even for a
11777 never-before-seen repository on the site. When more than one
11778 insteadOf strings match a given URL, the longest match is used.
11780 <div class=
"paragraph"><p>Note that any protocol restrictions will be applied to the rewritten
11781 URL. If the rewrite changes the URL to use a custom protocol or remote
11782 helper, you may need to adjust the
<code>protocol.*.allow
</code> config to permit
11783 the request. In particular, protocols you expect to use for submodules
11784 must be set to
<code>always
</code> rather than the default of
<code>user
</code>. See the
11785 description of
<code>protocol.allow
</code> above.
</p></div>
11787 <dt class=
"hdlist1">
11788 url.
<base
>.pushInsteadOf
11792 Any URL that starts with this value will not be pushed to;
11793 instead, it will be rewritten to start with
<base
>, and the
11794 resulting URL will be pushed to. In cases where some site serves
11795 a large number of repositories, and serves them with multiple
11796 access methods, some of which do not allow push, this feature
11797 allows people to specify a pull-only URL and have Git
11798 automatically use an appropriate URL to push, even for a
11799 never-before-seen repository on the site. When more than one
11800 pushInsteadOf strings match a given URL, the longest match is
11801 used. If a remote has an explicit pushurl, Git will ignore this
11802 setting for that remote.
11805 <dt class=
"hdlist1">
11808 <dt class=
"hdlist1">
11811 <dt class=
"hdlist1">
11814 <dt class=
"hdlist1">
11817 <dt class=
"hdlist1">
11820 <dt class=
"hdlist1">
11825 The
<code>user.name
</code> and
<code>user.email
</code> variables determine what ends
11826 up in the
<code>author
</code> and
<code>committer
</code> fields of commit
11828 If you need the
<code>author
</code> or
<code>committer
</code> to be different, the
11829 <code>author.name
</code>,
<code>author.email
</code>,
<code>committer.name
</code>, or
11830 <code>committer.email
</code> variables can be set.
11831 All of these can be overridden by the
<code>GIT_AUTHOR_NAME
</code>,
11832 <code>GIT_AUTHOR_EMAIL
</code>,
<code>GIT_COMMITTER_NAME
</code>,
11833 <code>GIT_COMMITTER_EMAIL
</code>, and
<code>EMAIL
</code> environment variables.
11835 <div class=
"paragraph"><p>Note that the
<code>name
</code> forms of these variables conventionally refer to
11836 some form of a personal name. See
<a href=
"git-commit.html">git-commit(
1)
</a> and the
11837 environment variables section of
<a href=
"git.html">git(
1)
</a> for more information on
11838 these settings and the
<code>credential.username
</code> option if you
’re looking
11839 for authentication credentials instead.
</p></div>
11841 <dt class=
"hdlist1">
11846 Instruct Git to avoid trying to guess defaults for
<code>user.email
</code>
11847 and
<code>user.name
</code>, and instead retrieve the values only from the
11848 configuration. For example, if you have multiple email addresses
11849 and would like to use a different one for each repository, then
11850 with this configuration option set to
<code>true
</code> in the global config
11851 along with a name, Git will prompt you to set up an email before
11852 making new commits in a newly cloned repository.
11853 Defaults to
<code>false
</code>.
11856 <dt class=
"hdlist1">
11861 If
<a href=
"git-tag.html">git-tag(
1)
</a> or
<a href=
"git-commit.html">git-commit(
1)
</a> is not selecting the
11862 key you want it to automatically when creating a signed tag or
11863 commit, you can override the default selection with this variable.
11864 This option is passed unchanged to gpg
’s --local-user parameter,
11865 so you may specify a key using any method that gpg supports.
11866 If gpg.format is set to
<code>ssh
</code> this can contain the path to either
11867 your private ssh key or the public key when ssh-agent is used.
11868 Alternatively it can contain a public key prefixed with
<code>key::
</code>
11869 directly (e.g.:
"key::ssh-rsa XXXXXX identifier"). The private key
11870 needs to be available via ssh-agent. If not set Git will call
11871 gpg.ssh.defaultKeyCommand (e.g.:
"ssh-add -L") and try to use the
11872 first key available. For backward compatibility, a raw key which
11873 begins with
"ssh-", such as
"ssh-rsa XXXXXX identifier", is treated
11874 as
"key::ssh-rsa XXXXXX identifier", but this form is deprecated;
11875 use the
<code>key::
</code> form instead.
11878 <dt class=
"hdlist1">
11879 versionsort.prereleaseSuffix (deprecated)
11883 Deprecated alias for
<code>versionsort.suffix
</code>. Ignored if
11884 <code>versionsort.suffix
</code> is set.
11887 <dt class=
"hdlist1">
11892 Even when version sort is used in
<a href=
"git-tag.html">git-tag(
1)
</a>, tagnames
11893 with the same base version but different suffixes are still sorted
11894 lexicographically, resulting e.g. in prerelease tags appearing
11895 after the main release (e.g.
"1.0-rc1" after
"1.0"). This
11896 variable can be specified to determine the sorting order of tags
11897 with different suffixes.
11899 <div class=
"paragraph"><p>By specifying a single suffix in this variable, any tagname containing
11900 that suffix will appear before the corresponding main release. E.g. if
11901 the variable is set to
"-rc", then all
"1.0-rcX" tags will appear before
11902 "1.0". If specified multiple times, once per suffix, then the order of
11903 suffixes in the configuration will determine the sorting order of tagnames
11904 with those suffixes. E.g. if
"-pre" appears before
"-rc" in the
11905 configuration, then all
"1.0-preX" tags will be listed before any
11906 "1.0-rcX" tags. The placement of the main release tag relative to tags
11907 with various suffixes can be determined by specifying the empty suffix
11908 among those other suffixes. E.g. if the suffixes
"-rc",
"",
"-ck", and
11909 "-bfs" appear in the configuration in this order, then all
"v4.8-rcX" tags
11910 are listed first, followed by
"v4.8", then
"v4.8-ckX" and finally
11911 "v4.8-bfsX".
</p></div>
11912 <div class=
"paragraph"><p>If more than one suffix matches the same tagname, then that tagname will
11913 be sorted according to the suffix which starts at the earliest position in
11914 the tagname. If more than one different matching suffix starts at
11915 that earliest position, then that tagname will be sorted according to the
11916 longest of those suffixes.
11917 The sorting order between different suffixes is undefined if they are
11918 in multiple config files.
</p></div>
11920 <dt class=
"hdlist1">
11925 Specify a web browser that may be used by some commands.
11926 Currently only
<a href=
"git-instaweb.html">git-instaweb(
1)
</a> and
<a href=
"git-help.html">git-help(
1)
</a>
11930 <dt class=
"hdlist1">
11931 worktree.guessRemote
11935 If no branch is specified and neither
<code>-b
</code> nor
<code>-B
</code> nor
11936 <code>--detach
</code> is used, then
<code>git worktree add
</code> defaults to
11937 creating a new branch from HEAD. If
<code>worktree.guessRemote
</code> is
11938 set to true,
<code>worktree add
</code> tries to find a remote-tracking
11939 branch whose name uniquely matches the new branch name. If
11940 such a branch exists, it is checked out and set as
"upstream"
11941 for the new branch. If no such match can be found, it falls
11942 back to creating a new branch from the current HEAD.
11949 <div class=
"sect1">
11950 <h2 id=
"_bugs">BUGS
</h2>
11951 <div class=
"sectionbody">
11952 <div class=
"paragraph"><p>When using the deprecated
<code>[section.subsection]
</code> syntax, changing a value
11953 will result in adding a multi-line key instead of a change, if the subsection
11954 is given with at least one uppercase character. For example when the config
11955 looks like
</p></div>
11956 <div class=
"listingblock">
11957 <div class=
"content">
11958 <pre><code> [section.subsection]
11959 key = value1
</code></pre>
11961 <div class=
"paragraph"><p>and running
<code>git config section.Subsection.key value2
</code> will result in
</p></div>
11962 <div class=
"listingblock">
11963 <div class=
"content">
11964 <pre><code> [section.subsection]
11966 key = value2
</code></pre>
11970 <div class=
"sect1">
11971 <h2 id=
"_git">GIT
</h2>
11972 <div class=
"sectionbody">
11973 <div class=
"paragraph"><p>Part of the
<a href=
"git.html">git(
1)
</a> suite
</p></div>
11977 <div id=
"footnotes"><hr /></div>
11979 <div id=
"footer-text">
11981 2024-
03-
25 17:
24:
49 PDT