doc: convert git-mergetool options to new synopsis style

Git fork

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

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 9 months ago d30c5cc4 16543967

+35 -35

2 changed files

expand all

Documentation

config

mergetool.adoc

mergetools

vimdiff.adoc

+27 -27

Documentation/config/mergetool.adoc

··· 1 - mergetool.<tool>.path:: 1 + `mergetool.<tool>.path`:: 2 2 Override the path for the given tool. This is useful in case 3 - your tool is not in the PATH. 3 + your tool is not in the `$PATH`. 4 4 5 - mergetool.<tool>.cmd:: 5 + `mergetool.<tool>.cmd`:: 6 6 Specify the command to invoke the specified merge tool. The 7 7 specified command is evaluated in shell with the following 8 - variables available: 'BASE' is the name of a temporary file 8 + variables available: `BASE` is the name of a temporary file 9 9 containing the common base of the files to be merged, if available; 10 - 'LOCAL' is the name of a temporary file containing the contents of 11 - the file on the current branch; 'REMOTE' is the name of a temporary 10 + `LOCAL` is the name of a temporary file containing the contents of 11 + the file on the current branch; `REMOTE` is the name of a temporary 12 12 file containing the contents of the file from the branch being 13 - merged; 'MERGED' contains the name of the file to which the merge 13 + merged; `MERGED` contains the name of the file to which the merge 14 14 tool should write the results of a successful merge. 15 15 16 - mergetool.<tool>.hideResolved:: 16 + `mergetool.<tool>.hideResolved`:: 17 17 Allows the user to override the global `mergetool.hideResolved` value 18 18 for a specific tool. See `mergetool.hideResolved` for the full 19 19 description. 20 20 21 - mergetool.<tool>.trustExitCode:: 21 + `mergetool.<tool>.trustExitCode`:: 22 22 For a custom merge command, specify whether the exit code of 23 23 the merge command can be used to determine whether the merge was 24 24 successful. If this is not set to true then the merge target file ··· 26 26 if the file has been updated; otherwise, the user is prompted to 27 27 indicate the success of the merge. 28 28 29 - mergetool.meld.hasOutput:: 29 + `mergetool.meld.hasOutput`:: 30 30 Older versions of `meld` do not support the `--output` option. 31 31 Git will attempt to detect whether `meld` supports `--output` 32 32 by inspecting the output of `meld --help`. Configuring ··· 35 35 to `true` tells Git to unconditionally use the `--output` option, 36 36 and `false` avoids using `--output`. 37 37 38 - mergetool.meld.useAutoMerge:: 38 + `mergetool.meld.useAutoMerge`:: 39 39 When the `--auto-merge` is given, meld will merge all non-conflicting 40 40 parts automatically, highlight the conflicting parts, and wait for 41 41 user decision. Setting `mergetool.meld.useAutoMerge` to `true` tells ··· 45 45 value of `false` avoids using `--auto-merge` altogether, and is the 46 46 default value. 47 47 48 - mergetool.<vimdiff variant>.layout:: 49 - Configure the split window layout for vimdiff's `<variant>`, which is any of `vimdiff`, 48 + `mergetool.<variant>.layout`:: 49 + Configure the split window layout for vimdiff's _<variant>_, which is any of `vimdiff`, 50 50 `nvimdiff`, `gvimdiff`. 51 51 Upon launching `git mergetool` with `--tool=<variant>` (or without `--tool` 52 - if `merge.tool` is configured as `<variant>`), Git will consult 52 + if `merge.tool` is configured as _<variant>_), Git will consult 53 53 `mergetool.<variant>.layout` to determine the tool's layout. If the 54 - variant-specific configuration is not available, `vimdiff`'s is used as 54 + variant-specific configuration is not available, `vimdiff` ' s is used as 55 55 fallback. If that too is not available, a default layout with 4 windows 56 - will be used. To configure the layout, see the `BACKEND SPECIFIC HINTS` 56 + will be used. To configure the layout, see the 'BACKEND SPECIFIC HINTS' 57 57 ifdef::git-mergetool[] 58 58 section. 59 59 endif::[] ··· 61 61 section in linkgit:git-mergetool[1]. 62 62 endif::[] 63 63 64 - mergetool.hideResolved:: 64 + `mergetool.hideResolved`:: 65 65 During a merge, Git will automatically resolve as many conflicts as 66 - possible and write the 'MERGED' file containing conflict markers around 67 - any conflicts that it cannot resolve; 'LOCAL' and 'REMOTE' normally 68 - represent the versions of the file from before Git's conflict 69 - resolution. This flag causes 'LOCAL' and 'REMOTE' to be overwritten so 66 + possible and write the `$MERGED` file containing conflict markers around 67 + any conflicts that it cannot resolve; `$LOCAL` and `$REMOTE` normally 68 + are the versions of the file from before Git`s conflict 69 + resolution. This flag causes `$LOCAL` and `$REMOTE` to be overwritten so 70 70 that only the unresolved conflicts are presented to the merge tool. Can 71 71 be configured per-tool via the `mergetool.<tool>.hideResolved` 72 72 configuration variable. Defaults to `false`. 73 73 74 - mergetool.keepBackup:: 74 + `mergetool.keepBackup`:: 75 75 After performing a merge, the original file with conflict markers 76 76 can be saved as a file with a `.orig` extension. If this variable 77 77 is set to `false` then this file is not preserved. Defaults to 78 78 `true` (i.e. keep the backup files). 79 79 80 - mergetool.keepTemporaries:: 80 + `mergetool.keepTemporaries`:: 81 81 When invoking a custom merge tool, Git uses a set of temporary 82 82 files to pass to the tool. If the tool returns an error and this 83 83 variable is set to `true`, then these temporary files will be 84 84 preserved; otherwise, they will be removed after the tool has 85 85 exited. Defaults to `false`. 86 86 87 - mergetool.writeToTemp:: 88 - Git writes temporary 'BASE', 'LOCAL', and 'REMOTE' versions of 87 + `mergetool.writeToTemp`:: 88 + Git writes temporary `BASE`, `LOCAL`, and `REMOTE` versions of 89 89 conflicting files in the worktree by default. Git will attempt 90 90 to use a temporary directory for these files when set `true`. 91 91 Defaults to `false`. 92 92 93 - mergetool.prompt:: 93 + `mergetool.prompt`:: 94 94 Prompt before each invocation of the merge resolution program. 95 95 96 - mergetool.guiDefault:: 96 + `mergetool.guiDefault`:: 97 97 Set `true` to use the `merge.guitool` by default (equivalent to 98 98 specifying the `--gui` argument), or `auto` to select `merge.guitool` 99 99 or `merge.tool` depending on the presence of a `DISPLAY` environment

+8 -8

Documentation/mergetools/vimdiff.adoc

··· 183 183 In addition, for backwards compatibility with previous Git versions, you can 184 184 also append `1`, `2` or `3` to either `vimdiff` or any of the variants (ex: 185 185 `vimdiff3`, `nvimdiff1`, etc...) to use a predefined layout. 186 - In other words, using `--tool=[g,n,]vimdiffx` is the same as using 187 - `--tool=[g,n,]vimdiff` and setting configuration variable 188 - `mergetool.[g,n,]vimdiff.layout` to... 186 + In other words, using `--tool=[g|n]vimdiff<x>` is the same as using 187 + `--tool=[g|n]vimdiff` and setting configuration variable 188 + `mergetool.[g|n]vimdiff.layout` to... 189 189 190 - * `x=1`: `"@LOCAL, REMOTE"` 191 - * `x=2`: `"LOCAL, MERGED, REMOTE"` 192 - * `x=3`: `"MERGED"` 190 + * `<x>=1`: `"@LOCAL, REMOTE"` 191 + * `<x>=2`: `"LOCAL, MERGED, REMOTE"` 192 + * `<x>=3`: `"MERGED"` 193 193 194 - Example: using `--tool=gvimdiff2` will open `gvim` with three columns (LOCAL, 195 - MERGED and REMOTE). 194 + Example: using `--tool=gvimdiff2` will open `gvim` with three columns (`LOCAL`, 195 + `MERGED` and `REMOTE`).