global/git
1
0
Fork 0
mirror of https://github.com/git/git.git synced 2026-01-10 10:13:33 +00:00
Code Issues Packages Projects Releases Wiki Activity

doc: switch merge config description to new synopsis format

Browse Source 
- Use _<placeholder>_ instead of <placeholder> in the description
- Use `backticks` for keywords and more complex option
descriptions. The new rendering engine will apply synopsis rules to
these spans.

Additionally, a list of option possible values has been reformatted as a
standalone definition list.

Signed-off-by: Jean-Noël Avila <jn.avila@free.fr>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
This commit is contained in:
Jean-Noël Avila
2025-05-25 20:27:06 +00:00
committed by Junio C Hamano
parent 179f877b88
commit 90a837a720
2 changed files with 47 additions and 43 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
Documentation/config/fmt-merge-msg.adoc
View File

@@ -1,19 +1,19 @@
merge.branchdesc:: `merge.branchdesc`::
In addition to branch names, populate the log message with In addition to branch names, populate the log message with
the branch description text associated with them. Defaults the branch description text associated with them. Defaults
to false. to false.
merge.log:: `merge.log`::
In addition to branch names, populate the log message with at In addition to branch names, populate the log message with at
most the specified number of one-line descriptions from the most the specified number of one-line descriptions from the
actual commits that are being merged. Defaults to false, and actual commits that are being merged. Defaults to false, and
true is a synonym for 20. true is a synonym for 20.
merge.suppressDest:: `merge.suppressDest`::
By adding a glob that matches the names of integration By adding a glob that matches the names of integration
branches to this multi-valued configuration variable, the branches to this multi-valued configuration variable, the
default merge message computed for merges into these default merge message computed for merges into these
integration branches will omit "into <branch name>" from integration branches will omit "into _<branch-name>_" from
its title. its title.
+ +
An element with an empty value can be used to clear the list An element with an empty value can be used to clear the list

82
Documentation/config/merge.adoc
View File

@@ -1,9 +1,9 @@
merge.conflictStyle:: `merge.conflictStyle`::
Specify the style in which conflicted hunks are written out to Specify the style in which conflicted hunks are written out to
working tree files upon merge. The default is "merge", which working tree files upon merge. The default is "merge", which
shows a `<<<<<<<` conflict marker, changes made by one side, shows a +<<<<<<<+ conflict marker, changes made by one side,
a `=======` marker, changes made by the other side, and then a `=======` marker, changes made by the other side, and then
a `>>>>>>>` marker. An alternate style, "diff3", adds a `|||||||` a +>>>>>>>+ marker. An alternate style, "diff3", adds a +|||||||+
marker and the original text before the `=======` marker. The marker and the original text before the `=======` marker. The
"merge" style tends to produce smaller conflict regions than diff3, "merge" style tends to produce smaller conflict regions than diff3,
both because of the exclusion of the original text, and because both because of the exclusion of the original text, and because
@@ -13,17 +13,17 @@ merge.conflictStyle::
the conflict region when those matching lines appear near either the conflict region when those matching lines appear near either
the beginning or end of a conflict region. the beginning or end of a conflict region.
merge.defaultToUpstream:: `merge.defaultToUpstream`::
If merge is called without any commit argument, merge the upstream If merge is called without any commit argument, merge the upstream
branches configured for the current branch by using their last branches configured for the current branch by using their last
observed values stored in their remote-tracking branches. observed values stored in their remote-tracking branches.
The values of the `branch.<current branch>.merge` that name the The values of the `branch.<current branch>.merge` that name the
branches at the remote named by `branch.<current branch>.remote` branches at the remote named by `branch.<current-branch>.remote`
are consulted, and then they are mapped via `remote.<remote>.fetch` are consulted, and then they are mapped via `remote.<remote>.fetch`
to their corresponding remote-tracking branches, and the tips of to their corresponding remote-tracking branches, and the tips of
these tracking branches are merged. Defaults to true. these tracking branches are merged. Defaults to true.
merge.ff:: `merge.ff`::
By default, Git does not create an extra merge commit when merging By default, Git does not create an extra merge commit when merging
a commit that is a descendant of the current commit. Instead, the a commit that is a descendant of the current commit. Instead, the
tip of the current branch is fast-forwarded. When set to `false`, tip of the current branch is fast-forwarded. When set to `false`,
@@ -33,42 +33,46 @@ merge.ff::
allowed (equivalent to giving the `--ff-only` option from the allowed (equivalent to giving the `--ff-only` option from the
command line). command line).
merge.verifySignatures:: `merge.verifySignatures`::
If true, this is equivalent to the --verify-signatures command If true, this is equivalent to the `--verify-signatures` command
line option. See linkgit:git-merge[1] for details. line option. See linkgit:git-merge[1] for details.
include::fmt-merge-msg.adoc[] include::fmt-merge-msg.adoc[]
merge.renameLimit:: `merge.renameLimit`::
The number of files to consider in the exhaustive portion of The number of files to consider in the exhaustive portion of
rename detection during a merge. If not specified, defaults rename detection during a merge. If not specified, defaults
to the value of diff.renameLimit. If neither to the value of `diff.renameLimit`. If neither
merge.renameLimit nor diff.renameLimit are specified, `merge.renameLimit` nor `diff.renameLimit` are specified,
currently defaults to 7000. This setting has no effect if currently defaults to 7000. This setting has no effect if
rename detection is turned off. rename detection is turned off.
merge.renames:: `merge.renames`::
Whether Git detects renames. If set to "false", rename detection Whether Git detects renames. If set to `false`, rename detection
is disabled. If set to "true", basic rename detection is enabled. is disabled. If set to `true`, basic rename detection is enabled.
Defaults to the value of diff.renames. Defaults to the value of diff.renames.
merge.directoryRenames:: `merge.directoryRenames`::
Whether Git detects directory renames, affecting what happens at Whether Git detects directory renames, affecting what happens at
merge time to new files added to a directory on one side of merge time to new files added to a directory on one side of
history when that directory was renamed on the other side of history when that directory was renamed on the other side of
history. If merge.directoryRenames is set to "false", directory history. Possible values are:
rename detection is disabled, meaning that such new files will be +
left behind in the old directory. If set to "true", directory --
rename detection is enabled, meaning that such new files will be `false`;; Directory rename detection is disabled, meaning that such new files will be
moved into the new directory. If set to "conflict", a conflict left behind in the old directory.
will be reported for such paths. If merge.renames is false, `true`;; Directory rename detection is enabled, meaning that such new files will be
merge.directoryRenames is ignored and treated as false. Defaults moved into the new directory.
to "conflict". `conflict`;; A conflict will be reported for such paths.
--
+
If `merge.renames` is `false`, `merge.directoryRenames` is ignored and treated
as `false`. Defaults to `conflict`.
merge.renormalize:: `merge.renormalize`::
Tell Git that canonical representation of files in the Tell Git that canonical representation of files in the
repository has changed over time (e.g. earlier commits record repository has changed over time (e.g. earlier commits record
text files with CRLF line endings, but recent ones use LF line text files with _CRLF_ line endings, but recent ones use _LF_ line
endings). In such a repository, for each file where a endings). In such a repository, for each file where a
three-way content merge is needed, Git can convert the data three-way content merge is needed, Git can convert the data
recorded in commits to a canonical form before performing a recorded in commits to a canonical form before performing a
@@ -76,35 +80,35 @@ merge.renormalize::
see section "Merging branches with differing checkin/checkout see section "Merging branches with differing checkin/checkout
attributes" in linkgit:gitattributes[5]. attributes" in linkgit:gitattributes[5].
merge.stat:: `merge.stat`::
Whether to print the diffstat between ORIG_HEAD and the merge result Whether to print the diffstat between `ORIG_HEAD` and the merge result
at the end of the merge. True by default. at the end of the merge. True by default.
merge.autoStash:: `merge.autoStash`::
When set to true, automatically create a temporary stash entry When set to `true`, automatically create a temporary stash entry
before the operation begins, and apply it after the operation before the operation begins, and apply it after the operation
ends. This means that you can run merge on a dirty worktree. ends. This means that you can run merge on a dirty worktree.
However, use with care: the final stash application after a However, use with care: the final stash application after a
successful merge might result in non-trivial conflicts. successful merge might result in non-trivial conflicts.
This option can be overridden by the `--no-autostash` and This option can be overridden by the `--no-autostash` and
`--autostash` options of linkgit:git-merge[1]. `--autostash` options of linkgit:git-merge[1].
Defaults to false. Defaults to `false`.
merge.tool:: `merge.tool`::
Controls which merge tool is used by linkgit:git-mergetool[1]. Controls which merge tool is used by linkgit:git-mergetool[1].
The list below shows the valid built-in values. The list below shows the valid built-in values.
Any other value is treated as a custom merge tool and requires Any other value is treated as a custom merge tool and requires
that a corresponding mergetool.<tool>.cmd variable is defined. that a corresponding `mergetool.<tool>.cmd` variable is defined.
merge.guitool:: `merge.guitool`::
Controls which merge tool is used by linkgit:git-mergetool[1] when the Controls which merge tool is used by linkgit:git-mergetool[1] when the
-g/--gui flag is specified. The list below shows the valid built-in values. `-g`/`--gui` flag is specified. The list below shows the valid built-in values.
Any other value is treated as a custom merge tool and requires that a Any other value is treated as a custom merge tool and requires that a
corresponding mergetool.<guitool>.cmd variable is defined. corresponding `mergetool.<guitool>.cmd` variable is defined.
include::{build_dir}/mergetools-merge.adoc[] include::{build_dir}/mergetools-merge.adoc[]
merge.verbosity:: `merge.verbosity`::
Controls the amount of output shown by the recursive merge Controls the amount of output shown by the recursive merge
strategy. Level 0 outputs nothing except a final error strategy. Level 0 outputs nothing except a final error
message if conflicts were detected. Level 1 outputs only message if conflicts were detected. Level 1 outputs only
@@ -112,15 +116,15 @@ merge.verbosity::
above outputs debugging information. The default is level 2. above outputs debugging information. The default is level 2.
Can be overridden by the `GIT_MERGE_VERBOSITY` environment variable. Can be overridden by the `GIT_MERGE_VERBOSITY` environment variable.
merge.<driver>.name:: `merge.<driver>.name`::
Defines a human-readable name for a custom low-level Defines a human-readable name for a custom low-level
merge driver. See linkgit:gitattributes[5] for details. merge driver. See linkgit:gitattributes[5] for details.
merge.<driver>.driver:: `merge.<driver>.driver`::
Defines the command that implements a custom low-level Defines the command that implements a custom low-level
merge driver. See linkgit:gitattributes[5] for details. merge driver. See linkgit:gitattributes[5] for details.
merge.<driver>.recursive:: `merge.<driver>.recursive`::
Names a low-level merge driver to be used when Names a low-level merge driver to be used when
performing an internal merge between common ancestors. performing an internal merge between common ancestors.
See linkgit:gitattributes[5] for details. See linkgit:gitattributes[5] for details.