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