Merge branch 'cb/maint-orphan-merge-noclobber'
[git/kirr.git] / Documentation / git-mergetool--lib.txt
blobd8df55362ce653516006b02df2950c325f1176b7
1 git-mergetool{litdd}lib(1)
2 ==========================
4 NAME
5 ----
6 git-mergetool--lib - Common git merge tool shell scriptlets
8 SYNOPSIS
9 --------
10 'TOOL_MODE=(diff|merge) . "$(git --exec-path)/git-mergetool--lib"'
12 DESCRIPTION
13 -----------
15 This is not a command the end user would want to run.  Ever.
16 This documentation is meant for people who are studying the
17 Porcelain-ish scripts and/or are writing new ones.
19 The 'git-mergetool{litdd}lib' scriptlet is designed to be sourced (using
20 `.`) by other shell scripts to set up functions for working
21 with git merge tools.
23 Before sourcing 'git-mergetool{litdd}lib', your script must set `TOOL_MODE`
24 to define the operation mode for the functions listed below.
25 'diff' and 'merge' are valid values.
27 FUNCTIONS
28 ---------
29 get_merge_tool::
30         returns a merge tool.
32 get_merge_tool_cmd::
33         returns the custom command for a merge tool.
35 get_merge_tool_path::
36         returns the custom path for a merge tool.
38 run_merge_tool::
39         launches a merge tool given the tool name and a true/false
40         flag to indicate whether a merge base is present.
41         '$MERGED', '$LOCAL', '$REMOTE', and '$BASE' must be defined
42         for use by the merge tool.
44 Author
45 ------
46 Written by David Aguilar <davvid@gmail.com>
48 Documentation
49 --------------
50 Documentation by David Aguilar and the git-list <git@vger.kernel.org>.
52 GIT
53 ---
54 Part of the linkgit:git[1] suite