mirror of
https://github.com/git/git.git
synced 2024-09-28 19:42:15 +02:00
21d0ba7ebb
This consolidates the common functionality from git-mergetool and git-difftool--helper into a single git-mergetool--lib scriptlet. Signed-off-by: David Aguilar <davvid@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
57 lines
1.4 KiB
Plaintext
57 lines
1.4 KiB
Plaintext
git-mergetool--lib(1)
|
|
=====================
|
|
|
|
NAME
|
|
----
|
|
git-mergetool--lib - Common git merge tool shell scriptlets
|
|
|
|
SYNOPSIS
|
|
--------
|
|
'. "$(git --exec-path)/git-mergetool--lib"'
|
|
|
|
DESCRIPTION
|
|
-----------
|
|
|
|
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 it, your script should set up a few variables;
|
|
`TOOL_MODE` is used to define the operation mode for various
|
|
functions. 'diff' and 'merge' are valid values.
|
|
|
|
FUNCTIONS
|
|
---------
|
|
get_merge_tool::
|
|
returns a merge tool
|
|
|
|
get_merge_tool_cmd::
|
|
returns the custom command for a merge tool.
|
|
|
|
get_merge_tool_path::
|
|
returns the custom path for a merge tool.
|
|
|
|
run_merge_tool::
|
|
launches a merge tool given the tool name and a true/false
|
|
flag to indicate whether a merge base is present.
|
|
'$merge_tool', '$merge_tool_path', and for custom commands,
|
|
'$merge_tool_cmd', must be defined prior to calling
|
|
run_merge_tool. Additionally, '$MERGED', '$LOCAL', '$REMOTE',
|
|
and '$BASE' must be defined for use by the merge tool.
|
|
|
|
Author
|
|
------
|
|
Written by David Aguilar <davvid@gmail.com>
|
|
|
|
Documentation
|
|
--------------
|
|
Documentation by David Aguilar and the git-list <git@vger.kernel.org>.
|
|
|
|
GIT
|
|
---
|
|
Part of the linkgit:git[1] suite
|