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