Altium NEXUS Documentation

VersionControl

Modified by Susan Riege on Jul 28, 2020
This documentation page references Altium Vault, which is no longer a supported product. Altium Vault and its component management features have migrated to Altium Concord Pro.

Parent page: VersionControl Commands

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


Applied Parameters: ObjectKind=PanelDocument|Action=Commit

Summary

This command is used to check-in modifications made to the working copy of the selected file(s) (in the Files region of the Storage Manager panel) into your VCS repository. Modified files are distinguished by the status Modified.

Access

With the required document(s) selected in the Files region of the Storage Manager panel, this command is accessed by right-clicking over a document in the selection and choosing the Commit command from the context menu.

Use

After launching the command, the Edit Comment dialog will open. Enter a new comment or select a previous comment and click OK to commit the document(s). The latest copy of the document(s) in your working folder will be checked in and the associated revision number incremented.

Tips

  1. Note that you will not be allowed to commit a file if someone else has committed an update since you checked out your copy of the file. In this case, you will be required to perform an Update first before committing the file.


Applied Parameters: ObjectKind=PanelDocument|Action=CommitProject

Summary

This command is used to check in modifications to all files in the parent project, en-masse, from within the Storage Manager panel. It also gives the ability to add to version control any documents for the project that are not currently under version control.

Access

With at least one modified document in the project (or a document that has not yet been added to version control), this command is accessed by right-clicking in the Files region of the Storage Manager panel and choosing the Commit Whole Project command from the context menu.

Use

After launching the command, the Commit to Version Control dialog will appear. All modified files will be enabled for commit. If there are any other files not yet under version control, these will also be listed but not enabled by default. Choose what you want to commit and/or add to your version control repository, enter a comment if required, and click Commit - the files will be added to the version control database and the entry No modification will appear in the associated Status field for the document(s) in the Files region of the panel.


Applied Parameters: ObjectKind=Project|Action=Push

Summary

The command is used to push project updates to the server.

Access

The command is accessed by choosing Project » Version Control » Push from the main menus from a managed project that has been modified.

Use

After launching the command, the Git pop-up dialog opens to show transfer progress of the updates then the Commit to Version Control dialog opens.

Tips

  • To complete the "push" process, click the Commit And Push button in the Commit to Version Control dialog


Applied Parameters: ObjectKind=PanelDocument|Action=Update

Summary

The command is used to update the working copy of the selected file(s) in the Files region of the Storage Manager panel with changes that exist in the latest revision for the file(s) from the VCS repository.

Access

With one or more 'Out of Date' documents selected in the Files region of the Storage Manager panel, this command is accessed by right-clicking over the selection and choosing the Update command from the context menu.

Use

First ensure that the out of date local file(s) that you wish to update, are selected in the Files region of the Storage Manager panel.

After launching the command the file versions will be synchronized, with the local version of each selected document being updated to the latest revision of that document from the version control repository. The status for each file will return to No Modification.


Applied Parameters: ObjectKind=PanelDocument|Action=UpdateProject

Summary

This command is used to update files that are out of date in the parent project, en-masse, from within the Storage Manager panel, by updating the working copy of each file with changes that exist in the latest revision for the file, from the VCS repository.

Access

With at least one out of date document in the project, this command is accessed by right-clicking in the Files region of the Storage Manager panel and choosing the Update Whole Project command from the context menu.

Use

After launching the command, the Update from Version Control dialog will appear. All out of date files will be enabled for update. Choose what you want to update and click Update - the file versions will be synchronized, with the local version of each selected document being updated to the latest revision of that document from the version control repository. The status for each file will return to No Modification.


Applied Parameters: ObjectKind=PanelDocument|Action=Lock

Summary

This command is used to lock the file(s) currently selected in the Files region of the Storage Manager panel. Only the designer who locked the document can commit the document with any modifications to the version control repository.

Access

With at least one unlocked document selected in the Files region of the Storage Manager panel, this command is accessed by right-clicking over the selection and choosing the Lock command from the context menu.

Use

First ensure that the file(s) that you wish to lock, are selected in the Files region of the Storage Manager panel.

After launching the command, the file(s) will be locked, reflected in the Status column with the entry Locked by me.

Tips

  1. For another user, the entry in the Status column for the relevant document(s) - within their Storage Manager panel - will appear as Locked by someone else.
  2. If you modify and save a file that you currently have locked, the Status will change to Modified and locked by me. Committing the change will unlock the file.
  3. You cannot lock a file that is out of date.


Applied Parameters: ObjectKind=PanelDocument|Action=Unlock

Summary

This command is used to unlock the file(s) currently selected in the Files region of the Storage Manager panel. After unlocking, any user can commit the document with any modifications to the version control repository.

Access

With at least one locked document selected in the Files region of the Storage Manager panel, this command is accessed by right-clicking over the selection and choosing the Unlock command from the context menu.

Use

First ensure that the file(s) that you wish to unlock, are selected in the Files region of the Storage Manager panel.

After launching the command, the file(s) will be unlocked.


Applied Parameters: ObjectKind=PanelDocument|Action=Add

Summary

This command is used to add the file(s) currently selected in the Files region of the Storage Manager panel, to your version control repository.

Access

With at least one non-versioned document selected in the Files region of the Storage Manager panel, this command is accessed by right-clicking over the selection and choosing the Add to Version Control command from the context menu.

Use

First ensure that the file(s) that you wish to add to version control, are selected in the Files region of the Storage Manager panel.

After launching the command, the file(s) status will change to Scheduled for addition. To complete the process, you will need to either select the file(s) and use the Commit command (on the right-click menu), or simply right-click and choose the Commit Whole Project command.

Tips

  1. Note that in order to be validly checked in, the selected file(s) must be part of the parent project. If a file being added is currently open, it should be saved prior to adding it to version control, as the last saved version of the file is taken into VCS and not the current copy in memory.


Applied Parameters: ObjectKind=PanelDocument|Action=Remove

Summary

This command is used to remove the file(s) currently selected in the Files region of the Storage Manager panel, from your version control repository.

Access

With at least one versioned document selected in the Files region of the Storage Manager panel, this command is accessed by right-clicking over the selection and choosing the Remove from Version Control command from the context menu.

Use

First ensure that the file(s) that you wish to remove from version control, are selected in the Files region of the Storage Manager panel.

After launching the command, the file(s) status will change to Scheduled for deletion. To complete the process, you will need to either select the file(s) and use the Commit command (on the right-click menu), or simply right-click and choose the Commit Whole Project command.


Applied Parameters: ObjectKind=PanelDocument|Action=Resolve

Summary

This command is used to resolve the conflict for the file(s) currently selected in the Files region of the Storage Manager panel. A conflict can arise where the same file has been locally edited and saved by two Altium NEXUS users, and one has committed those changes.  This means that one designer's sequence of steps (check out, edit, save, commit) have interleaved with that of another designer, so a file that a user has checked out from the repository for editing may not remain as latest revision while it is being worked on - another user has updated the revision in the interim. Whomever first commits the edits to the repository in this case will dominate by creating a new revision, while another user that has edited and saved the same file will face a 'Conflict' situation. From a VCS perspective, which compares the working folder files to the repository files, a Conflict represents the condition where an out of date revision of a file in the working folder has been edited and saved.

Access

With at least one conflicting document selected in the Files region of the Storage Manager panel, this command is accessed by right-clicking over the selection and choosing the Resolve Conflict command from the context menu.

Use

First ensure that the file(s) that you wish to resolve conflict for, are selected in the Files region of the Storage Manager panel.

After launching the command, a confirmation dialog will appear, warning you that by resolving the conflict, changes committed to the repository since you last updated will be discarded - click Yes to proceed. The file(s) in your working folder will be updated to the latest revision checked into the repository by the other user, but the editor will retain the changes you have made to the previous revision. The local file therefore acquires a state of Modified, allowing you to commit those changes to a new revision in the repository - either select the file(s) and use the Commit command (on the right-click menu), or simply right-click and choose the Commit Whole Project command.

Tips

  1. Once you have committed the file(s), the other user will see the file(s) as Out of date, since you have created a newer revision in the repository.


Applied Parameters: ObjectKind=PanelDocument|Action=Revert

Summary

This command is used to discard local modifications for the file(s) currently selected in the Files region of the Storage Manager panel.

Access

With at least one document selected in the Files region of the Storage Manager panel, this command is accessed by right-clicking over the selection and choosing the Revert Local Modifications command from the context menu.

Use

First ensure that the file(s) that you wish to revert, are selected in the Files region of the Storage Manager panel.

After launching the command, a confirmation dialog will appear asking whether you wish to discard your local changes - click Yes to proceed. All local modifications to the document will be lost, and the file will be reverted back to its base revision (the last revision of the file checked out/updated to the working folder). The Status of a file that has been reverted depends on its previous status. For example a file showing as Modified will revert back to No modification. A file that was in Conflict will revert back to Out of date (since a later version exists in the repository).


Applied Parameters: ObjectKind=PanelDocument|Action=Properties

Summary

This command is used to access VCS repository property information for the file currently selected in the Files region of the Storage Manager panel.

Access

With a single, versioned document selected in the Files region of the Storage Manager panel, this command is accessed by right-clicking over that document and choosing the VCS Properties command from the context menu.

Use

After launching the command, the Properties dialog will appear. The dialog presents property information relating to the selected document, including:

  • Path to the local document (in your working folder).
  • URL for the document's location in the VCS repository.
  • Repository Root and UUID.
  • Current revision of the document in your local working folder.
  • Last changed author.
  • Last changed revision.
  • Last change time.
  • Whether or not the document is conflicted.


Applied Parameters: ObjectKind=PanelDocument|Action=AddProject

Summary

This command is used to add the selected project to your version control repository/database.

Access

This command is accessed by right-clicking within the Files region of the Storage Manager panel and choosing the Add Project Folder to Version Control command from the context menu.

This command is available only when the project has not already (or previously) been added to version control.

Use

After launching the command, the Add to Version Control dialog will appear. Choose the required target Design Repository to which to add the project, then click the New Folder button to quickly create a new folder entry for the current project. After the storage area for the project has been defined (and therefore, the project is linked to the database), clicking OK will populate the dialog with the project and its constituent documents - already selected for addition to the version control database. Select other files that you wish to put into version control at this time, as required.

After clicking OK, the files will be added to the version control database and the entry Scheduled for addition will appear in the associated Status field for the document(s) in the Files region. To complete the process, simply right-click and choose the Commit Whole Project command.


Applied Parameters: Action=CheckoutSVNDBLIBWorkingFolders

Summary

This command is used to quickly check out all symbol and footprint model libraries from the repository - referenced by the SVNDbLib file - into a nominated local working folder. Modifications can then be made to the symbols and footprints in these local working copies, and then committed back to the SVN repository.

Access

This command is accessed from the SVNDbLib Editor by choosing the Tools » Checkout All Working Folders command from the main menus.

Use

After launching the command, a confirmation dialog will appear. After clicking Yes, all symbol and footprint model libraries will be checked out from the repository into the nominated local working folder.

Tips

  1. Specify the required directory to be used on the Data Management - SVN Libraries page of the Preferences dialog. A default working folder location is defined - \Users\<ProfileName>\Documents\My Designs\SVNDBlib Working Folder. Change this as required by either clicking the associated button to browse to an existing folder or by entering a path to the folder directly. The folder nominated as the local working directory should only be used to contain a copy of the version-controlled files. Other files, such as *.SVNDbLib, *.mdb, and *.xls, should be located in a different directory, as these are not under version control. The default working folder location does not physically exist by default. This will be created when checking out files from the repository. This will also be the case if you specify a folder (through direct path entry) that does not currently exist.
  2. The folders checked out will be those specified in the Models Location region, on the SVN Repository tab of the Database Library Options dialog.


Applied Parameters: ObjectKind=FocusedProject|Action=Add

Summary

This command is used to add the active/focused project document back to version control (where it has previously been removed).

Access

This command can be accessed for the active project or the focused project:

  • Active Project - with a source document for the project open as the active document, choose the Project » Version Control » Add to Version Control command from the main menus.
  • Focused Project - in the Projects panel, right-click on the entry for the project and choose the Version Control » Add to Version Control command from the context menu.
The command will only be available provided the project document - that was previously added to version control - has subsequently been removed from version control.

Use

After launching the command, the project document will be scheduled for addition to version control, distinguished in the Projects panel by the  icon. To complete the process, you will need to either use the Commit command or the Commit Whole Project command.


Applied Parameters: ObjectKind=FocusedProject|Action=Remove

Summary

This command is used to remove the active/focused project document from version control (where it has previously been added).

Access

This command can be accessed for the active project or the focused project:

  • Active Project - with a source document for the project open as the active document, choose the Project » Version Control » Remove from Version Control command from the main menus.
  • Focused Project - in the Projects panel, right-click on the entry for the project and choose the Version Control » Remove from Version Control command from the context menu.
The command will only be available provided the project document has been added to version control.

Use

After launching the command, the project document will be scheduled for deletion from version control, distinguished in the Projects panel by the  icon. To complete the process, you will need to either use the Commit command or the Commit Whole Project command.


Applied Parameters: ObjectKind=FocusedProject|Action=Commit

Summary

This command is used to check-in modifications made to the working copy of the project document into your VCS repository. The project document is distinguished as having been modified by using the  icon in the Projects panel.

Access

This command can be accessed for the active project or the focused project:

  • Active Project - with a source document for the project open as the active document, choose the Project » Version Control » Commit command from the main menus.
  • Focused Project - in the Projects panel, right-click on the entry for the project and choose the Version Control » Commit command from the context menu.
The command will only be available provided the project document has been modified.

Use

After launching the command, the Edit Comment dialog will appear. Enter a new comment or select a previous comment and click OK to commit the document. The latest copy of the document in your working folder will be checked in and the associated revision number incremented.

Tips

  1. Note that you will not be allowed to commit the document if someone else has committed an update since you checked out your copy of the file. In this case you will be required to perform an Update first before committing the file.


Applied Parameters: ObjectKind=FocusedProject|Action=Update

Summary

The command is used to update the out of date working copy of the project file with changes that exist in the latest revision for the file from the VCS repository. The project document is distinguished as being out of date by use of the  icon in the Projects panel.

Access

This command can be accessed for the active project, or the focused project:

  • Active Project - with a source document for the project open as the active document, choose the Project » Version Control » Update command from the main menus.
  • Focused Project - in the Projects panel, right-click on the entry for the project and choose the Version Control » Update command from the context menu.
The command will only be available provided the project document is currently out of date.

Use

After launching the command the file versions will be synchronized, with the local version of the project document being updated to the latest revision of that document from the version control repository. The status for the file in the Projects panel will return to No Modification ().


Applied Parameters: ObjectKind=FocusedProject|Action=Lock

Summary

This command is used to lock the project file. Only the designer who locked the document can commit the document with any modifications to the version control repository.

Access

This command can be accessed for the active project, or the focused project:

  • Active Project - with a source document for the project open as the active document, choose the Project » Version Control » Lock command from the main menus.
  • Focused Project - in the Projects panel, right-click on the entry for the project and choose the Version Control » Lock command from the context menu.
The command will only be available provided the project document is currently unlocked.

Use

After launching the command, the project file will be locked, reflected in the Projects panel with the entry Locked by me ().

Tips

  1. For another user, the entry in the Projects panel will appear as Locked by someone else ().
  2. If you modify and save the project file that you currently have locked, the Status will change to Modified and locked by me (). Committing the change will unlock the file.
  3. You cannot lock the project file if it is out of date.


Applied Parameters: ObjectKind=FocusedProject|Action=Unlock

Summary

This command is used to unlock the project file. After unlocking, any user can commit the document with any modifications to the version control repository.

Access

This command can be accessed for the active project, or the focused project:

  • Active Project - with a source document for the project open as the active document, choose the Project » Version Control » Unlock command from the main menus.
  • Focused Project - in the Projects panel, right-click on the entry for the project and choose the Version Control » Unlock command from the context menu.
The command will only be available provided the project document is currently locked.

Use

After launching the command, the project file will be unlocked.


Applied Parameters: ObjectKind=FocusedProject|Action=Resolve

Summary

This command is used to resolve the conflict for the project file, which is distinguished in the Projects panel by the  icon. A conflict can arise where the same file has been locally edited and saved by two Altium NEXUS users, and one has committed those changes.  This means that one designer's sequence of steps (check out, edit, save, commit) have interleaved with that of another designer, so a file that a user has checked out from the repository for editing may not remain as latest revision while it is being worked on - another user has updated the revision in the interim. Whomever first commits the edits to the repository in this case will dominate by creating a new revision, while another user that has edited and saved the same file will face a 'Conflict' situation. From a VCS perspective, which compares the working folder files to the repository files, a Conflict represents the condition where an out of date revision of a file in the working folder has been edited and saved.

Access

This command can be accessed for the active project, or the focused project:

  • Active Project - with a source document for the project open as the active document, choose the Project » Version Control » Resolve Conflicts command from the main menus.
  • Focused Project - in the Projects panel, right-click on the entry for the project and choose the Version Control » Resolve Conflicts command from the context menu.
The command will only be available provided there is a conflict with the project document.

Use

After launching the command, a confirmation dialog will appear, warning you that by resolving the conflict, changes committed to the repository since you last updated will be discarded - click Yes to proceed. The project file in your working folder will be updated to the latest revision checked into the repository by the other user, but the editor will retain the changes you have made to the previous revision. The local file therefore acquires a state of Modified, allowing you to commit those changes to a new revision in the repository - using the Commit command, or the Commit Whole Project command.

Tips

  1. Once you have committed the project file, the other user will see the file(s) as Out of date, since you have created a newer revision in the repository.


Applied Parameters: ObjectKind=FocusedProject|Action=Revert

Summary

This command is used to discard local modifications for the project file.

Access

This command can be accessed for the active project, or the focused project:

  • Active Project - with a source document for the project open as the active document, choose the Project » Version Control » Revert Local Modifications command from the main menus.
  • Focused Project - in the Projects panel, right-click on the entry for the project and choose the Version Control » Revert Local Modifications command from the context menu.
The command will only be available provided modifications have been made to the local working copy of the project document.

Use

After launching the command, a confirmation dialog will appear asking whether you wish to discard your local changes - click Yes to proceed. All local modifications to the project document will be lost, and the file will be reverted back to its base revision (the last revision of the file checked out/updated to the working folder). The Status of a file that has been reverted depends on its previous status. For example a file showing as Modified will revert back to No modification. A file that was in Conflict will revert back to Out of date (since a later version exists in the repository).


Applied Parameters: ObjectKind=FocusedProject|Action=CleanUp

Summary

This command runs Subversion's Cleanup tool for the project document. Before any changes are made to your local working copy of the project file, Subversion create a kind of 'to-do' list - actions it needs to do to perform the changes safely. As it performs these actions, it places a lock on the relevant part of the working copy while it works. This prevents other Subversion clients from accessing the working copy mid-change. Once finished, this lock is released and Subversion cleans up its private to-do list. If a Subversion operation is interrupted however - for example the process is interrupted, or if the computer crashes - the private to-do list remains on disk. This allows Subversion to return to that list later to complete any unfinished operations and return your working copy to a consistent state.

This cleanup command searches your working copy and runs any leftover to-do items, removing working copy locks as it completes those operations.

Access

This command can be accessed for the active project, or the focused project:

  • Active Project - with a source document for the project open as the active document, choose the Project » Version Control » Cleanup command from the main menus.
  • Focused Project - in the Projects panel, right-click on the entry for the project and choose the Version Control » Cleanup command from the context menu.
The command will only be available provided modifications have been made to the local working copy of the project document, and changes that were being implemented by Subversion were interrupted, without completing its full to-do list.

Use

After launching the command, Subversion runs any leftover to-do items - that remained after being previously interrupted - removing working copy locks as it completes those operations, and ultimately returning your working copy of the project document to a consistent state.

Tips

  1. If Subversion ever tells you that some part of your working copy is locked, try running this command to remedy the problem.


Applied Parameters: ObjectKind=FocusedProject|Action=RefreshProject

Summary

This command is used to refresh the status of the documents in your local working folder. It compares the files in the working folder to their counterparts in the design repository, refreshing the status of each document accordingly.

Access

This command can be accessed for the active project, or the focused project:

  • Active Project - with a source document for the project open as the active document, choose the Project » Version Control » Refresh command from the main menus.
  • Focused Project - in the Projects panel, right-click on the entry for the project and choose the Version Control » Refresh command from the context menu.

Use

After launching the command, the documents and their status information are refreshed, with the VCS status icons updated accordingly in the Projects panel.


Applied Parameters: ObjectKind=FocusedProject|Action=CommitProject

Summary

This command is used to check in modifications to all files in the parent project, en-masse. It also gives the ability to add to version control, any documents for the project that are not currently under version control.

Access

This command can be accessed for the active project, or the focused project:

  • Active Project - with a source document for the project open as the active document, choose the Project » Version Control » Commit Whole Project command from the main menus.
  • Focused Project - in the Projects panel, right-click on the entry for the project and choose the Version Control » Commit Whole Project command from the context menu.
The command will only be available provided there is at least one document that has been modified, or there is at least one document that has not yet been added to version control.

Use

After launching the command, the Add to Version Control dialog will appear. All modified files will be enabled for commit. If there are any other files not yet under version control, these will also be listed, but not enabled by default. Choose what you want to commit and/or add to your version control repository, enter a comment if required, and click Commit - the files will be added to the version control database and the entry No modification () will appear in the Projects panel.


Applied Parameters: ObjectKind=FocusedProject|Action=UpdateProject

Summary

This command is used to update files that are out of date in the parent project, en-masse, by updating the working copy of each file with changes that exist in the latest revision for the file, from the VCS repository.

Access

This command can be accessed for the active project, or the focused project:

  • Active Project - with a source document for the project open as the active document, choose the Project » Version Control » Update Whole Project command from the main menus.
  • Focused Project - in the Projects panel, right-click on the entry for the project and choose the Version Control » Update Whole Project command from the context menu.
The command will only be available provided there is at least one document that is currently out of date.

Use

After launching the command, the Update from Version Control dialog will appear. All out of date files will be enabled for update. Choose what you want to update and click Update - the file versions will be synchronized, with the local version of each selected document being updated to the latest revision of that document from the version control repository. The status for each file in the Projects panel will return to No Modification ().


Applied Parameters: ObjectKind=FocusedProject|Action=AddProject

Summary

This command is used to add the selected project to your version control repository/database.

Access

This command can be accessed for the active project, or the focused project:

  • Active Project - with a source document for the project open as the active document, choose the Project » Version Control » Add Project Folder to Version Control command from the main menus.
  • Focused Project - in the Projects panel, right-click on the entry for the project and choose the Version Control » Add Project Folder to Version Control command from the context menu.
This command is available only when the project has not already (or previously) been added to version control.

Use

After launching the command, the Add to Version Control dialog will appear. Choose the required target Design Repository to which to add the project, then click the New Folder button to quickly create a new folder entry for the current project. After the storage area for the project has been defined (and therefore, the project is linked to the database), clicking OK will populate the dialog with the project and its constituent documents - already selected for addition to the version control database. Select other files that you wish to put into version control at this time, as required.

After clicking OK, the files will be added to the version control database and the entry Scheduled for addition () will appear for the document(s) in the Projects panel. To complete the process, simply use the Commit Whole Project command.


Applied Parameters: ObjectKind=FocusedDocument|Action=Add

Summary

This command is used to add the focused document to version control.

Access

This command is accessed from the Projects panel by right-clicking on the entry for the document and choosing the Version Control » Add to Version Control command from the context menu.

The command will only be available provided the document is not currently in version control.

Use

After launching the command, the document will be scheduled for addition to version control, distinguished in the Projects panel by the  icon. To complete the process, you will need to either use the Commit command, or the Commit Whole Project command.


Applied Parameters: ObjectKind=FocusedDocument|Action=Remove

Summary

This command is used to remove the focused document from version control (where it has previously been added).

Access

This command is accessed from the Projects panel by right-clicking on the entry for the document and choosing the Version Control » Remove from Version Control command from the context menu.

The command will only be available provided the document has been added to version control.

Use

After launching the command, the document will be scheduled for deletion from version control, distinguished in the Projects panel by the  icon. To complete the process, you will need to either use the Commit command, or the Commit Whole Project command.


Applied Parameters: ObjectKind=FocusedDocument|Action=Commit

Summary

This command is used to check-in modifications made to the working copy of the focused document into your VCS repository. The document is distinguished as having been modified by use of the  icon in the Projects panel.

Access

This command is accessed from the Projects panel by right-clicking on the entry for the document and choosing the Version Control » Commit command from the context menu.

The command will only be available provided the document has been modified.

Use

After launching the command, the Edit Comment dialog will appear. Enter a new comment or select a previous comment and click OK to commit the document. The latest copy of the document in your working folder will be checked in and the associated revision number incremented.

Tips

  1. Note that you will not be allowed to commit the document if someone else has committed an update since you checked out your copy of the file. In this case you will be required to perform an Update first before committing the file.


Applied Parameters: ObjectKind=FocusedDocument|Action=CompareWithHead

Summary

This command is used to compare the focused document with the head revision of that document from the VCS repository.

Access

This command is accessed from the Projects panel by right-clicking on the entry for the document and choosing the Version Control » Compare with Head command from the context menu.

Use

After launching the command, a comparison is made between the local working copy of the focused document, and the Head revision in the VCS repository, 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.


Applied Parameters: ObjectKind=FocusedDocument|Action=Update

Summary

The command is used to update the out of date working copy of the focused document with changes that exist in the latest revision for the file from the VCS repository. The document is distinguished as being out of date by use of the  icon in the Projects panel.

Access

This command is accessed from the Projects panel by right-clicking on the entry for the document and choosing the Version Control » Update command from the context menu.

The command will only be available provided the document is currently out of date.

Use

After launching the command the file versions will be synchronized, with the local version of the document being updated to the latest revision of that document from the version control repository. The status for the file in the Projects panel will return to No Modification ().


Applied Parameters: ObjectKind=FocusedDocument|Action=Lock

Summary

This command is used to lock the focused document. Only the designer who locked the document can commit the document with any modifications to the version control repository.

Access

This command is accessed from the Projects panel by right-clicking on the entry for the document and choosing the Version Control » Lock command from the context menu.

The command will only be available provided the document is currently unlocked.

Use

After launching the command, the document will be locked, reflected in the Projects panel with the entry Locked by me ().

Tips

  1. For another user, the entry in the Projects panel will appear as Locked by someone else ().
  2. If you modify and save the file that you currently have locked, the Status will change to Modified and locked by me (). Committing the change will unlock the file.
  3. You cannot lock the file if it is out of date.


Applied Parameters: ObjectKind=FocusedDocument|Action=Unlock

Summary

This command is used to unlock the focused document. After unlocking, any user can commit the document with any modifications to the version control repository.

Access

This command is accessed from the Projects panel by right-clicking on the entry for the document and choosing the Version Control » Unlock command from the context menu.

The command will only be available provided the document is currently locked.

Use

After launching the command, the document will be unlocked.


Applied Parameters: ObjectKind=FocusedDocument|Action=Resolve

Summary

This command is used to resolve the conflict for the focused document, which is distinguished in the Projects panel by the  icon. A conflict can arise where the same file has been locally edited and saved by two Altium NEXUS users, and one has committed those changes.  This means that one designer's sequence of steps (check out, edit, save, commit) have interleaved with that of another designer, so a file that a user has checked out from the repository for editing may not remain as latest revision while it is being worked on - another user has updated the revision in the interim. Whomever first commits the edits to the repository in this case will dominate by creating a new revision, while another user that has edited and saved the same file will face a 'Conflict' situation. From a VCS perspective, which compares the working folder files to the repository files, a Conflict represents the condition where an out of date revision of a file in the working folder has been edited and saved.

Access

This command is accessed from the Projects panel by right-clicking on the entry for the document and choosing the Version Control » Resolve Conflicts command from the context menu.

The command will only be available provided there is a conflict with the document.

Use

After launching the command, a confirmation dialog will appear, warning you that by resolving the conflict, changes committed to the repository since you last updated will be discarded - click Yes to proceed. The file in your working folder will be updated to the latest revision checked into the repository by the other user, but the editor will retain the changes you have made to the previous revision. The local file therefore acquires a state of Modified, allowing you to commit those changes to a new revision in the repository - using the Commit command, or the Commit Whole Project command.

Tips

  1. Once you have committed the file, the other user will see the file(s) as Out of date, since you have created a newer revision in the repository.


Applied Parameters: ObjectKind=FocusedDocument|Action=Revert

Summary

This command is used to discard local modifications for the focused document.

Access

This command is accessed from the Projects panel by right-clicking on the entry for the document and choosing the Version Control » Revert Local Modifications command from the context menu.

The command will only be available provided modifications have been made to the local working copy of the document.

Use

After launching the command, a confirmation dialog will appear asking whether you wish to discard your local changes - click Yes to proceed. All local modifications to the document will be lost, and the file will be reverted back to its base revision (the last revision of the file checked out/updated to the working folder). The Status of a file that has been reverted depends on its previous status. For example a file showing as Modified will revert back to No modification. A file that was in Conflict will revert back to Out of date (since a later version exists in the repository).


Applied Parameters: ObjectKind=FocusedDocument|Action=CleanUp

Summary

This command runs Subversion's Cleanup tool for the focused document. Before any changes are made to your local working copy of the file, Subversion create a kind of 'to-do' list - actions it needs to do to perform the changes safely. As it performs these actions, it places a lock on the relevant part of the working copy while it works. This prevents other Subversion clients from accessing the working copy mid-change. Once finished, this lock is released and Subversion cleans up its private to-do list. If a Subversion operation is interrupted however - for example the process is interrupted, or if the computer crashes - the private to-do list remains on disk. This allows Subversion to return to that list later to complete any unfinished operations and return your working copy to a consistent state.

This cleanup command searches your working copy and runs any leftover to-do items, removing working copy locks as it completes those operations.

Access

This command is accessed from the Projects panel by right-clicking on the entry for the document and choosing the Version Control » Cleanup command from the context menu.

The command will only be available provided modifications have been made to the local working copy of the document, and changes that were being implemented by Subversion were interrupted, without completing its full to-do list.

Use

After launching the command, Subversion runs any leftover to-do items - that remained after being previously interrupted - removing working copy locks as it completes those operations, and ultimately returning your working copy of the document to a consistent state.

Tips

  1. If Subversion ever tells you that some part of your working copy is locked, try running this command to remedy the problem.


Applied Parameters: ObjectKind=FocusedDocument|Action=CommitProject

Summary

This command is used to check in modifications to all files in the parent project, en-masse. It also gives the ability to add to version control, any documents for the project that are not currently under version control.

Access

This command is accessed from the Projects panel by right-clicking on the entry for the document and choosing the Version Control » Commit Whole Project command from the context menu.

The command will only be available provided there is at least one document that has been modified, or there is at least one document that has not yet been added to version control.

Use

After launching the command, the Add to Version Control dialog will appear. All modified files will be enabled for commit. If there are any other files not yet under version control, these will also be listed, but not enabled by default. Choose what you want to commit and/or add to your version control repository, enter a comment if required, and click Commit - the files will be added to the version control database and the entry No modification () will appear in the Projects panel.


Applied Parameters: ObjectKind=FocusedDocument|Action=UpdateProject

Summary

This command is used to update files that are out of date in the parent project, en-masse, by updating the working copy of each file with changes that exist in the latest revision for the file, from the VCS repository.

Access

This command is accessed from the Projects panel by right-clicking on the entry for the document and choosing the Version Control » Update Whole Project command from the context menu.

The command will only be available provided there is at least one document that is currently out of date.

Use

After launching the command, the Add to Version Control dialog will appear. All out of date files will be enabled for update. Choose what you want to update and click Update - the file versions will be synchronized, with the local version of each selected document being updated to the latest revision of that document from the version control repository. The status for each file in the Projects panel will return to No Modification ().


Applied Parameters: ObjectKind=FocusedDocument|Action=AddProject

Summary

This command is used to add the selected project to your version control repository/database.

Access

This command is accessed from the Projects panel by right-clicking on the entry for the document and choosing the Version Control » Add Project Folder to Version Control command from the context menu.

This command is available only when the project has not already (or previously) been added to version control.

Use

After launching the command, the Add to Version Control dialog will appear. Choose the required target Design Repository to which to add the project, then click the New Folder button to quickly create a new folder entry for the current project. After the storage area for the project has been defined (and therefore, the project is linked to the database), clicking OK will populate the dialog with the project and its constituent documents - already selected for addition to the version control database. Select other files that you wish to put into version control at this time, as required.

After clicking OK, the files will be added to the version control database and the entry Scheduled for addition () will appear for the document(s) in the Projects panel. To complete the process, use the Commit Whole Project command.


Applied Parameters: ObjectKind=FocusedDocument|Action=RefreshProject

Summary

This command is used to refresh the status of the documents in your local working folder. It compares the files in the working folder to their counterparts in the design repository, refreshing the status of each document accordingly.

Access

This command is accessed from the Projects panel by right-clicking on the entry for the document and choosing the Version Control » Refresh command from the context menu.

Use

After launching the command, the documents and their status information are refreshed, with the VCS status icons updated accordingly in the Projects panel.

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?
You are reporting an issue with the following selected text
and/or image within the active document:
ALTIUM DESIGNER FREE TRIAL
Altium Designer Free Trial
Let’s get started. First off, are you or your organization already using Altium Designer?

If would like to speak with a representative, please contact your local Altium office.
Copyright © 2019 Altium Limited

In that case, why do you need an evaluation license?

If would like to speak with a representative, please contact your local Altium office.
Copyright © 2019 Altium Limited

Got it. You actually don’t need an evaluation license for that.

Click the button below to download the latest Altium Designer installer.

Download Altium Designer Installer

If would like to speak with a representative, please contact your local Altium office.
Copyright © 2019 Altium Limited

Please fill out the form below to get a quote for a new seat of Altium Designer.

By clicking “Get Your Free Trial”, you are agreeing to our Privacy Policy.
You may receive communications from Altium and can change your notification preferences at any time.

If you are on Altium Subscription, you don’t need an evaluation license.

If you are not an active Altium Subscription member, please fill out the form below to get your free trial.

By clicking “Get Your Free Trial”, you are agreeing to our Privacy Policy.
You may receive communications from Altium and can change your notification preferences at any time.

Why are you looking to evaluate Altium Designer?

If would like to speak with a representative, please contact your local Altium office.
Copyright © 2019 Altium Limited

You came to the right place! Please fill out the form below to get your free trial started.

By clicking “Get Your Free Trial”, you are agreeing to our Privacy Policy.
You may receive communications from Altium and can change your notification preferences at any time.

Great News!

Valid students can get their very own 6-month Altium Designer Student License for FREE! Just fill out the form below to request your Student License today.

By clicking “Get Your Free Trial”, you are agreeing to our Privacy Policy.
You may receive communications from Altium and can change your notification preferences at any time.

Got it. You can download a free Altium Designer Viewer license which is valid for a 6 months.

Please fill out the form below to request one.

By clicking “Get Your Free Trial”, you are agreeing to our Privacy Policy.
You may receive communications from Altium and can change your notification preferences at any time.

That’s great! Making things is awesome. We have the perfect program for you.

Upverter is a free community-driven platform designed specifically to meet the needs of makers like you.

Click here to give it a try!

If would like to speak with a representative, please contact your local Altium office.
Copyright © 2019 Altium Limited

Got it. You can download a free Altium Designer Viewer license which is valid for a 6 months.

Please fill out the form below to request one.

By clicking “Get Your Free Trial”, you are agreeing to our Privacy Policy.
You may receive communications from Altium and can change your notification preferences at any time.