mergetool: use get_merge_tool function
[git/git.git] / Documentation / git-mergetool--lib.txt
CommitLineData
28394787
JH
1git-mergetool{litdd}lib(1)
2==========================
21d0ba7e
DA
3
4NAME
5----
2de9b711 6git-mergetool--lib - Common Git merge tool shell scriptlets
21d0ba7e
DA
7
8SYNOPSIS
9--------
7791a1d9 10[verse]
565e135a 11'TOOL_MODE=(diff|merge) . "$(git --exec-path)/git-mergetool{litdd}lib"'
21d0ba7e
DA
12
13DESCRIPTION
14-----------
15
16This is not a command the end user would want to run. Ever.
17This documentation is meant for people who are studying the
18Porcelain-ish scripts and/or are writing new ones.
19
28394787 20The 'git-mergetool{litdd}lib' scriptlet is designed to be sourced (using
21d0ba7e 21`.`) by other shell scripts to set up functions for working
2de9b711 22with Git merge tools.
21d0ba7e 23
28394787 24Before sourcing 'git-mergetool{litdd}lib', your script must set `TOOL_MODE`
47d65924
DA
25to define the operation mode for the functions listed below.
26'diff' and 'merge' are valid values.
21d0ba7e
DA
27
28FUNCTIONS
29---------
30get_merge_tool::
05fb8726
DL
31 returns a merge tool. the return code is 1 if we returned a guessed
32 merge tool, else 0. '$GIT_MERGETOOL_GUI' may be set to 'true' to
33 search for the appropriate guitool.
21d0ba7e
DA
34
35get_merge_tool_cmd::
36 returns the custom command for a merge tool.
37
38get_merge_tool_path::
39 returns the custom path for a merge tool.
40
41run_merge_tool::
42 launches a merge tool given the tool name and a true/false
43 flag to indicate whether a merge base is present.
47d65924
DA
44 '$MERGED', '$LOCAL', '$REMOTE', and '$BASE' must be defined
45 for use by the merge tool.
21d0ba7e 46
21d0ba7e
DA
47GIT
48---
49Part of the linkgit:git[1] suite