mirror of
https://github.com/git/git
synced 2024-11-05 18:59:29 +00:00
de8dafbada
This is preparation for the following commit where we need to source the mergetool shell script to look for overrides before `run_merge_tool` is called. Previously `run_merge_tool` both sourced that script and invoked the mergetool. In the case of the following commit, we need the result of the `hide_resolved` override, if present, before we actually run `run_merge_tool`. The new `initialize_merge_tool` wrapper is exposed and documented as a public interface for consistency with the existing `run_merge_tool` which is also public. Although `setup_tool` could instead be exposed directly, the related `setup_user_tool` would probably also want to be elevated to match and this felt the cleanest to me. Signed-off-by: Seth House <seth@eseth.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
53 lines
1.4 KiB
Text
53 lines
1.4 KiB
Text
git-mergetool{litdd}lib(1)
|
|
==========================
|
|
|
|
NAME
|
|
----
|
|
git-mergetool--lib - Common Git merge tool shell scriptlets
|
|
|
|
SYNOPSIS
|
|
--------
|
|
[verse]
|
|
'TOOL_MODE=(diff|merge) . "$(git --exec-path)/git-mergetool{litdd}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{litdd}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{litdd}lib', your script must set `TOOL_MODE`
|
|
to define the operation mode for the functions listed below.
|
|
'diff' and 'merge' are valid values.
|
|
|
|
FUNCTIONS
|
|
---------
|
|
get_merge_tool::
|
|
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.
|
|
|
|
get_merge_tool_cmd::
|
|
returns the custom command for a merge tool.
|
|
|
|
get_merge_tool_path::
|
|
returns the custom path for a merge tool.
|
|
|
|
initialize_merge_tool::
|
|
bring merge tool specific functions into scope so they can be used or
|
|
overridden.
|
|
|
|
run_merge_tool::
|
|
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
|
|
---
|
|
Part of the linkgit:git[1] suite
|