logo

oasis-root

Compiled tree of Oasis Linux based on own branch at <https://hacktivis.me/git/oasis/> git clone https://anongit.hacktivis.me/git/oasis-root.git

git-mergetool--lib.1 (2799B)

    

  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 v1.79.2 <http://docbook.sf.net/>
  5. .\"      Date: 2025-03-14
  6. .\"    Manual: Git Manual
  7. .\"    Source: Git 2.49.0
  8. .\"  Language: English
  9. .\"
  10. .TH "GIT\-MERGETOOL\-\-LIB" "1" "2025-03-14" "Git 2\&.49\&.0" "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. .SH "DESCRIPTION"
  38. .sp
  39. 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\&.
  40. .sp
  41. The \fIgit\-mergetool\-\-lib\fR scriptlet is designed to be sourced (using \&.) by other shell scripts to set up functions for working with Git merge tools\&.
  42. .sp
  43. 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\&.
  44. .SH "FUNCTIONS"
  45. .PP
  46. get_merge_tool
  47. .RS 4
  48. Returns a merge tool\&. The return code is 1 if we returned a guessed merge tool, else 0\&.
  49. \fI$GIT_MERGETOOL_GUI\fR
  50. may be set to
  51. \fItrue\fR
  52. to search for the appropriate guitool\&.
  53. .RE
  54. .PP
  55. get_merge_tool_cmd
  56. .RS 4
  57. Returns the custom command for a merge tool\&.
  58. .RE
  59. .PP
  60. get_merge_tool_path
  61. .RS 4
  62. Returns the custom path for a merge tool\&.
  63. .RE
  64. .PP
  65. initialize_merge_tool
  66. .RS 4
  67. Brings merge tool specific functions into scope so they can be used or overridden\&.
  68. .RE
  69. .PP
  70. run_merge_tool
  71. .RS 4
  72. Launches a merge tool given the tool name and a true/false flag to indicate whether a merge base is present\&.
  73. \fI$MERGED\fR,
  74. \fI$LOCAL\fR,
  75. \fI$REMOTE\fR, and
  76. \fI$BASE\fR
  77. must be defined for use by the merge tool\&.
  78. .RE
  79. .SH "GIT"
  80. .sp
  81. Part of the \fBgit\fR(1) suite