Merge branch 'ab/dedup-config-and-command-docs'

Share the text used to explain configuration variables used by "git
<subcmd>" in "git help <subcmd>" with the text from "git help config".

* ab/dedup-config-and-command-docs:
  docs: add CONFIGURATION sections that fuzzy map to built-ins
  docs: add CONFIGURATION sections that map to a built-in
  log docs: de-duplicate configuration sections
  difftool docs: de-duplicate configuration sections
  notes docs: de-duplicate and combine configuration sections
  apply docs: de-duplicate configuration sections
  send-email docs: de-duplicate configuration sections
  grep docs: de-duplicate configuration sections
  docs: add and use include template for config/* includes
This commit is contained in:
Junio C Hamano 2022-09-14 12:56:39 -07:00
commit 7a54d74045
42 changed files with 278 additions and 224 deletions

View File

@ -62,6 +62,7 @@ HOWTO_TXT += $(wildcard howto/*.txt)
DOC_DEP_TXT += $(wildcard *.txt) DOC_DEP_TXT += $(wildcard *.txt)
DOC_DEP_TXT += $(wildcard config/*.txt) DOC_DEP_TXT += $(wildcard config/*.txt)
DOC_DEP_TXT += $(wildcard includes/*.txt)
ifdef MAN_FILTER ifdef MAN_FILTER
MAN_TXT = $(filter $(MAN_FILTER),$(MAN1_TXT) $(MAN5_TXT) $(MAN7_TXT)) MAN_TXT = $(filter $(MAN_FILTER),$(MAN1_TXT) $(MAN5_TXT) $(MAN7_TXT))

View File

@ -178,21 +178,6 @@ diff.<driver>.cachetextconv::
Set this option to true to make the diff driver cache the text Set this option to true to make the diff driver cache the text
conversion outputs. See linkgit:gitattributes[5] for details. conversion outputs. See linkgit:gitattributes[5] for details.
diff.tool::
Controls which diff tool is used by linkgit:git-difftool[1].
This variable overrides the value configured in `merge.tool`.
The list below shows the valid built-in values.
Any other value is treated as a custom diff tool and requires
that a corresponding difftool.<tool>.cmd variable is defined.
diff.guitool::
Controls which diff tool is used by linkgit:git-difftool[1] when
the -g/--gui flag is specified. This variable overrides the value
configured in `merge.guitool`. 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.<guitool>.cmd variable
is defined.
include::../mergetools-diff.txt[] include::../mergetools-diff.txt[]
diff.indentHeuristic:: diff.indentHeuristic::

View File

@ -1,6 +1,17 @@
difftool.<tool>.path:: diff.tool::
Override the path for the given tool. This is useful in case Controls which diff tool is used by linkgit:git-difftool[1].
your tool is not in the PATH. This variable overrides the value configured in `merge.tool`.
The list below shows the valid built-in values.
Any other value is treated as a custom diff tool and requires
that a corresponding difftool.<tool>.cmd variable is defined.
diff.guitool::
Controls which diff tool is used by linkgit:git-difftool[1] when
the -g/--gui flag is specified. This variable overrides the value
configured in `merge.guitool`. 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.<guitool>.cmd variable
is defined.
difftool.<tool>.cmd:: difftool.<tool>.cmd::
Specify the command to invoke the specified diff tool. Specify the command to invoke the specified diff tool.
@ -9,6 +20,17 @@ difftool.<tool>.cmd::
file containing the contents of the diff pre-image and 'REMOTE' file containing the contents of the diff pre-image and 'REMOTE'
is set to the name of the temporary file containing the contents is set to the name of the temporary file containing the contents
of the diff post-image. of the diff post-image.
+
See the `--tool=<tool>` option in linkgit:git-difftool[1] for more details.
difftool.<tool>.path::
Override the path for the given tool. This is useful in case
your tool is not in the PATH.
difftool.trustExitCode::
Exit difftool if the invoked diff tool returns a non-zero exit status.
+
See the `--trust-exit-code` option in linkgit:git-difftool[1] for more details.
difftool.prompt:: difftool.prompt::
Prompt before each invocation of the diff tool. Prompt before each invocation of the diff tool.

View File

@ -17,8 +17,11 @@ grep.extendedRegexp::
other than 'default'. other than 'default'.
grep.threads:: grep.threads::
Number of grep worker threads to use. Number of grep worker threads to use. If unset (or set to 0), Git will
See `grep.threads` in linkgit:git-grep[1] for more information. use as many threads as the number of logical cores available.
grep.fullName::
If set to true, enable `--full-name` option by default.
grep.fallbackToNoIndex:: grep.fallbackToNoIndex::
If set to true, fall back to git grep --no-index if git grep If set to true, fall back to git grep --no-index if git grep

View File

@ -7,6 +7,10 @@ log.date::
Set the default date-time mode for the 'log' command. Set the default date-time mode for the 'log' command.
Setting a value for log.date is similar to using 'git log''s Setting a value for log.date is similar to using 'git log''s
`--date` option. See linkgit:git-log[1] for details. `--date` option. See linkgit:git-log[1] for details.
+
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.
log.decorate:: log.decorate::
Print out the ref names of any commits that are shown by the log Print out the ref names of any commits that are shown by the log

View File

@ -3,6 +3,9 @@ notes.mergeStrategy::
conflicts. Must be one of `manual`, `ours`, `theirs`, `union`, or conflicts. Must be one of `manual`, `ours`, `theirs`, `union`, or
`cat_sort_uniq`. Defaults to `manual`. See "NOTES MERGE STRATEGIES" `cat_sort_uniq`. Defaults to `manual`. See "NOTES MERGE STRATEGIES"
section of linkgit:git-notes[1] for more information on each strategy. section of linkgit:git-notes[1] for more information on each strategy.
+
This setting can be overridden by passing the `--strategy` option to
linkgit:git-notes[1].
notes.<name>.mergeStrategy:: notes.<name>.mergeStrategy::
Which merge strategy to choose when doing a notes merge into Which merge strategy to choose when doing a notes merge into
@ -11,28 +14,35 @@ notes.<name>.mergeStrategy::
linkgit:git-notes[1] for more information on the available strategies. linkgit:git-notes[1] for more information on the available strategies.
notes.displayRef:: notes.displayRef::
The (fully qualified) refname from which to show notes when Which ref (or refs, if a glob or specified more than once), in
showing commit messages. The value of this variable can be set addition to the default set by `core.notesRef` or
to a glob, in which case notes from all matching refs will be `GIT_NOTES_REF`, to read notes from when showing commit
shown. You may also specify this configuration variable messages with the 'git log' family of commands.
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.
+ +
This setting can be overridden with the `GIT_NOTES_DISPLAY_REF` This setting can be overridden with the `GIT_NOTES_DISPLAY_REF`
environment variable, which must be a colon separated list of refs or environment variable, which must be a colon separated list of refs or
globs. globs.
+ +
A warning will be issued for refs that do not exist,
but a glob that does not match any refs is silently ignored.
+
This setting can be disabled by the `--no-notes` option to the 'git
log' family of commands, or by the `--notes=<ref>` option accepted by
those commands.
+
The effective value of "core.notesRef" (possibly overridden by The effective value of "core.notesRef" (possibly overridden by
GIT_NOTES_REF) is also implicitly added to the list of refs to be GIT_NOTES_REF) is also implicitly added to the list of refs to be
displayed. displayed.
notes.rewrite.<command>:: notes.rewrite.<command>::
When rewriting commits with <command> (currently `amend` or When rewriting commits with <command> (currently `amend` or
`rebase`) and this variable is set to `true`, Git `rebase`), if this variable is `false`, git will not copy
automatically copies your notes from the original to the notes from the original to the rewritten commit. Defaults to
rewritten commit. Defaults to `true`, but see `true`. See also "`notes.rewriteRef`" below.
"notes.rewriteRef" below. +
This setting can be overridden with the `GIT_NOTES_REWRITE_REF`
environment variable, which must be a colon separated list of refs or
globs.
notes.rewriteMode:: notes.rewriteMode::
When copying notes during a rewrite (see the When copying notes during a rewrite (see the
@ -46,14 +56,13 @@ environment variable.
notes.rewriteRef:: notes.rewriteRef::
When copying notes during a rewrite, specifies the (fully When copying notes during a rewrite, specifies the (fully
qualified) ref whose notes should be copied. The ref may be a qualified) ref whose notes should be copied. May be a glob,
glob, in which case notes in all matching refs will be copied. in which case notes in all matching refs will be copied. You
You may also specify this configuration several times. may also specify this configuration several times.
+ +
Does not have a default value; you must configure this variable to Does not have a default value; you must configure this variable to
enable note rewriting. Set it to `refs/notes/commits` to enable enable note rewriting. Set it to `refs/notes/commits` to enable
rewriting for the default commit notes. rewriting for the default commit notes.
+ +
This setting can be overridden with the `GIT_NOTES_REWRITE_REF` Can be overridden with the `GIT_NOTES_REWRITE_REF` environment variable.
environment variable, which must be a colon separated list of refs or See `notes.rewrite.<command>` above for a further description of its format.
globs.

View File

@ -18,17 +18,49 @@ sendemail.<identity>.*::
identity is selected, through either the command-line or identity is selected, through either the command-line or
`sendemail.identity`. `sendemail.identity`.
sendemail.multiEdit::
If true (default), a single editor instance will be spawned to edit
files you have to edit (patches when `--annotate` is used, and the
summary when `--compose` is used). If false, files will be edited one
after the other, spawning a new editor each time.
sendemail.confirm::
Sets the default for whether to confirm before sending. Must be
one of 'always', 'never', 'cc', 'compose', or 'auto'. See `--confirm`
in the linkgit:git-send-email[1] documentation for the meaning of these
values.
sendemail.aliasesFile:: sendemail.aliasesFile::
To avoid typing long email addresses, point this to one or more
email aliases files. You must also supply `sendemail.aliasFileType`.
sendemail.aliasFileType:: sendemail.aliasFileType::
Format of the file(s) specified in sendemail.aliasesFile. Must be
one of 'mutt', 'mailrc', 'pine', 'elm', or 'gnus', or 'sendmail'.
+
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:
+
--
sendmail;;
* Quoted aliases and quoted addresses are not supported: lines that
contain a `"` symbol are ignored.
* Redirection to a file (`/path/name`) or pipe (`|command`) is not
supported.
* File inclusion (`:include: /path/name`) is not supported.
* Warnings are printed on the standard error output for any
explicitly unsupported constructs, and any other lines that are not
recognized by the parser.
--
sendemail.annotate:: sendemail.annotate::
sendemail.bcc:: sendemail.bcc::
sendemail.cc:: sendemail.cc::
sendemail.ccCmd:: sendemail.ccCmd::
sendemail.chainReplyTo:: sendemail.chainReplyTo::
sendemail.confirm::
sendemail.envelopeSender:: sendemail.envelopeSender::
sendemail.from:: sendemail.from::
sendemail.multiEdit::
sendemail.signedoffbycc:: sendemail.signedoffbycc::
sendemail.smtpPass:: sendemail.smtpPass::
sendemail.suppresscc:: sendemail.suppresscc::
@ -44,7 +76,9 @@ sendemail.thread::
sendemail.transferEncoding:: sendemail.transferEncoding::
sendemail.validate:: sendemail.validate::
sendemail.xmailer:: sendemail.xmailer::
See linkgit:git-send-email[1] for description. These configuration variables all provide a default for
linkgit:git-send-email[1] command-line options. See its
documentation for details.
sendemail.signedoffcc (deprecated):: sendemail.signedoffcc (deprecated)::
Deprecated alias for `sendemail.signedoffbycc`. Deprecated alias for `sendemail.signedoffbycc`.

View File

@ -433,6 +433,13 @@ they will make the patch impossible to apply:
* deleting context or removal lines * deleting context or removal lines
* modifying the contents of context or removal lines * modifying the contents of context or removal lines
CONFIGURATION
-------------
include::includes/cmd-config-section-all.txt[]
include::config/add.txt[]
SEE ALSO SEE ALSO
-------- --------
linkgit:git-status[1] linkgit:git-status[1]

View File

@ -258,6 +258,13 @@ This command can run `applypatch-msg`, `pre-applypatch`,
and `post-applypatch` hooks. See linkgit:githooks[5] for more and `post-applypatch` hooks. See linkgit:githooks[5] for more
information. information.
CONFIGURATION
-------------
include::includes/cmd-config-section-all.txt[]
include::config/am.txt[]
SEE ALSO SEE ALSO
-------- --------
linkgit:git-apply[1]. linkgit:git-apply[1].

View File

@ -263,13 +263,9 @@ has no effect when `--index` or `--cached` is in use.
CONFIGURATION CONFIGURATION
------------- -------------
apply.ignoreWhitespace:: include::includes/cmd-config-section-all.txt[]
Set to 'change' if you want changes in whitespace to be ignored by default.
Set to one of: no, none, never, false if you want changes in include::config/apply.txt[]
whitespace to be significant.
apply.whitespace::
When no `--whitespace` flag is given from the command
line, this configuration item is used as the default.
SUBMODULES SUBMODULES
---------- ----------

View File

@ -241,6 +241,12 @@ MAPPING AUTHORS
See linkgit:gitmailmap[5]. See linkgit:gitmailmap[5].
CONFIGURATION
-------------
include::includes/cmd-config-section-all.txt[]
include::config/blame.txt[]
SEE ALSO SEE ALSO
-------- --------

View File

@ -336,6 +336,10 @@ CONFIGURATION
`--list` is used or implied. The default is to use a pager. `--list` is used or implied. The default is to use a pager.
See linkgit:git-config[1]. See linkgit:git-config[1].
include::includes/cmd-config-section-rest.txt[]
include::config/branch.txt[]
EXAMPLES EXAMPLES
-------- --------

View File

@ -600,6 +600,13 @@ $ edit frotz
$ git add frotz $ git add frotz
------------ ------------
CONFIGURATION
-------------
include::includes/cmd-config-section-all.txt[]
include::config/checkout.txt[]
SEE ALSO SEE ALSO
-------- --------
linkgit:git-switch[1], linkgit:git-switch[1],

View File

@ -133,6 +133,13 @@ help::
Show brief usage of interactive git-clean. Show brief usage of interactive git-clean.
CONFIGURATION
-------------
include::includes/cmd-config-section-all.txt[]
include::config/clean.txt[]
SEE ALSO SEE ALSO
-------- --------
linkgit:gitignore[5] linkgit:gitignore[5]

View File

@ -370,6 +370,15 @@ $ cd my-linux
$ git clone --bare -l /home/proj/.git /pub/scm/proj.git $ git clone --bare -l /home/proj/.git /pub/scm/proj.git
------------ ------------
CONFIGURATION
-------------
include::includes/cmd-config-section-all.txt[]
include::config/init.txt[]
include::config/clone.txt[]
GIT GIT
--- ---

View File

@ -74,6 +74,13 @@ v2.4.3 v2.4.4 v2.4.5 v2.4.6 v2.4.7
v2.4.8 v2.4.9 v2.4.8 v2.4.9
------------ ------------
CONFIGURATION
-------------
include::includes/cmd-config-section-all.txt[]
include::config/column.txt[]
GIT GIT
--- ---
Part of the linkgit:git[1] suite Part of the linkgit:git[1] suite

View File

@ -142,6 +142,13 @@ $ git show-ref -s | git commit-graph write --stdin-commits
$ git rev-parse HEAD | git commit-graph write --stdin-commits --append $ git rev-parse HEAD | git commit-graph write --stdin-commits --append
------------------------------------------------ ------------------------------------------------
CONFIGURATION
-------------
include::includes/cmd-config-section-all.txt[]
include::config/commitgraph.txt[]
FILE FORMAT FILE FORMAT
----------- -----------

View File

@ -557,6 +557,10 @@ The editor used to edit the commit log message will be chosen from the
`VISUAL` environment variable, or the `EDITOR` environment variable (in that `VISUAL` environment variable, or the `EDITOR` environment variable (in that
order). See linkgit:git-var[1] for details. order). See linkgit:git-var[1] for details.
include::includes/cmd-config-section-rest.txt[]
include::config/commit.txt[]
HOOKS HOOKS
----- -----
This command can run `commit-msg`, `prepare-commit-msg`, `pre-commit`, This command can run `commit-msg`, `prepare-commit-msg`, `pre-commit`,

View File

@ -213,6 +213,13 @@ $ git diff -R <2>
rewrites (very expensive). rewrites (very expensive).
<2> Output diff in reverse. <2> Output diff in reverse.
CONFIGURATION
-------------
include::includes/cmd-config-section-all.txt[]
include::config/diff.txt[]
SEE ALSO SEE ALSO
-------- --------
diff(1), diff(1),

View File

@ -113,33 +113,14 @@ instead. `--no-symlinks` is the default on Windows.
See linkgit:git-diff[1] for the full list of supported options. See linkgit:git-diff[1] for the full list of supported options.
CONFIG VARIABLES CONFIGURATION
---------------- -------------
'git difftool' falls back to 'git mergetool' config variables when the 'git difftool' falls back to 'git mergetool' config variables when the
difftool equivalents have not been defined. difftool equivalents have not been defined.
diff.tool:: include::includes/cmd-config-section-rest.txt[]
The default diff tool to use.
diff.guitool:: include::config/difftool.txt[]
The default diff tool to use when `--gui` is specified.
difftool.<tool>.path::
Override the path for the given tool. This is useful in case
your tool is not in the PATH.
difftool.<tool>.cmd::
Specify the command to invoke the specified diff tool.
+
See the `--tool=<tool>` option above for more details.
difftool.prompt::
Prompt before each invocation of the diff tool.
difftool.trustExitCode::
Exit difftool if the invoked diff tool returns a non-zero exit status.
+
See the `--trust-exit-code` option above for more details.
SEE ALSO SEE ALSO
-------- --------

View File

@ -1564,6 +1564,13 @@ operator can use this facility to peek at the objects and refs from an
import in progress, at the cost of some added running time and worse import in progress, at the cost of some added running time and worse
compression. compression.
CONFIGURATION
-------------
include::includes/cmd-config-section-all.txt[]
include::config/fastimport.txt[]
SEE ALSO SEE ALSO
-------- --------
linkgit:git-fast-export[1] linkgit:git-fast-export[1]

View File

@ -285,6 +285,13 @@ linkgit:git-gc[1]).
include::transfer-data-leaks.txt[] include::transfer-data-leaks.txt[]
CONFIGURATION
-------------
include::includes/cmd-config-section-all.txt[]
include::config/fetch.txt[]
BUGS BUGS
---- ----
Using --recurse-submodules can only fetch new commits in submodules that are Using --recurse-submodules can only fetch new commits in submodules that are

View File

@ -107,6 +107,8 @@ care about this output and want to speed it up further.
CONFIGURATION CONFIGURATION
------------- -------------
include::includes/cmd-config-section-all.txt[]
include::config/fsck.txt[] include::config/fsck.txt[]
DISCUSSION DISCUSSION

View File

@ -110,8 +110,7 @@ users and their repositories.
CONFIGURATION CONFIGURATION
------------- -------------
The below documentation is the same as what's found in include::includes/cmd-config-section-all.txt[]
linkgit:git-config[1]:
include::config/gc.txt[] include::config/gc.txt[]

View File

@ -343,34 +343,9 @@ performance in this case, it might be desirable to use `--threads=1`.
CONFIGURATION CONFIGURATION
------------- -------------
grep.lineNumber:: include::includes/cmd-config-section-all.txt[]
If set to true, enable `-n` option by default.
grep.column::
If set to true, enable the `--column` option by default.
grep.patternType::
Set the default matching behavior. Using a value of 'basic', 'extended',
'fixed', or 'perl' will enable the `--basic-regexp`, `--extended-regexp`,
`--fixed-strings`, or `--perl-regexp` option accordingly, while the
value 'default' will return to the default matching behavior.
grep.extendedRegexp::
If set to true, enable `--extended-regexp` option by default. This
option is ignored when the `grep.patternType` option is set to a value
other than 'default'.
grep.threads::
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.
grep.fullName::
If set to true, enable `--full-name` option by default.
grep.fallbackToNoIndex::
If set to true, fall back to git grep --no-index if git grep
is executed outside of a git repository. Defaults to false.
include::config/grep.txt[]
GIT GIT
--- ---

View File

@ -54,6 +54,8 @@ CONFIGURATION
To use the tool, `imap.folder` and either `imap.tunnel` or `imap.host` must be set To use the tool, `imap.folder` and either `imap.tunnel` or `imap.host` must be set
to appropriate values. to appropriate values.
include::includes/cmd-config-section-rest.txt[]
include::config/imap.txt[] include::config/imap.txt[]
EXAMPLES EXAMPLES

View File

@ -169,6 +169,13 @@ $ git commit <3>
<2> Add all existing files to the index. <2> Add all existing files to the index.
<3> Record the pristine state as the first commit in the history. <3> Record the pristine state as the first commit in the history.
CONFIGURATION
-------------
include::includes/cmd-config-section-all.txt[]
include::config/init.txt[]
GIT GIT
--- ---
Part of the linkgit:git[1] suite Part of the linkgit:git[1] suite

View File

@ -209,47 +209,11 @@ i18n.logOutputEncoding::
Defaults to the value of `i18n.commitEncoding` if set, and UTF-8 Defaults to the value of `i18n.commitEncoding` if set, and UTF-8
otherwise. otherwise.
log.date:: include::includes/cmd-config-section-rest.txt[]
Default format for human-readable dates. (Compare the
`--date` option.) Defaults to "default", which means to write
dates like `Sat May 8 19:35:34 2010 -0500`.
+
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.
log.follow:: include::config/log.txt[]
If `true`, `git log` will act as if the `--follow` option was used when
a single <path> is given. This has the same limitations as `--follow`,
i.e. it cannot be used to follow multiple files and does not work well
on non-linear history.
log.showRoot:: include::config/notes.txt[]
If `false`, `git log` and related commands will not treat the
initial commit as a big creation event. Any root commits in
`git log -p` output would be shown without a diff attached.
The default is `true`.
log.showSignature::
If `true`, `git log` and related commands will act as if the
`--show-signature` option was passed to them.
mailmap.*::
See linkgit:git-shortlog[1].
notes.displayRef::
Which refs, in addition to the default set by `core.notesRef`
or `GIT_NOTES_REF`, to read notes from when showing commit
messages with the `log` family of commands. See
linkgit:git-notes[1].
+
May be an unabbreviated ref name or a glob and may be specified
multiple times. A warning will be issued for refs that do not exist,
but a glob that does not match any refs is silently ignored.
+
This setting can be disabled by the `--no-notes` option,
overridden by the `GIT_NOTES_DISPLAY_REF` environment variable,
and overridden by the `--notes=<ref>` option.
GIT GIT
--- ---

View File

@ -115,6 +115,13 @@ If no such configuration option has been set, `warn` will be used.
<patch>:: <patch>::
The patch extracted from e-mail. The patch extracted from e-mail.
CONFIGURATION
-------------
include::includes/cmd-config-section-all.txt[]
include::config/mailinfo.txt[]
GIT GIT
--- ---
Part of the linkgit:git[1] suite Part of the linkgit:git[1] suite

View File

@ -397,6 +397,13 @@ If you want to customize the background tasks, please rename the tasks
so future calls to `git maintenance (start|stop)` do not overwrite your so future calls to `git maintenance (start|stop)` do not overwrite your
custom tasks. custom tasks.
CONFIGURATION
-------------
include::includes/cmd-config-section-all.txt[]
include::config/maintenance.txt[]
GIT GIT
--- ---

View File

@ -383,13 +383,16 @@ include::merge-strategies.txt[]
CONFIGURATION CONFIGURATION
------------- -------------
include::config/merge.txt[]
branch.<name>.mergeOptions:: branch.<name>.mergeOptions::
Sets default options for merging into branch <name>. The syntax and Sets default options for merging into branch <name>. The syntax and
supported options are the same as those of 'git merge', but option supported options are the same as those of 'git merge', but option
values containing whitespace characters are currently not supported. values containing whitespace characters are currently not supported.
include::includes/cmd-config-section-rest.txt[]
include::config/merge.txt[]
SEE ALSO SEE ALSO
-------- --------
linkgit:git-fmt-merge-msg[1], linkgit:git-pull[1], linkgit:git-fmt-merge-msg[1], linkgit:git-pull[1],

View File

@ -102,6 +102,9 @@ success of the resolution after the custom tool has exited.
CONFIGURATION CONFIGURATION
------------- -------------
:git-mergetool: 1 :git-mergetool: 1
include::includes/cmd-config-section-all.txt[]
include::config/mergetool.txt[] include::config/mergetool.txt[]
TEMPORARY FILES TEMPORARY FILES

View File

@ -44,7 +44,7 @@ using the `--notes` option. Such notes are added as a patch commentary
after a three dash separator line. after a three dash separator line.
To change which notes are shown by 'git log', see the To change which notes are shown by 'git log', see the
"notes.displayRef" configuration in linkgit:git-log[1]. "notes.displayRef" discussion in <<CONFIGURATION>>.
See the "notes.rewrite.<command>" configuration for a way to carry See the "notes.rewrite.<command>" configuration for a way to carry
notes across commands that rewrite commits. notes across commands that rewrite commits.
@ -307,6 +307,7 @@ with 'git log', so if you use such notes, you'll probably need to write
some special-purpose tools to do something useful with them. some special-purpose tools to do something useful with them.
[[CONFIGURATION]]
CONFIGURATION CONFIGURATION
------------- -------------
@ -316,57 +317,9 @@ core.notesRef::
This setting can be overridden through the environment and This setting can be overridden through the environment and
command line. command line.
notes.mergeStrategy:: include::includes/cmd-config-section-rest.txt[]
Which merge strategy to choose by default when resolving notes
conflicts. Must be one of `manual`, `ours`, `theirs`, `union`, or
`cat_sort_uniq`. Defaults to `manual`. See "NOTES MERGE STRATEGIES"
section above for more information on each strategy.
+
This setting can be overridden by passing the `--strategy` option.
notes.<name>.mergeStrategy:: include::config/notes.txt[]
Which merge strategy to choose when doing a notes merge into
refs/notes/<name>. This overrides the more general
"notes.mergeStrategy". See the "NOTES MERGE STRATEGIES" section above
for more information on each available strategy.
notes.displayRef::
Which ref (or refs, if a glob or specified more than once), in
addition to the default set by `core.notesRef` or
`GIT_NOTES_REF`, to read notes from when showing commit
messages with the 'git log' family of commands.
This setting can be overridden on the command line or by the
`GIT_NOTES_DISPLAY_REF` environment variable.
See linkgit:git-log[1].
notes.rewrite.<command>::
When rewriting commits with <command> (currently `amend` or
`rebase`), if this variable is `false`, git will not copy
notes from the original to the rewritten commit. Defaults to
`true`. See also "`notes.rewriteRef`" below.
+
This setting can be overridden by the `GIT_NOTES_REWRITE_REF`
environment variable.
notes.rewriteMode::
When copying notes during a rewrite, what to do if the target
commit already has a note. Must be one of `overwrite`,
`concatenate`, `cat_sort_uniq`, or `ignore`. Defaults to
`concatenate`.
+
This setting can be overridden with the `GIT_NOTES_REWRITE_MODE`
environment variable.
notes.rewriteRef::
When copying notes during a rewrite, specifies the (fully
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.
+
Does not have a default value; you must configure this variable to
enable note rewriting.
+
Can be overridden with the `GIT_NOTES_REWRITE_REF` environment variable.
ENVIRONMENT ENVIRONMENT

View File

@ -692,6 +692,13 @@ a `git gc` command on the origin repository.
include::transfer-data-leaks.txt[] include::transfer-data-leaks.txt[]
CONFIGURATION
-------------
include::includes/cmd-config-section-all.txt[]
include::config/push.txt[]
GIT GIT
--- ---
Part of the linkgit:git[1] suite Part of the linkgit:git[1] suite

View File

@ -1259,6 +1259,8 @@ merge cmake
CONFIGURATION CONFIGURATION
------------- -------------
include::includes/cmd-config-section-all.txt[]
include::config/rebase.txt[] include::config/rebase.txt[]
include::config/sequencer.txt[] include::config/sequencer.txt[]

View File

@ -142,6 +142,13 @@ EXAMPLES
changes. The revert only modifies the working tree and the changes. The revert only modifies the working tree and the
index. index.
CONFIGURATION
-------------
include::includes/cmd-config-section-all.txt[]
include::config/revert.txt[]
SEE ALSO SEE ALSO
-------- --------
linkgit:git-cherry-pick[1] linkgit:git-cherry-pick[1]

View File

@ -456,41 +456,9 @@ Information
CONFIGURATION CONFIGURATION
------------- -------------
sendemail.aliasesFile:: include::includes/cmd-config-section-all.txt[]
To avoid typing long email addresses, point this to one or more
email aliases files. You must also supply `sendemail.aliasFileType`.
sendemail.aliasFileType:: include::config/sendemail.txt[]
Format of the file(s) specified in sendemail.aliasesFile. Must be
one of 'mutt', 'mailrc', 'pine', 'elm', or 'gnus', or 'sendmail'.
+
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:
+
--
sendmail;;
* Quoted aliases and quoted addresses are not supported: lines that
contain a `"` symbol are ignored.
* Redirection to a file (`/path/name`) or pipe (`|command`) is not
supported.
* File inclusion (`:include: /path/name`) is not supported.
* Warnings are printed on the standard error output for any
explicitly unsupported constructs, and any other lines that are not
recognized by the parser.
--
sendemail.multiEdit::
If true (default), a single editor instance will be spawned to edit
files you have to edit (patches when `--annotate` is used, and the
summary when `--compose` is used). If false, files will be edited one
after the other, spawning a new editor each time.
sendemail.confirm::
Sets the default for whether to confirm before sending. Must be
one of 'always', 'never', 'cc', 'compose', or 'auto'. See `--confirm`
in the previous section for the meaning of these values.
EXAMPLES EXAMPLES
-------- --------

View File

@ -199,6 +199,13 @@ shows 10 reflog entries going back from the tip as of 1 hour ago.
Without `--list`, the output also shows how these tips are Without `--list`, the output also shows how these tips are
topologically related with each other. topologically related with each other.
CONFIGURATION
-------------
include::includes/cmd-config-section-all.txt[]
include::config/showbranch.txt[]
GIT GIT
--- ---
Part of the linkgit:git[1] suite Part of the linkgit:git[1] suite

View File

@ -382,6 +382,13 @@ grep commit | cut -d\ -f3 |
xargs git log --merges --no-walk --grep=WIP xargs git log --merges --no-walk --grep=WIP
---------------------------------------------------------------- ----------------------------------------------------------------
CONFIGURATION
-------------
include::includes/cmd-config-section-all.txt[]
include::config/stash.txt[]
SEE ALSO SEE ALSO
-------- --------

View File

@ -265,6 +265,13 @@ always create a new name for it (without switching away):
$ git switch -c good-surprises $ git switch -c good-surprises
------------ ------------
CONFIGURATION
-------------
include::includes/cmd-config-section-all.txt[]
include::config/checkout.txt[]
SEE ALSO SEE ALSO
-------- --------
linkgit:git-checkout[1], linkgit:git-checkout[1],

View File

@ -0,0 +1,3 @@
Everything below this line in this section is selectively included
from the linkgit:git-config[1] documentation. The content is the same
as what's found there:

View File

@ -0,0 +1,3 @@
Everything above this line in this section isn't included from the
linkgit:git-config[1] documentation. The content that follows is the
same as what's found there: