Skip to content

Commit 1654396

Browse files
jnavilagitster
authored andcommitted
doc: convert git-mergetool manpage to new synopsis style
- Switch the synopsis to a synopsis block which will automatically format placeholders in italics and keywords in monospace - 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 <[email protected]> Signed-off-by: Junio C Hamano <[email protected]>
1 parent 90a837a commit 1654396

File tree

1 file changed

+31
-31
lines changed

1 file changed

+31
-31
lines changed

Documentation/git-mergetool.adoc

Lines changed: 31 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -7,95 +7,95 @@ git-mergetool - Run merge conflict resolution tools to resolve merge conflicts
77

88
SYNOPSIS
99
--------
10-
[verse]
11-
'git mergetool' [--tool=<tool>] [-y | --[no-]prompt] [<file>...]
10+
[synopsis]
11+
git mergetool [--tool=<tool>] [-y | --[no-]prompt] [<file>...]
1212

1313
DESCRIPTION
1414
-----------
1515

1616
Use `git mergetool` to run one of several merge utilities to resolve
17-
merge conflicts. It is typically run after 'git merge'.
17+
merge conflicts. It is typically run after `git merge`.
1818

1919
If one or more <file> parameters are given, the merge tool program will
2020
be run to resolve differences in each file (skipping those without
2121
conflicts). Specifying a directory will include all unresolved files in
22-
that path. If no <file> names are specified, 'git mergetool' will run
22+
that path. If no _<file>_ names are specified, `git mergetool` will run
2323
the merge tool program on every file with merge conflicts.
2424

2525
OPTIONS
2626
-------
27-
-t <tool>::
28-
--tool=<tool>::
29-
Use the merge resolution program specified by <tool>.
30-
Valid values include emerge, gvimdiff, kdiff3,
31-
meld, vimdiff, and tortoisemerge. Run `git mergetool --tool-help`
32-
for the list of valid <tool> settings.
27+
`-t <tool>`::
28+
`--tool=<tool>`::
29+
Use the merge resolution program specified by _<tool>_.
30+
Valid values include `emerge`, `gvimdiff`, `kdiff3`,
31+
`meld`, `vimdiff`, and `tortoisemerge`. Run `git mergetool --tool-help`
32+
for the list of valid _<tool>_ settings.
3333
+
34-
If a merge resolution program is not specified, 'git mergetool'
34+
If a merge resolution program is not specified, `git mergetool`
3535
will use the configuration variable `merge.tool`. If the
36-
configuration variable `merge.tool` is not set, 'git mergetool'
36+
configuration variable `merge.tool` is not set, `git mergetool`
3737
will pick a suitable default.
3838
+
3939
You can explicitly provide a full path to the tool by setting the
4040
configuration variable `mergetool.<tool>.path`. For example, you
4141
can configure the absolute path to kdiff3 by setting
42-
`mergetool.kdiff3.path`. Otherwise, 'git mergetool' assumes the
43-
tool is available in PATH.
42+
`mergetool.kdiff3.path`. Otherwise, `git mergetool` assumes the
43+
tool is available in `$PATH`.
4444
+
4545
Instead of running one of the known merge tool programs,
46-
'git mergetool' can be customized to run an alternative program
46+
`git mergetool` can be customized to run an alternative program
4747
by specifying the command line to invoke in a configuration
4848
variable `mergetool.<tool>.cmd`.
4949
+
50-
When 'git mergetool' is invoked with this tool (either through the
50+
When `git mergetool` is invoked with this tool (either through the
5151
`-t` or `--tool` option or the `merge.tool` configuration
52-
variable), the configured command line will be invoked with `$BASE`
52+
variable), the configured command line will be invoked with `BASE`
5353
set to the name of a temporary file containing the common base for
54-
the merge, if available; `$LOCAL` set to the name of a temporary
54+
the merge, if available; `LOCAL` set to the name of a temporary
5555
file containing the contents of the file on the current branch;
56-
`$REMOTE` set to the name of a temporary file containing the
57-
contents of the file to be merged, and `$MERGED` set to the name
56+
`REMOTE` set to the name of a temporary file containing the
57+
contents of the file to be merged, and `MERGED` set to the name
5858
of the file to which the merge tool should write the result of the
5959
merge resolution.
6060
+
6161
If the custom merge tool correctly indicates the success of a
6262
merge resolution with its exit code, then the configuration
6363
variable `mergetool.<tool>.trustExitCode` can be set to `true`.
64-
Otherwise, 'git mergetool' will prompt the user to indicate the
64+
Otherwise, `git mergetool` will prompt the user to indicate the
6565
success of the resolution after the custom tool has exited.
6666

67-
--tool-help::
67+
`--tool-help`::
6868
Print a list of merge tools that may be used with `--tool`.
6969

70-
-y::
71-
--no-prompt::
70+
`-y`::
71+
`--no-prompt`::
7272
Don't prompt before each invocation of the merge resolution
7373
program.
7474
This is the default if the merge resolution program is
7575
explicitly specified with the `--tool` option or with the
7676
`merge.tool` configuration variable.
7777

78-
--prompt::
78+
`--prompt`::
7979
Prompt before each invocation of the merge resolution program
8080
to give the user a chance to skip the path.
8181

82-
-g::
83-
--gui::
84-
When 'git-mergetool' is invoked with the `-g` or `--gui` option,
82+
`-g`::
83+
`--gui`::
84+
When `git-mergetool` is invoked with the `-g` or `--gui` option,
8585
the default merge tool will be read from the configured
8686
`merge.guitool` variable instead of `merge.tool`. If
8787
`merge.guitool` is not set, we will fallback to the tool
8888
configured under `merge.tool`. This may be autoselected using
8989
the configuration variable `mergetool.guiDefault`.
9090

91-
--no-gui::
91+
`--no-gui`::
9292
This overrides a previous `-g` or `--gui` setting or
9393
`mergetool.guiDefault` configuration and reads the default merge
9494
tool from the configured `merge.tool` variable.
9595

96-
-O<orderfile>::
96+
`-O<orderfile>`::
9797
Process files in the order specified in the
98-
<orderfile>, which has one shell glob pattern per line.
98+
_<orderfile>_, which has one shell glob pattern per line.
9999
This overrides the `diff.orderFile` configuration variable
100100
(see linkgit:git-config[1]). To cancel `diff.orderFile`,
101101
use `-O/dev/null`.

0 commit comments

Comments
 (0)