]>
Commit | Line | Data |
---|---|---|
28394787 JH |
1 | git-mergetool{litdd}lib(1) |
2 | ========================== | |
21d0ba7e DA |
3 | |
4 | NAME | |
5 | ---- | |
2de9b711 | 6 | git-mergetool--lib - Common Git merge tool shell scriptlets |
21d0ba7e DA |
7 | |
8 | SYNOPSIS | |
9 | -------- | |
7791a1d9 | 10 | [verse] |
565e135a | 11 | 'TOOL_MODE=(diff|merge) . "$(git --exec-path)/git-mergetool{litdd}lib"' |
21d0ba7e DA |
12 | |
13 | DESCRIPTION | |
14 | ----------- | |
15 | ||
16 | This is not a command the end user would want to run. Ever. | |
17 | This documentation is meant for people who are studying the | |
18 | Porcelain-ish scripts and/or are writing new ones. | |
19 | ||
28394787 | 20 | The 'git-mergetool{litdd}lib' scriptlet is designed to be sourced (using |
21d0ba7e | 21 | `.`) by other shell scripts to set up functions for working |
2de9b711 | 22 | with Git merge tools. |
21d0ba7e | 23 | |
28394787 | 24 | Before sourcing 'git-mergetool{litdd}lib', your script must set `TOOL_MODE` |
47d65924 DA |
25 | to define the operation mode for the functions listed below. |
26 | 'diff' and 'merge' are valid values. | |
21d0ba7e DA |
27 | |
28 | FUNCTIONS | |
29 | --------- | |
30 | get_merge_tool:: | |
05fb8726 DL |
31 | returns a merge tool. the return code is 1 if we returned a guessed |
32 | merge tool, else 0. '$GIT_MERGETOOL_GUI' may be set to 'true' to | |
33 | search for the appropriate guitool. | |
21d0ba7e DA |
34 | |
35 | get_merge_tool_cmd:: | |
36 | returns the custom command for a merge tool. | |
37 | ||
38 | get_merge_tool_path:: | |
39 | returns the custom path for a merge tool. | |
40 | ||
41 | run_merge_tool:: | |
42 | launches a merge tool given the tool name and a true/false | |
43 | flag to indicate whether a merge base is present. | |
47d65924 DA |
44 | '$MERGED', '$LOCAL', '$REMOTE', and '$BASE' must be defined |
45 | for use by the merge tool. | |
21d0ba7e | 46 | |
21d0ba7e DA |
47 | GIT |
48 | --- | |
49 | Part of the linkgit:git[1] suite |