summaryrefslogtreecommitdiffstats
path: root/git-config.html
diff options
context:
space:
mode:
authorJunio C Hamano <gitster@pobox.com>2022-09-14 13:25:23 -0700
committerJunio C Hamano <gitster@pobox.com>2022-09-14 13:25:23 -0700
commitba8baee8618696a4405a1c7feb93ce8d3b089795 (patch)
tree36a0a7f824df6259cd09b0081e297b366279ab46 /git-config.html
parentb2e63923b4a1650cdd5c8d919dacf6c650940a92 (diff)
downloadgit-htmldocs-ba8baee8618696a4405a1c7feb93ce8d3b089795.tar.gz
Autogenerated HTML docs for v2.37.3-662-g36f8e7e
Diffstat (limited to 'git-config.html')
-rw-r--r--git-config.html204
1 files changed, 150 insertions, 54 deletions
diff --git a/git-config.html b/git-config.html
index 8de112050..cd1bf2739 100644
--- a/git-config.html
+++ b/git-config.html
@@ -4902,31 +4902,6 @@ diff.&lt;driver&gt;.cachetextconv
Set this option to true to make the diff driver cache the text
conversion outputs. See <a href="gitattributes.html">gitattributes(5)</a> for details.
</p>
-</dd>
-<dt class="hdlist1">
-diff.tool
-</dt>
-<dd>
-<p>
- Controls which diff tool is used by <a href="git-difftool.html">git-difftool(1)</a>.
- This variable overrides the value configured in <code>merge.tool</code>.
- The list below shows the valid built-in values.
- Any other value is treated as a custom diff tool and requires
- that a corresponding difftool.&lt;tool&gt;.cmd variable is defined.
-</p>
-</dd>
-<dt class="hdlist1">
-diff.guitool
-</dt>
-<dd>
-<p>
- Controls which diff tool is used by <a href="git-difftool.html">git-difftool(1)</a> when
- the -g/--gui flag is specified. This variable overrides the value
- configured in <code>merge.guitool</code>. The list below shows the valid
- built-in values. Any other value is treated as a custom diff tool
- and requires that a corresponding difftool.&lt;guitool&gt;.cmd variable
- is defined.
-</p>
<div class="dlist"><dl>
<dt class="hdlist1">
<code>araxis</code>
@@ -5215,12 +5190,28 @@ diff.colorMovedWS
</p>
</dd>
<dt class="hdlist1">
-difftool.&lt;tool&gt;.path
+diff.tool
</dt>
<dd>
<p>
- Override the path for the given tool. This is useful in case
- your tool is not in the PATH.
+ Controls which diff tool is used by <a href="git-difftool.html">git-difftool(1)</a>.
+ This variable overrides the value configured in <code>merge.tool</code>.
+ The list below shows the valid built-in values.
+ Any other value is treated as a custom diff tool and requires
+ that a corresponding difftool.&lt;tool&gt;.cmd variable is defined.
+</p>
+</dd>
+<dt class="hdlist1">
+diff.guitool
+</dt>
+<dd>
+<p>
+ Controls which diff tool is used by <a href="git-difftool.html">git-difftool(1)</a> when
+ the -g/--gui flag is specified. This variable overrides the value
+ configured in <code>merge.guitool</code>. The list below shows the valid
+ built-in values. Any other value is treated as a custom diff tool
+ and requires that a corresponding difftool.&lt;guitool&gt;.cmd variable
+ is defined.
</p>
</dd>
<dt class="hdlist1">
@@ -5235,6 +5226,25 @@ difftool.&lt;tool&gt;.cmd
is set to the name of the temporary file containing the contents
of the diff post-image.
</p>
+<div class="paragraph"><p>See the <code>--tool=&lt;tool&gt;</code> option in <a href="git-difftool.html">git-difftool(1)</a> for more details.</p></div>
+</dd>
+<dt class="hdlist1">
+difftool.&lt;tool&gt;.path
+</dt>
+<dd>
+<p>
+ Override the path for the given tool. This is useful in case
+ your tool is not in the PATH.
+</p>
+</dd>
+<dt class="hdlist1">
+difftool.trustExitCode
+</dt>
+<dd>
+<p>
+ Exit difftool if the invoked diff tool returns a non-zero exit status.
+</p>
+<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>
</dd>
<dt class="hdlist1">
difftool.prompt
@@ -6279,8 +6289,16 @@ grep.threads
</dt>
<dd>
<p>
- Number of grep worker threads to use.
- See <code>grep.threads</code> in <a href="git-grep.html">git-grep(1)</a> for more information.
+ Number of grep worker threads to use. If unset (or set to 0), Git will
+ use as many threads as the number of logical cores available.
+</p>
+</dd>
+<dt class="hdlist1">
+grep.fullName
+</dt>
+<dd>
+<p>
+ If set to true, enable <code>--full-name</code> option by default.
</p>
</dd>
<dt class="hdlist1">
@@ -7596,6 +7614,9 @@ log.date
Setting a value for log.date is similar to using <em>git log</em>'s
<code>--date</code> option. See <a href="git-log.html">git-log(1)</a> for details.
</p>
+<div class="paragraph"><p>If the format is set to "auto:foo" and the pager is in use, format
+"foo" will be the used for the date format. Otherwise "default" will
+be used.</p></div>
</dd>
<dt class="hdlist1">
log.decorate
@@ -8540,6 +8561,8 @@ notes.mergeStrategy
<code>cat_sort_uniq</code>. Defaults to <code>manual</code>. See "NOTES MERGE STRATEGIES"
section of <a href="git-notes.html">git-notes(1)</a> for more information on each strategy.
</p>
+<div class="paragraph"><p>This setting can be overridden by passing the <code>--strategy</code> option to
+<a href="git-notes.html">git-notes(1)</a>.</p></div>
</dd>
<dt class="hdlist1">
notes.&lt;name&gt;.mergeStrategy
@@ -8557,17 +8580,19 @@ notes.displayRef
</dt>
<dd>
<p>
- The (fully qualified) refname from which to show notes when
- showing commit messages. The value of this variable can be set
- to a glob, in which case notes from all matching refs will be
- shown. You may also specify this configuration variable
- several times. A warning will be issued for refs that do not
- exist, but a glob that does not match any refs is silently
- ignored.
+ Which ref (or refs, if a glob or specified more than once), in
+ addition to the default set by <code>core.notesRef</code> or
+ <code>GIT_NOTES_REF</code>, to read notes from when showing commit
+ messages with the <em>git log</em> family of commands.
</p>
<div class="paragraph"><p>This setting can be overridden with the <code>GIT_NOTES_DISPLAY_REF</code>
environment variable, which must be a colon separated list of refs or
globs.</p></div>
+<div class="paragraph"><p>A warning will be issued for refs that do not exist,
+but a glob that does not match any refs is silently ignored.</p></div>
+<div class="paragraph"><p>This setting can be disabled by the <code>--no-notes</code> option to the <em>git
+log</em> family of commands, or by the <code>--notes=&lt;ref&gt;</code> option accepted by
+those commands.</p></div>
<div class="paragraph"><p>The effective value of "core.notesRef" (possibly overridden by
GIT_NOTES_REF) is also implicitly added to the list of refs to be
displayed.</p></div>
@@ -8578,11 +8603,13 @@ notes.rewrite.&lt;command&gt;
<dd>
<p>
When rewriting commits with &lt;command&gt; (currently <code>amend</code> or
- <code>rebase</code>) and this variable is set to <code>true</code>, Git
- automatically copies your notes from the original to the
- rewritten commit. Defaults to <code>true</code>, but see
- "notes.rewriteRef" below.
+ <code>rebase</code>), if this variable is <code>false</code>, git will not copy
+ notes from the original to the rewritten commit. Defaults to
+ <code>true</code>. See also "<code>notes.rewriteRef</code>" below.
</p>
+<div class="paragraph"><p>This setting can be overridden with the <code>GIT_NOTES_REWRITE_REF</code>
+environment variable, which must be a colon separated list of refs or
+globs.</p></div>
</dd>
<dt class="hdlist1">
notes.rewriteMode
@@ -8604,16 +8631,15 @@ notes.rewriteRef
<dd>
<p>
When copying notes during a rewrite, specifies the (fully
- qualified) ref whose notes should be copied. The ref may be a
- glob, in which case notes in all matching refs will be copied.
- You may also specify this configuration several times.
+ qualified) ref whose notes should be copied. May be a glob,
+ in which case notes in all matching refs will be copied. You
+ may also specify this configuration several times.
</p>
<div class="paragraph"><p>Does not have a default value; you must configure this variable to
enable note rewriting. Set it to <code>refs/notes/commits</code> to enable
rewriting for the default commit notes.</p></div>
-<div class="paragraph"><p>This setting can be overridden with the <code>GIT_NOTES_REWRITE_REF</code>
-environment variable, which must be a colon separated list of refs or
-globs.</p></div>
+<div class="paragraph"><p>Can be overridden with the <code>GIT_NOTES_REWRITE_REF</code> environment variable.
+See <code>notes.rewrite.&lt;command&gt;</code> above for a further description of its format.</p></div>
</dd>
<dt class="hdlist1">
pack.window
@@ -10049,11 +10075,85 @@ sendemail.&lt;identity&gt;.*
</p>
</dd>
<dt class="hdlist1">
+sendemail.multiEdit
+</dt>
+<dd>
+<p>
+ If true (default), a single editor instance will be spawned to edit
+ files you have to edit (patches when <code>--annotate</code> is used, and the
+ summary when <code>--compose</code> is used). If false, files will be edited one
+ after the other, spawning a new editor each time.
+</p>
+</dd>
+<dt class="hdlist1">
+sendemail.confirm
+</dt>
+<dd>
+<p>
+ Sets the default for whether to confirm before sending. Must be
+ one of <em>always</em>, <em>never</em>, <em>cc</em>, <em>compose</em>, or <em>auto</em>. See <code>--confirm</code>
+ in the <a href="git-send-email.html">git-send-email(1)</a> documentation for the meaning of these
+ values.
+</p>
+</dd>
+<dt class="hdlist1">
sendemail.aliasesFile
</dt>
+<dd>
+<p>
+ To avoid typing long email addresses, point this to one or more
+ email aliases files. You must also supply <code>sendemail.aliasFileType</code>.
+</p>
+</dd>
<dt class="hdlist1">
sendemail.aliasFileType
</dt>
+<dd>
+<p>
+ Format of the file(s) specified in sendemail.aliasesFile. Must be
+ one of <em>mutt</em>, <em>mailrc</em>, <em>pine</em>, <em>elm</em>, or <em>gnus</em>, or <em>sendmail</em>.
+</p>
+<div class="paragraph"><p>What an alias file in each format looks like can be found in
+the documentation of the email program of the same name. The
+differences and limitations from the standard formats are
+described below:</p></div>
+<div class="openblock">
+<div class="content">
+<div class="dlist"><dl>
+<dt class="hdlist1">
+sendmail
+</dt>
+<dd>
+<div class="ulist"><ul>
+<li>
+<p>
+Quoted aliases and quoted addresses are not supported: lines that
+ contain a <code>"</code> symbol are ignored.
+</p>
+</li>
+<li>
+<p>
+Redirection to a file (<code>/path/name</code>) or pipe (<code>|command</code>) is not
+ supported.
+</p>
+</li>
+<li>
+<p>
+File inclusion (<code>:include: /path/name</code>) is not supported.
+</p>
+</li>
+<li>
+<p>
+Warnings are printed on the standard error output for any
+ explicitly unsupported constructs, and any other lines that are not
+ recognized by the parser.
+</p>
+</li>
+</ul></div>
+</dd>
+</dl></div>
+</div></div>
+</dd>
<dt class="hdlist1">
sendemail.annotate
</dt>
@@ -10070,18 +10170,12 @@ sendemail.ccCmd
sendemail.chainReplyTo
</dt>
<dt class="hdlist1">
-sendemail.confirm
-</dt>
-<dt class="hdlist1">
sendemail.envelopeSender
</dt>
<dt class="hdlist1">
sendemail.from
</dt>
<dt class="hdlist1">
-sendemail.multiEdit
-</dt>
-<dt class="hdlist1">
sendemail.signedoffbycc
</dt>
<dt class="hdlist1">
@@ -10128,7 +10222,9 @@ sendemail.xmailer
</dt>
<dd>
<p>
- See <a href="git-send-email.html">git-send-email(1)</a> for description.
+ These configuration variables all provide a default for
+ <a href="git-send-email.html">git-send-email(1)</a> command-line options. See its
+ documentation for details.
</p>
</dd>
<dt class="hdlist1">