1git-mergetool--lib(1) 2===================== 3 4NAME 5---- 6git-mergetool--lib - Common git merge tool shell scriptlets 7 8SYNOPSIS 9-------- 10'. "$(git --exec-path)/git-mergetool--lib"' 11 12DESCRIPTION 13----------- 14 15This is not a command the end user would want to run. Ever. 16This documentation is meant for people who are studying the 17Porcelain-ish scripts and/or are writing new ones. 18 19The 'git-mergetool--lib' scriptlet is designed to be sourced (using 20`.`) by other shell scripts to set up functions for working 21with git merge tools. 22 23Before sourcing it, your script should set up a few variables; 24`TOOL_MODE` is used to define the operation mode for various 25functions. 'diff' and 'merge' are valid values. 26 27FUNCTIONS 28--------- 29get_merge_tool:: 30 returns a merge tool 31 32get_merge_tool_cmd:: 33 returns the custom command for a merge tool. 34 35get_merge_tool_path:: 36 returns the custom path for a merge tool. 37 38run_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 '$merge_tool', '$merge_tool_path', and for custom commands, 42 '$merge_tool_cmd', must be defined prior to calling 43 run_merge_tool. Additionally, '$MERGED', '$LOCAL', '$REMOTE', 44 and '$BASE' must be defined for use by the merge tool. 45 46Author 47------ 48Written by David Aguilar <davvid@gmail.com> 49 50Documentation 51-------------- 52Documentation by David Aguilar and the git-list <git@vger.kernel.org>. 53 54GIT 55--- 56Part of the linkgit:git[1] suite