Automatic File Merging

The Professional Edition of Merge has the ability to automatically merge two modified files into a common ancestor. A typical merging scenario is where two developers have independently made modifications to a source file stored in a configuration management system and changes in the two modified files need to be reviewed and merged together.

Information The Professional Edition of Merge also features Automatic Folder Merging, making it possible to perform a quick three-way merge of entire source trees.

Starting an automatic merge

Automatic merging works only with three-way file comparisons. The common ancestor file should be loaded into the central file panel and the two newer (modified) files into the left and right panels. You should ensure that the common ancestor folder is the one in the centre of the folder comparison window if you are using a three-way folder comparison window to launch file comparison windows.

To start an automatic merge, click the Merge to Common Ancestor toolbar button, or select the MergingMerge to Common Ancestor menu item.

How automatic merging works

When an automatic merge is started, Merge will examine the three files starting at the top, working down. Each change between the three files is examined to determine whether it should be retained in, or added to, the final merged file. Merge may be unable to decide what to do with certain types of change and will mark them as conflicts that require attention from you.

When the merge is complete, the central file panel will contain the resolved (merged) file. This is therefore the file that you should save once you are happy with the merge results. The left and right-hand files are not modified by the three-way merge command.

Simple rules control how changes in the two modified files are merged into the common ancestor. Since the two modified files are assumed to be more recent than the common ancestor, changes (inserted, removed, or edited blocks of lines) to the files are applied into the common ancestor unless changes to the two modified files overlap.

Understanding automatic merge results

Changes that overlap or touch at their start or end are marked as conflicts. A red conflict icon is shown at the beginning of each line within a change that could not be automatically merged.

To navigate between conflicts:

  • click the Next Conflict and Previous Conflict toolbar buttons;
  • select the MergingNext Conflict and MergingPrevious Conflict menu commands;
  • or, press F4 and Shift+F4.

There are some types of overlapping change that do not result in a conflict. If the change is the same in the modified files (for example, the same lines were added/removed/changed, and their content is exactly the same) then the change is merged into the common ancestor. Merge always treats whitespace as significant when deciding whether to automatically merge a particular change. Thus, if a change appears identical in the modified files but Merge has marked it as a conflict, it is likely that there is a difference in whitespace or line endings between the two modified files.

Marking of changes made to the common ancestor file

Every change that is made to the common ancestor is flagged with an edit marker indicating the nature of the change:

  • For lines introduced into the common ancestor, an arrow ( or ) indicates the file from which the lines were copied.
  • For lines removed from the common ancestor, a delete marker is placed on the line after the position from which the lines were removed.
  • Lines that have been manually edited are marked with .

Each , , or marker has an associated tooltip that explains what edit was made. Hold the mouse cursor over the marker for a few seconds to see the explanation. Conflict markers also have a tooltip to explain the reason for the conflict.

To navigate between edit markers:

  • click the Next Edit and Previous Edit toolbar buttons;
  • select the EditMarkersNext Edit and EditMarkersPrevious Edit menu commands;
  • or, press F3 and Shift+F3.

Dimming of resolved lines

As Merge resolves the changes between the two modified files into the common ancestor, the resolved lines are dimmed to indicate that they have been finished with. When the three-way merge is complete, only lines within conflicting changes will retain their original colours. The amount of dimming applied to resolved lines is controlled by the Dimming setting on the Fonts/Colours page.

Automatically merged files

Resolving conflicts

After performing an automatic merge, you should manually resolve any conflicting changes that were flagged. You should also check that the changes that have been made automatically to the common ancestor are valid. Finally, you may need to adjust the indentation of some of the merged changes.

Previewing an automatic merge

Because automatic merging can be undone, it is safe to try an automatic merge to see what it will do. If you are unhappy with the automatic merge results, you can reverse the automatic merge by clicking the Undo toolbar button. You can also select EditUndo, or press Cmd+Z.

Previewing an automatic merge is a useful way of quickly highlighting the conflicting sections of the files being compared.

Clearing markers and text dimming

Following a three-way merge operation, you can remove all of the edit/conflict markers, text dimming and bookmarks by clicking the Clear All Markers toolbar button. You can also select the EditMarkersClear All Markers menu item, or press Cmd+D.

At any time you can mark the current selection or line as resolved by clicking the Mark Resolved toolbar button. You can also select the EditMarkersMark Resolved menu item, or press Cmd+K button. This will remove any conflict markers on lines within the selection and cause it to be dimmed. If there is no selection, the operation is applied to the current line.