Documentation / git-mergetool--lib.txton commit Merge branch 'nd/switch-and-restore' (3ff6af7)
   1git-mergetool{litdd}lib(1)
   2==========================
   3
   4NAME
   5----
   6git-mergetool--lib - Common Git merge tool shell scriptlets
   7
   8SYNOPSIS
   9--------
  10[verse]
  11'TOOL_MODE=(diff|merge) . "$(git --exec-path)/git-mergetool{litdd}lib"'
  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
  20The 'git-mergetool{litdd}lib' scriptlet is designed to be sourced (using
  21`.`) by other shell scripts to set up functions for working
  22with Git merge tools.
  23
  24Before sourcing 'git-mergetool{litdd}lib', your script must set `TOOL_MODE`
  25to define the operation mode for the functions listed below.
  26'diff' and 'merge' are valid values.
  27
  28FUNCTIONS
  29---------
  30get_merge_tool::
  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.
  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.
  44        '$MERGED', '$LOCAL', '$REMOTE', and '$BASE' must be defined
  45        for use by the merge tool.
  46
  47GIT
  48---
  49Part of the linkgit:git[1] suite