Documentation / git-mergetool--lib.txton commit Merge branch 'maint' (ef6b43a)
   1git-mergetool{litdd}lib(1)
   2==========================
   3
   4NAME
   5----
   6git-mergetool--lib - Common git merge tool shell scriptlets
   7
   8SYNOPSIS
   9--------
  10'TOOL_MODE=(diff|merge) . "$(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{litdd}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 'git-mergetool{litdd}lib', your script must set `TOOL_MODE`
  24to define the operation mode for the functions listed below.
  25'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        '$MERGED', '$LOCAL', '$REMOTE', and '$BASE' must be defined
  42        for use by the merge tool.
  43
  44GIT
  45---
  46Part of the linkgit:git[1] suite