Sourcetree External Merge Tool

  • Status:Gathering Interest(View Workflow)
  • Fix Version/s: None
  • Labels:
  • Feedback Policy:

    Our product teams collect and evaluate feedback from a number of different sources. To learn more about how we use customer feedback in the planning process, check out our new feature policy.

Hi!

Please could you add WinMerge to the merge tool selection as it has supported 3-way merge since early 2018? Acronis true image adata. Thank you!

Current situation (Tested on Sourcetree 3.4.3 Windows 64-bit):

The SourceTree Options dialog includes a section for configuring your diff tool, and WinMerge is one of the preset options. If the tool is not launching, it's possible that a local git config file is overriding the global difftool/mergetool preferences. Ivan Woehr Sep 18, 2017 I. Author: Oliver Busse. This software is licensed under the Apache License 2.0. Code snippets or any other console output - if not.

WinMerge is not available in the 'Options > Diff > External Diff / Merge > Merge Tool' dropdown box.

Desired outcome:

Sourcetree Reverse Merge

WinMerge is available in the 'Options > Diff > External Diff / Merge > Merge Tool' dropdown box and merging using it works.

Background / related issues:

Related bug:

The bug SRCTREEWIN-4572 ('Can't select WinMerge as merge tool') from 2016 was closed because WinMerge didn't yet support a 3-way merge. But as of 2018-01-28 WinMerge has supported 3-way merge (See WinMerge 2.15.2 changelog from 2018-01-28: 'Add support for 3-way compare/merge'). I tried today (2021-03-08) using WinMerge 3-way merge with the custom merge option using the information from this Sourcetree Community question and it worked okay.

Sourcetree External Merge Tool

Currently working custom merge options for WinMerge:

The options I used in Sourcetree 3.4.3 for Windows 64-bit with WinMerge 2.16.10.0 x64 and which worked for merging:

  • Options > Diff > External Diff / Merge:
    • Merge Tool: Custom
    • Merge Command: C:Program FilesWinMergeWinMergeU.exe
      • Arguments:
Votes:
1Vote for this issue
Watchers:
2Start watching this issue

Customize External Source Control to Use MATLAB for Diff and Merge

You can customize external source control tools to use the MATLAB® Comparison Tool for diff and merge. If you want to compare MATLAB files such as live scripts, MAT, SLX, or MDL files from your source control tool, then you can configure your source control tool to open the MATLAB Comparison Tool. The MATLAB Comparison Tool provides tools for merging MathWorks® files and is compatible with popular software configuration management and version control systems. You can use the automerge tool with Git™ to automatically merge branches that contain changes in different subsystems in the same SLX file.

To set up your source control tool to use MATLAB as the application for diff and merge, you must first determine the full paths of the mlDiff, mlMerge, and mlAutoMerge executable files, and then follow the recommended steps for the source control tool you are using.

Finding the Full Paths for MATLAB Diff, Merge, and AutoMerge

To get the required file paths and enable external source control tools to reuse open MATLAB sessions, run this command in MATLAB:

Sourcetree Launch External Merge Tool

This command sets the MATLAB preference, under Comparison, called Allow external source control tools to use open MATLAB sessions for diffs and merges.

This command also displays the file paths to copy and paste into your source control tool setup:

  • On Windows®:

  • On Linux®:

  • On Mac:

where matlabroot is replaced with the full path to your installation, for example, C:Program FilesMATLABR2020b.

Note

Your diff and merge operations use open MATLAB sessions when available, and only open MATLAB when necessary. The operations only use the specified MATLAB installation.

Integration with Git

Command Line

To configure MATLAB diff and merge tools with command-line Git:

  1. Run this command in MATLAB.

    This command displays the full paths of the mlDiff, mlMerge, and mlAutoMerge executable files. It also automatically populates the global .gitconfig file. For example:

    Note

    You need to do step 1 only once for your Git setup.

  2. Configure your repository to use the mlAutoMerge executable file. Open the .gitattributes file in your repository and add:

    Now, when you merge branches that contain changes in different subsystems in the same SLX file, MATLAB handles the merge automatically.

To run the MATLAB diff and merge tools from command-line Git, use git difftool and git mergetool:

  • To compare two revisions of a model using the MATLAB diff tool, type:

    If you do not provide revision IDs, git difftool compares the working copy to the repository copy.

    If you do not specify which model you want to compare, command-line Git will go through all modified files and ask you if you want to compare them one by one.

  • To resolve a merge conflict in a model using the MATLAB merge tool, type:

    If you do not specify which model you want to merge, command-line Git will go through all files and ask you if you want to merge them one by one.

SourceTree

SourceTree is an interactive GUI tool that visualizes and manages Git repositories for Windows and Mac.

  1. Configure the MATLAB diff and merge tools as SourceTree external tools:

    1. With SourceTree open, click Tools > Options.

    2. On the Diff tab, under External Diff / Merge, fill the fields with the following information:

  2. Configure your repository to automerge changes in different subsystems in the same SLX file using the mlAutoMerge executable file:

    1. Open the global .gitconfig file and add:

    2. Open the .gitattributes file in your repository and add:

Tip

Customize the full path of the mlDiff, mlMerge, and mlAutoMerge executables to match both the MATLAB installation and the operating system you are using. For more information, see Finding the Full Paths for MATLAB Diff, Merge, and AutoMerge.

To use the MATLAB diff tool from within SourceTree, right-click a modified file under Unstaged files and select External Diff.

To use the MATLAB merge tool when SourceTree detects a merge conflict, select the Uncommitted changes branch, right-click a modified file, and select Resolve Conflicts > Launch External Merge Tool.

Sourcetree External Merge Tool Not Launching Mac

Integration with SVN

Sourcetree External Merge Tool Vs Code

TortoiseSVN

With TortoiseSVN, you can customize your diff and merge tools based on the file extension. For example, to use MATLAB diff and merge tools for SLX files:

  1. Right-click in any file explorer window and select TortoiseSVN > Settings to open TortoiseSVN settings.

  2. In the Settings sidebar, select Diff Viewer. Click to specify the diff application based on file extensions.

  3. Click and fill the fields with the extension and the mlDiff executable path:

  4. Click and repeat the same steps to add another file extension.

  5. In the Settings sidebar, select Diff ViewerMerge Tool. Click to specify the merge application based on file extensions.

  6. Click and fill the fields with the extension and mlMerge executable path:

  7. Click and repeat the same steps to add another file extension.

You can now use the MATLAB tools for diff and merge the same way you would use the TortoiseSVN default diff and merge applications.

Note

Automerging binary files with SVN , such as SLX files, is not supported.

Integration with Other Source Control Tools

Perforce P4V

With Perforce® P4V, you can customize your diff and merge tools based on the file extension. To use MATLAB diff and merge tools for SLX files, for example:

  1. In Perforce, click Edit > Preferences.

  2. In the Preferences sidebar, select Diff. Under Specify diff application by extension (overrides default), click .

  3. In the Add File Type dialog box, enter the following information:

  4. Click .

  5. In the Preferences sidebar, select Merge. Under Specify merge application by extension (overrides default), click .

  6. In the Add File Type dialog box, enter the following information:

  7. Click and repeat the steps for other file extensions.

Tip

Customize the full path of the mlDiff and mlMerge executables to match both the MATLAB installation and the operating system you are using. For more information, see Finding the Full Paths for MATLAB Diff, Merge, and AutoMerge.

You can now use the MATLAB tools for diff and merge the same way you would use the Perforce default diff and merge applications.

External Merge Tool For Sourcetree

Related Topics