Altium Designer Documentation

CompareHistory

Created: October 5, 2017 | Updated: October 6, 2017

Parent page: VersionControl Commands

The following pre-packaged resources, derived from this base command, are available:


Applied Parameters: None

Summary

This command is used to compare two versions of the same document. A valuable asset to working with Version Control is the ability to compare historical revisions of design files, which is provided by Altium Designer's built-in Difference Comparator and accessed from the Storage Manager panel. When used in conjunction with the Differences panel, a logical or graphical comparison can be made between VCS revisions while interactively exploring the affected objects.

Access

With the required document selected in the Files region of the Storage Manager panel, this command can be accessed in the following ways:

  • Combined View - select two versions of the document from the Time line region of the panel, right-click, and choose the Compare command from the context menu.
  • Classic View - select two versions of the document in the Local History region, right-click, and choose the Compare command from the context menu.
Switch between views for the panel using the corresponding command from a region's right-click context menu - either Switch to Classic View (from the Time line region), or Switch to Combined View (from the VCS Revisions or Local History regions).

Use

First ensure that the required document is selected in the Files region of the Storage Manager panel. Then select the two versions of the document that you wish to compare, in the applicable region of the panel.

After launching the command, a comparison is made between the two documents, the result of which depends on the document type:

  • For schematic or PCB (design or library) documents, a graphical comparison is made and the differences detected listed in the Differences panel. With the two versions of the document open side by side in the design editor window, you can peruse the differences graphically. Clicking on a top-level folder for a detected difference will highlight that difference on both documents simultaneously.
  • For text-based ASCII documents, the CompareForm dialog will appear, showing a graphical 'diff' of the two versions of the document. The chosen documents are displayed side by side. The dialog is for comparison only - no modifications to a loaded document can be made. Through color-coding, the dialog highlights the various differences between the two document versions - lines added (pink), lines modified (green) and lines deleted (blue). A summary of changes and color-code legend is presented at the bottom-left of the dialog.
Found an issue with this document? Highlight the area, then use Ctrl+Enter to report it.

Contact Us

Contact our corporate or local offices directly.

We're sorry to hear the article wasn't helpful to you.
Could you take a moment to tell us why?
200 characters remaining
You are reporting an issue with the following selected text
and/or image within the active document: