man1/git-mergetool--lib.1

   1 '\" t
   2 .\"     Title: git-mergetool--lib
   3 .\"    Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
   4 .\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
   5 .\"      Date: 2024-02-19
   6 .\"    Manual: Git Manual
   7 .\"    Source: Git 2.44.0.rc2
   8 .\"  Language: English
   9 .\"
  10 .TH "GIT\-MERGETOOL\-\-LIB" "1" "2024\-02\-19" "Git 2\&.44\&.0\&.rc2" "Git Manual"
  11 .\" -----------------------------------------------------------------
  12 .\" * Define some portability stuff
  13 .\" -----------------------------------------------------------------
  14 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  15 .\" http://bugs.debian.org/507673
  16 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
  17 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  18 .ie \n(.g .ds Aq \(aq
  19 .el       .ds Aq '
  20 .\" -----------------------------------------------------------------
  21 .\" * set default formatting
  22 .\" -----------------------------------------------------------------
  23 .\" disable hyphenation
  24 .nh
  25 .\" disable justification (adjust text to left margin only)
  26 .ad l
  27 .\" -----------------------------------------------------------------
  28 .\" * MAIN CONTENT STARTS HERE *
  29 .\" -----------------------------------------------------------------
  30 .SH "NAME"
  31 git-mergetool--lib \- Common Git merge tool shell scriptlets
  32 .SH "SYNOPSIS"
  33 .sp
  34 .nf
  35 \fITOOL_MODE=(diff|merge) \&. "$(git \-\-exec\-path)/git\-mergetool\-\-lib"\fR
  36 .fi
  37 .sp
  38 .SH "DESCRIPTION"
  39 .sp
  40 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\&.
  41 .sp
  42 The \fIgit\-mergetool\-\-lib\fR scriptlet is designed to be sourced (using \fB\&.\fR) by other shell scripts to set up functions for working with Git merge tools\&.
  43 .sp
  44 Before sourcing \fIgit\-mergetool\-\-lib\fR, your script must set \fBTOOL_MODE\fR to define the operation mode for the functions listed below\&. \fIdiff\fR and \fImerge\fR are valid values\&.
  45 .SH "FUNCTIONS"
  46 .PP
  47 get_merge_tool
  48 .RS 4
  49 Returns a merge tool\&. The return code is 1 if we returned a guessed merge tool, else 0\&.
  50 \fI$GIT_MERGETOOL_GUI\fR
  51 may be set to
  52 \fItrue\fR
  53 to search for the appropriate guitool\&.
  54 .RE
  55 .PP
  56 get_merge_tool_cmd
  57 .RS 4
  58 Returns the custom command for a merge tool\&.
  59 .RE
  60 .PP
  61 get_merge_tool_path
  62 .RS 4
  63 Returns the custom path for a merge tool\&.
  64 .RE
  65 .PP
  66 initialize_merge_tool
  67 .RS 4
  68 Brings merge tool specific functions into scope so they can be used or overridden\&.
  69 .RE
  70 .PP
  71 run_merge_tool
  72 .RS 4
  73 Launches a merge tool given the tool name and a true/false flag to indicate whether a merge base is present\&.
  74 \fI$MERGED\fR,
  75 \fI$LOCAL\fR,
  76 \fI$REMOTE\fR, and
  77 \fI$BASE\fR
  78 must be defined for use by the merge tool\&.
  79 .RE
  80 .SH "GIT"
  81 .sp
  82 Part of the \fBgit\fR(1) suite