freshlybakedca.ke
Git fork
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 <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
16543967
90a837a7
+31
-31
+31
-31
Documentation/git-mergetool.adoc
+31
-31
Documentation/git-mergetool.adoc
···
7
7
8
8
SYNOPSIS
9
9
--------
10
-
[verse]
11
-
'git mergetool' [--tool=<tool>] [-y | --[no-]prompt] [<file>...]
10
+
[synopsis]
11
+
git mergetool [--tool=<tool>] [-y | --[no-]prompt] [<file>...]
12
12
13
13
DESCRIPTION
14
14
-----------
15
15
16
16
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`.
18
18
19
19
If one or more <file> parameters are given, the merge tool program will
20
20
be run to resolve differences in each file (skipping those without
21
21
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
23
23
the merge tool program on every file with merge conflicts.
24
24
25
25
OPTIONS
26
26
-------
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.
33
33
+
34
-
If a merge resolution program is not specified, 'git mergetool'
34
+
If a merge resolution program is not specified, `git mergetool`
35
35
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`
37
37
will pick a suitable default.
38
38
+
39
39
You can explicitly provide a full path to the tool by setting the
40
40
configuration variable `mergetool.<tool>.path`. For example, you
41
41
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`.
44
44
+
45
45
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
47
47
by specifying the command line to invoke in a configuration
48
48
variable `mergetool.<tool>.cmd`.
49
49
+
50
-
When 'git mergetool' is invoked with this tool (either through the
50
+
When `git mergetool` is invoked with this tool (either through the
51
51
`-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`
53
53
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
55
55
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
58
58
of the file to which the merge tool should write the result of the
59
59
merge resolution.
60
60
+
61
61
If the custom merge tool correctly indicates the success of a
62
62
merge resolution with its exit code, then the configuration
63
63
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
65
65
success of the resolution after the custom tool has exited.
66
66
67
-
--tool-help::
67
+
`--tool-help`::
68
68
Print a list of merge tools that may be used with `--tool`.
69
69
70
-
-y::
71
-
--no-prompt::
70
+
`-y`::
71
+
`--no-prompt`::
72
72
Don't prompt before each invocation of the merge resolution
73
73
program.
74
74
This is the default if the merge resolution program is
75
75
explicitly specified with the `--tool` option or with the
76
76
`merge.tool` configuration variable.
77
77
78
-
--prompt::
78
+
`--prompt`::
79
79
Prompt before each invocation of the merge resolution program
80
80
to give the user a chance to skip the path.
81
81
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,
85
85
the default merge tool will be read from the configured
86
86
`merge.guitool` variable instead of `merge.tool`. If
87
87
`merge.guitool` is not set, we will fallback to the tool
88
88
configured under `merge.tool`. This may be autoselected using
89
89
the configuration variable `mergetool.guiDefault`.
90
90
91
-
--no-gui::
91
+
`--no-gui`::
92
92
This overrides a previous `-g` or `--gui` setting or
93
93
`mergetool.guiDefault` configuration and reads the default merge
94
94
tool from the configured `merge.tool` variable.
95
95
96
-
-O<orderfile>::
96
+
`-O<orderfile>`::
97
97
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.
99
99
This overrides the `diff.orderFile` configuration variable
100
100
(see linkgit:git-config[1]). To cancel `diff.orderFile`,
101
101
use `-O/dev/null`.