Git fork

doc: switch merge config description to new synopsis format

- 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>

authored by

Jean-Noël Avila and committed by
Junio C Hamano
90a837a7 179f877b

+47 -43
+4 -4
Documentation/config/fmt-merge-msg.adoc
··· 1 - merge.branchdesc:: 2 In addition to branch names, populate the log message with 3 the branch description text associated with them. Defaults 4 to false. 5 6 - merge.log:: 7 In addition to branch names, populate the log message with at 8 most the specified number of one-line descriptions from the 9 actual commits that are being merged. Defaults to false, and 10 true is a synonym for 20. 11 12 - merge.suppressDest:: 13 By adding a glob that matches the names of integration 14 branches to this multi-valued configuration variable, the 15 default merge message computed for merges into these 16 - integration branches will omit "into <branch name>" from 17 its title. 18 + 19 An element with an empty value can be used to clear the list
··· 1 + `merge.branchdesc`:: 2 In addition to branch names, populate the log message with 3 the branch description text associated with them. Defaults 4 to false. 5 6 + `merge.log`:: 7 In addition to branch names, populate the log message with at 8 most the specified number of one-line descriptions from the 9 actual commits that are being merged. Defaults to false, and 10 true is a synonym for 20. 11 12 + `merge.suppressDest`:: 13 By adding a glob that matches the names of integration 14 branches to this multi-valued configuration variable, the 15 default merge message computed for merges into these 16 + integration branches will omit "into _<branch-name>_" from 17 its title. 18 + 19 An element with an empty value can be used to clear the list
+43 -39
Documentation/config/merge.adoc
··· 1 - merge.conflictStyle:: 2 Specify the style in which conflicted hunks are written out to 3 working tree files upon merge. The default is "merge", which 4 - shows a `<<<<<<<` conflict marker, changes made by one side, 5 a `=======` marker, changes made by the other side, and then 6 - a `>>>>>>>` marker. An alternate style, "diff3", adds a `|||||||` 7 marker and the original text before the `=======` marker. The 8 "merge" style tends to produce smaller conflict regions than diff3, 9 both because of the exclusion of the original text, and because ··· 13 the conflict region when those matching lines appear near either 14 the beginning or end of a conflict region. 15 16 - merge.defaultToUpstream:: 17 If merge is called without any commit argument, merge the upstream 18 branches configured for the current branch by using their last 19 observed values stored in their remote-tracking branches. 20 The values of the `branch.<current branch>.merge` that name the 21 - branches at the remote named by `branch.<current branch>.remote` 22 are consulted, and then they are mapped via `remote.<remote>.fetch` 23 to their corresponding remote-tracking branches, and the tips of 24 these tracking branches are merged. Defaults to true. 25 26 - merge.ff:: 27 By default, Git does not create an extra merge commit when merging 28 a commit that is a descendant of the current commit. Instead, the 29 tip of the current branch is fast-forwarded. When set to `false`, ··· 33 allowed (equivalent to giving the `--ff-only` option from the 34 command line). 35 36 - merge.verifySignatures:: 37 - If true, this is equivalent to the --verify-signatures command 38 line option. See linkgit:git-merge[1] for details. 39 40 include::fmt-merge-msg.adoc[] 41 42 - merge.renameLimit:: 43 The number of files to consider in the exhaustive portion of 44 rename detection during a merge. If not specified, defaults 45 - to the value of diff.renameLimit. If neither 46 - merge.renameLimit nor diff.renameLimit are specified, 47 currently defaults to 7000. This setting has no effect if 48 rename detection is turned off. 49 50 - merge.renames:: 51 - Whether Git detects renames. If set to "false", rename detection 52 - is disabled. If set to "true", basic rename detection is enabled. 53 Defaults to the value of diff.renames. 54 55 - merge.directoryRenames:: 56 Whether Git detects directory renames, affecting what happens at 57 merge time to new files added to a directory on one side of 58 history when that directory was renamed on the other side of 59 - history. If merge.directoryRenames is set to "false", directory 60 - rename detection is disabled, meaning that such new files will be 61 - left behind in the old directory. If set to "true", directory 62 - rename detection is enabled, meaning that such new files will be 63 - moved into the new directory. If set to "conflict", a conflict 64 - will be reported for such paths. If merge.renames is false, 65 - merge.directoryRenames is ignored and treated as false. Defaults 66 - to "conflict". 67 68 - merge.renormalize:: 69 Tell Git that canonical representation of files in the 70 repository has changed over time (e.g. earlier commits record 71 - text files with CRLF line endings, but recent ones use LF line 72 endings). In such a repository, for each file where a 73 three-way content merge is needed, Git can convert the data 74 recorded in commits to a canonical form before performing a ··· 76 see section "Merging branches with differing checkin/checkout 77 attributes" in linkgit:gitattributes[5]. 78 79 - merge.stat:: 80 - Whether to print the diffstat between ORIG_HEAD and the merge result 81 at the end of the merge. True by default. 82 83 - merge.autoStash:: 84 - When set to true, automatically create a temporary stash entry 85 before the operation begins, and apply it after the operation 86 ends. This means that you can run merge on a dirty worktree. 87 However, use with care: the final stash application after a 88 successful merge might result in non-trivial conflicts. 89 This option can be overridden by the `--no-autostash` and 90 `--autostash` options of linkgit:git-merge[1]. 91 - Defaults to false. 92 93 - merge.tool:: 94 Controls which merge tool is used by linkgit:git-mergetool[1]. 95 The list below shows the valid built-in values. 96 Any other value is treated as a custom merge tool and requires 97 - that a corresponding mergetool.<tool>.cmd variable is defined. 98 99 - merge.guitool:: 100 Controls which merge tool is used by linkgit:git-mergetool[1] when the 101 - -g/--gui flag is specified. The list below shows the valid built-in values. 102 Any other value is treated as a custom merge tool and requires that a 103 - corresponding mergetool.<guitool>.cmd variable is defined. 104 105 include::{build_dir}/mergetools-merge.adoc[] 106 107 - merge.verbosity:: 108 Controls the amount of output shown by the recursive merge 109 strategy. Level 0 outputs nothing except a final error 110 message if conflicts were detected. Level 1 outputs only ··· 112 above outputs debugging information. The default is level 2. 113 Can be overridden by the `GIT_MERGE_VERBOSITY` environment variable. 114 115 - merge.<driver>.name:: 116 Defines a human-readable name for a custom low-level 117 merge driver. See linkgit:gitattributes[5] for details. 118 119 - merge.<driver>.driver:: 120 Defines the command that implements a custom low-level 121 merge driver. See linkgit:gitattributes[5] for details. 122 123 - merge.<driver>.recursive:: 124 Names a low-level merge driver to be used when 125 performing an internal merge between common ancestors. 126 See linkgit:gitattributes[5] for details.
··· 1 + `merge.conflictStyle`:: 2 Specify the style in which conflicted hunks are written out to 3 working tree files upon merge. The default is "merge", which 4 + shows a +<<<<<<<+ conflict marker, changes made by one side, 5 a `=======` marker, changes made by the other side, and then 6 + a +>>>>>>>+ marker. An alternate style, "diff3", adds a +|||||||+ 7 marker and the original text before the `=======` marker. The 8 "merge" style tends to produce smaller conflict regions than diff3, 9 both because of the exclusion of the original text, and because ··· 13 the conflict region when those matching lines appear near either 14 the beginning or end of a conflict region. 15 16 + `merge.defaultToUpstream`:: 17 If merge is called without any commit argument, merge the upstream 18 branches configured for the current branch by using their last 19 observed values stored in their remote-tracking branches. 20 The values of the `branch.<current branch>.merge` that name the 21 + branches at the remote named by `branch.<current-branch>.remote` 22 are consulted, and then they are mapped via `remote.<remote>.fetch` 23 to their corresponding remote-tracking branches, and the tips of 24 these tracking branches are merged. Defaults to true. 25 26 + `merge.ff`:: 27 By default, Git does not create an extra merge commit when merging 28 a commit that is a descendant of the current commit. Instead, the 29 tip of the current branch is fast-forwarded. When set to `false`, ··· 33 allowed (equivalent to giving the `--ff-only` option from the 34 command line). 35 36 + `merge.verifySignatures`:: 37 + If true, this is equivalent to the `--verify-signatures` command 38 line option. See linkgit:git-merge[1] for details. 39 40 include::fmt-merge-msg.adoc[] 41 42 + `merge.renameLimit`:: 43 The number of files to consider in the exhaustive portion of 44 rename detection during a merge. If not specified, defaults 45 + to the value of `diff.renameLimit`. If neither 46 + `merge.renameLimit` nor `diff.renameLimit` are specified, 47 currently defaults to 7000. This setting has no effect if 48 rename detection is turned off. 49 50 + `merge.renames`:: 51 + Whether Git detects renames. If set to `false`, rename detection 52 + is disabled. If set to `true`, basic rename detection is enabled. 53 Defaults to the value of diff.renames. 54 55 + `merge.directoryRenames`:: 56 Whether Git detects directory renames, affecting what happens at 57 merge time to new files added to a directory on one side of 58 history when that directory was renamed on the other side of 59 + history. Possible values are: 60 + + 61 + -- 62 + `false`;; Directory rename detection is disabled, meaning that such new files will be 63 + left behind in the old directory. 64 + `true`;; Directory rename detection is enabled, meaning that such new files will be 65 + moved into the new directory. 66 + `conflict`;; A conflict will be reported for such paths. 67 + -- 68 + + 69 + If `merge.renames` is `false`, `merge.directoryRenames` is ignored and treated 70 + as `false`. Defaults to `conflict`. 71 72 + `merge.renormalize`:: 73 Tell Git that canonical representation of files in the 74 repository has changed over time (e.g. earlier commits record 75 + text files with _CRLF_ line endings, but recent ones use _LF_ line 76 endings). In such a repository, for each file where a 77 three-way content merge is needed, Git can convert the data 78 recorded in commits to a canonical form before performing a ··· 80 see section "Merging branches with differing checkin/checkout 81 attributes" in linkgit:gitattributes[5]. 82 83 + `merge.stat`:: 84 + Whether to print the diffstat between `ORIG_HEAD` and the merge result 85 at the end of the merge. True by default. 86 87 + `merge.autoStash`:: 88 + When set to `true`, automatically create a temporary stash entry 89 before the operation begins, and apply it after the operation 90 ends. This means that you can run merge on a dirty worktree. 91 However, use with care: the final stash application after a 92 successful merge might result in non-trivial conflicts. 93 This option can be overridden by the `--no-autostash` and 94 `--autostash` options of linkgit:git-merge[1]. 95 + Defaults to `false`. 96 97 + `merge.tool`:: 98 Controls which merge tool is used by linkgit:git-mergetool[1]. 99 The list below shows the valid built-in values. 100 Any other value is treated as a custom merge tool and requires 101 + that a corresponding `mergetool.<tool>.cmd` variable is defined. 102 103 + `merge.guitool`:: 104 Controls which merge tool is used by linkgit:git-mergetool[1] when the 105 + `-g`/`--gui` flag is specified. The list below shows the valid built-in values. 106 Any other value is treated as a custom merge tool and requires that a 107 + corresponding `mergetool.<guitool>.cmd` variable is defined. 108 109 include::{build_dir}/mergetools-merge.adoc[] 110 111 + `merge.verbosity`:: 112 Controls the amount of output shown by the recursive merge 113 strategy. Level 0 outputs nothing except a final error 114 message if conflicts were detected. Level 1 outputs only ··· 116 above outputs debugging information. The default is level 2. 117 Can be overridden by the `GIT_MERGE_VERBOSITY` environment variable. 118 119 + `merge.<driver>.name`:: 120 Defines a human-readable name for a custom low-level 121 merge driver. See linkgit:gitattributes[5] for details. 122 123 + `merge.<driver>.driver`:: 124 Defines the command that implements a custom low-level 125 merge driver. See linkgit:gitattributes[5] for details. 126 127 + `merge.<driver>.recursive`:: 128 Names a low-level merge driver to be used when 129 performing an internal merge between common ancestors. 130 See linkgit:gitattributes[5] for details.