git-mergetool--lib(1) — Linux manual page


GIT-MERGETOOL--LI(1)           Git Manual           GIT-MERGETOOL--LI(1)

NAME         top

       git-mergetool--lib - Common Git merge tool shell scriptlets

SYNOPSIS         top

       TOOL_MODE=(diff|merge) . "$(git --exec-path)/git-mergetool--lib"

DESCRIPTION         top

       This is not a command the end user would want to run. Ever. This
       documentation is meant for people who are studying the
       Porcelain-ish scripts and/or are writing new ones.

       The git-mergetool--lib scriptlet is designed to be sourced (using
       .) by other shell scripts to set up functions for working with
       Git merge tools.

       Before sourcing git-mergetool--lib, your script must set
       TOOL_MODE to define the operation mode for the functions listed
       below. diff and merge are valid values.

FUNCTIONS         top

           returns a merge tool. the return code is 1 if we returned a
           guessed merge tool, else 0.  $GIT_MERGETOOL_GUI may be set to
           true to search for the appropriate guitool.

           returns the custom command for a merge tool.

           returns the custom path for a merge tool.

           bring merge tool specific functions into scope so they can be
           used or overridden.

           launches a merge tool given the tool name and a true/false
           flag to indicate whether a merge base is present.  $MERGED,
           $LOCAL, $REMOTE, and $BASE must be defined for use by the
           merge tool.

GIT         top

       Part of the git(1) suite

COLOPHON         top

       This page is part of the git (Git distributed version control
       system) project.  Information about the project can be found at
       ⟨⟩.  If you have a bug report for this manual
       page, see ⟨⟩.  This page was obtained
       from the project's upstream Git repository
       ⟨⟩ on 2021-08-27.  (At that time,
       the date of the most recent commit that was found in the
       repository was 2021-08-24.)  If you discover any rendering
       problems in this HTML version of the page, or you believe there
       is a better or more up-to-date source for the page, or you have
       corrections or improvements to the information in this COLOPHON
       (which is not part of the original manual page), send a mail to

Git         08/27/2021           GIT-MERGETOOL--LI(1)