VersionControl

Created: July 27, 2015 | Updated: July 28, 2020 | Applies to versions: 15.1, 16.0 and 16.1

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

Applied Parameters: ObjectKind=PanelDocument|Action=Commit

Summary

This command allows designers to commit a modified document to version control.

Access

Select one or more modified documents from the Project Files region of the Storage Manager panel. Right-click and select Commit from the context menu.

Use

After running the command, the Edit Comment dialog opens. Enter a new comment or select a previous comment and click OK to commit the document.

Commit Project

Applied Parameters: ObjectKind=PanelDocument|Action=CommitProject

Summary

This command allows designers to commit a project with at least one modified document to version control.

Access

With at least one modified document in the project, right-click in the Project Files region of the Storage Manager panel. Select Commit Whole Project from the context menu.

Use

After running the command, the Commit to Version Control dialog opens. Selected the desired files to commit, enter a comment, and click OK to commit the project.

Update

Applied Parameters: ObjectKind=PanelDocument|Action=Update

Summary

The command updates the working copy of the selected file with changes that exist in the latest revision for that file from the VCS repository.

Access

With one or more 'Out of Date' documents selected in the Project Files region of the Storage Manager panel, right-click and select Update from the context menu.

Use

For an ASCII-based file, this update will happen automatically. For binary files, such as schematics and PCBs, this is not possible. In this case, CVS/SVN will check out a copy of the file to your working folder, prefixed with the hash character (#). You can then do a visual comparison and resolve the differences manually.

Use this command to update your local working copy of files in the selected folder and all sub-folders, with the latest version from the repository.

Update Project

Applied Parameters: ObjectKind=PanelDocument|Action=UpdateProject

Summary

The command updates the working copy of the files from the selected focused project with changes from the VCS repository.

Access

With one or more 'Out of Date' documents selected in the Project Files region of the Storage Manager panel, right-click and select Update Whole Project from the context menu.

Use

Use this command to update your local working copy of files in the selected folder and all sub-folders, with the latest version from the repository.

Lock

Applied Parameters: ObjectKind=PanelDocument|Action=Lock

Summary

This command is used to Lock Active Document in Version Control. Only the designer who locked the document can commit the document with any modification to the repository.

Access

With at least one unlocked document selected in the Project Files region of the Storage Manager panel, right-click and select Lock from the context menu.

Use

After running this command, the status column will appear 'Locked by me' in the Storage Manager Panel.

Unlock

Applied Parameters: ObjectKind=PanelDocument|Action=Unlock

Summary

This command is used to Unlock a selected, locked document in Version Control. After unlocking, any user can commit the document with any modification to the repository.

Access

With at least one locked document selected in the Project Files region of the Storage Manager panel, right-click and select Unlock from the context menu.

Use

After running this command, the status column

Add

Applied Parameters: ObjectKind=PanelDocument|Action=Add

Summary

This command is used to add an active document into the version control repository.

Access

With at least one non-versioned document selected in the Project Files region of the Storage Manager panel, right-lcick and select Add to Version Control from the context menu.

Use

After running this command, the document will be marked for addition to version control.

Remove

Applied Parameters: ObjectKind=PanelDocument|Action=Remove

Summary

This command removes a selected document from the version control repository.

Access

With at least one versioned document selected in the Project Files region of the Storage Manager panel, right-lcick and select Remove from Version Control from the context menu.

Use

After running the command, the document will be marked for deletion from version control.

Resolve

Applied Parameters: ObjectKind=PanelDocument|Action=Resolve

Summary

This command is used to resolve conflicts created when multiple users are working in one document.

Access

With at least one conflicting document selected in the Project Files region of the Storage Manager panel, right-click and select Resolve Conflict from the context menu.

Use

After running the command, a confirmation dialog appears. Click OK to override the current version in the design repository and replace it with your updated local copy.

Revert

Applied Parameters: ObjectKind=PanelDocument|Action=Revert

Summary

This command allows designers to revert local modifications of a document back to the last saved version in the design repository.

Access

With at least one modified document selected in the Project Files region of the Storage Manager panel, right-click and select Revert Local Modifications from the context menu.

Use

After running the command, a confirmation dialog will appear. Click OK to revert the document to the last saved version in the design repository.

VCS Properties

Applied Parameters: ObjectKind=PanelDocument|Action=Properties

Summary

This command allows designers to view version control properties for a selected document.

Access

Right-click over a versioned document in the Project Files region of the Storage Manager panel and select VCS Properties from the context menu.

Use

After running the command a Properties dialog will open and properties related to version control for the document.

Add Project Folder to Version Control

Applied Parameters: ObjectKind=PanelDocument|Action=AddProject

Summary

This command allows you to add a project folder to version control.

Access

In the Project Files region of the Storage Manager panel, right-click on a project or document not currently under version control and select Add Project Folder to Version Control from the context menu.

Use

After running the command, the Add to Version Control dialog opens. Select a repository folder and click OK.

Check Out All Working Folders

Applied Parameters: Action=CheckoutSVNDBLIBWorkingFolders

Summary

Use this command to quickly check out all symbol and footprint model libraries, specified in the SVNDBLIB file, from the SVN repository, to the nominated Librarian working folder.

Access

When an SVNDBLIB is the active document, select Tools » Checkout All Working Folders from the toolbar.

Use

After running the command, a confirmation dialog will appear. After clicking OK, the repository contents in your working folders will be checked out.

The Librarian local working folder is specified on the Version Control - SVN Libraries page of the Preferences dialog (DXP » Preferences).

Add to Version Control

Applied Parameters: ObjectKind=FocusedProject|Action=Add

Summary

This command is used to add a project to version control.

Access

This command can be accessed in the following ways:

Select Project » Version Control » Add to Version Control from the toolbar.
Select, then right-click on the desired project in the Projects panel and select Version Control » Add to Version Control from the context menu.

Use

After running the command, the project will be scheduled for addition to version control.

Remove From Version Control

Applied Parameters: ObjectKind=FocusedProject|Action=Remove

Summary

This command is used to remove a project from version control.

Access

This command can be accessed in the following ways:

Select Project » Version Control » Remove from Version Control from the toolbar.
Select and right-click on the desired project in the Projects panel and select Version Control » Remove from Version Control from the context menu.

Use

After running the command, the project will be scheduled for remove from version control.

Commit

Applied Parameters: ObjectKind=FocusedProject|Action=Commit

Summary

This command is used to commit the active document to version control.

Access

This command can be accessed in the following ways:

Select Project » Version Control » Commit from the toolbar.
Ensure the desired project is highlighted, then select and right-click on the desired document in the Projects panel and select Version Control » Commit from the context menu.

Use

After running the command, the document will be marked for addition to version control.

Update

Applied Parameters: ObjectKind=FocusedProject|Action=Update

Summary

This command is used to update the active document in version control.

Access

This command can be accessed in the following ways:

Select Project » Version Control » Update from the toolbar.
Ensure the desired project is highlighted, then select and right-click on the desired document in the Projects panel and select Version Control » Update from the context menu.

Use

After running the command, the active document will be updated to the most recent version in the design repository.

Lock

Applied Parameters: ObjectKind=FocusedProject|Action=Lock

Summary

This command locks the active document so other users are not able to commit changes to the repository.

Access

This command can be accessed in the following ways:

Select Project » Version Control » Lock from the toolbar.
Ensure the desired project is highlighted, then select and right-click on the desired document in the Projects panel and select Version Control » Lock from the context menu.

Use

After running the command, the document's status will change to "Locked by me."

Unlock

Applied Parameters: ObjectKind=FocusedProject|Action=Unlock

Summary

This command unlocks the active document so that other users are able to commit changes to the repository.

Access

This command can be accessed in the following ways:

Select Project » Version Control » Unlock from the toolbar.
Ensure the desired project is highlighted, then select and right-click on the desired document in the Projects panel and select Version Control » Unlock from the context menu.

Use

After running the command, the document's status will no longer read "Locked by me" and the other users will be able to commit changes to the document.

Resolve Conflicts

Applied Parameters: ObjectKind=FocusedProject|Action=Resolve

Summary

This command is used to resolve version control conflicts in the active document.

Access

This command can be accessed in the following ways:

Select Project » Version Control » Resolve Conflicts from the toolbar.
Ensure the desired project is highlighted, then select and right-click on the desired document in the Projects panel and select Version Control » Resolve Conflicts from the context menu.

Use

After running the command, a confirmation dialog appears. Click OK to override the current version in the design repository and replace it with your updated local copy.

Revert Local Modifications

Applied Parameters: ObjectKind=FocusedProject|Action=Revert

Summary

This command allows designers to revert local modifications of a document back to the last saved version in the design repository.

Access

This command can be accessed in the following ways:

Select Project » Version Control » Revert Local Modifications from the toolbar.
Ensure the desired project is highlighted, then select and right-click on the desired document in the Projects panel and select Version Control » Revert Local Modifications from the context menu.

Use

After running the command, a confirmation dialog will appear. Click OK to revert the document to the last saved version in the design repository.

Refresh

Applied Parameters: ObjectKind=FocusedProject|Action=RefreshProject

Summary

This command is used to refresh the status of working documents that are checked out from the version control repository.

Access

This command can be accessed in the following ways:

Select Project » Version Control » Refresh from the toolbar.
Ensure the desired project is highlighted, then select and right-click on the desired document in the Projects panel and select Version Control » Refresh from the context menu.

Use

After running the command, the VCS status for each document in the Projects and Storage Manager panels is refreshed and updated.

Commit Whole Project

Applied Parameters: ObjectKind=FocusedProject|Action=CommitProject

Summary

This command is used to commit design documents that are part of the project to the version control design repository.

Access

This command can be accessed in the following ways:

Select Project » Version Control » Commit Whole Project from the toolbar.
Ensure the desired project is highlighted, then select and right-click on the desired document in the Projects panel and select Version Control » Commit Whole Project from the context menu.

Use

After running the command, the Commit to Version Control dialog appears. Select which files to commit to the repository and click OK.

Update Whole Project

Applied Parameters: ObjectKind=FocusedProject|Action=UpdateProject

Summary

This command updates the working copy of the files from the selected focused project with changes from the VCS repository.

Access

This command can be accessed in the following ways:

Select Project » Version Control » Update Whole Project from the toolbar.
Ensure the desired project is highlighted, then select and right-click on the desired document in the Projects panel and select Version Control » Update Whole Project from the context menu.

Use

For an ASCII-based file, this update will happen automatically. For binary files, such as schematics and PCBs, this is not possible. In this case, SNV/CVS will check out a copy of the file to your working folder, prefixed with the hash character (#). You can then do a visual comparison and resolve the differences manually.

Add Project Folder to Version Control

Applied Parameters: ObjectKind=FocusedProject|Action=AddProject

Summary

This command is used to add a project folder to version control.

Access

This command can be accessed in the following ways:

Select Project » Version Control » Add Project Folder from the toolbar.
Ensure the desired project is highlighted, then select and right-click on the desired document in the Projects panel and select Version Control » Add Project Folder from the context menu.

Use

After running the command, the Add to Version Control dialog opens. Select a target design repository and click OK. The project will be marked for addition to version control.

Add to Version Control

Applied Parameters: ObjectKind=FocusedDocument|Action=Add

Summary

This command is used to add a focused document to version control, after the project document has already been added to the design repository.

Access

This command can be accessed in the following ways:

Select Project » Version Control » Add to Version Control from the toolbar.
Ensure the desired document is selected, right-click in the Projects panel, and select Version Control » Add to Version Control from the context menu.

Use

After running this command, the selected document will be marked for addition to version control.

Remove From version Control

Applied Parameters: ObjectKind=FocusedDocument|Action=Remove

Summary

This command is used to remove a focused document or project from version control.

Access

This command can be accessed in the following ways:

Select Project » Version Control » Remove From Version Control from the toolbar.
Ensure the desired document is selected, right-click in the Projects panel, and select Version Control » Remove From Version Control from the context menu.

Use

After running the command, the selected document(s) will be marked for removal from version control.

Commit

Applied Parameters: ObjectKind=FocusedDocument|Action=Commit

Summary

This command allows designers to commit a modified document to version control.

Access

This command can be accessed in the following ways:

Select Project » Version Control » Commit from the toolbar.
Ensure the desired document is selected, right-click in the Projects panel, and select Version Control » Commit from the context menu.

Use

After running the command, the Edit Comment dialog opens. Add a new comment or select a previously entered comment and click OK the commit the document to version control.

Compare With Head

Applied Parameters: ObjectKind=FocusedDocument|Action=CompareWithHead

Summary

This command is used to compare a selected document with the head revision of the document.

Access

This command can be accessed in the following ways:

Select Project » Version Control » Compare With Head from the toolbar.
Ensure the desired document is selected, right-click in the Projects panel, and select Version Control » Compare With Head from the context menu.

Use

After running the command, the Differences panel opens and the selected revision and head revision of the document open in split pane view allowing the two revisions to be easily compared.

Update

Applied Parameters: ObjectKind=FocusedDocument|Action=Update

Summary

This command is used to update the focused document.

Access

This command can be accessed in the following ways:

Select Project » Version Control » Update from the toolbar.
Ensure the desired document is selected, right-click in the Projects panel, and select Version Control » Update from the context menu.

Use

After running the command the selected document will be updated with the latest version from the design repository.

Lock

Applied Parameters: ObjectKind=FocusedDocument|Action=Lock

Summary

This command is used to lock the focused document.

Access

This command can be accessed in the following ways:

Select Project » Version Control » Lock from the toolbar.
Ensure the desired document is selected, right-click in the Projects panel, and select Version Control » Lock from the context menu.

Use

After running the command, the status of the selected document will read "Locked by me." Other users will not be able to commit changes to the document to the design repository unless the document is unlocked.

Unlock

Applied Parameters: ObjectKind=FocusedDocument|Action=Unlock

Summary

This command is used to unlock the focused document.

Access

This command can be accessed in the following ways:

Select Project » Version Control » Unlock from the toolbar.
Ensure the desired document is selected, right-click in the Projects panel, and select Version Control » Unlock from the context menu.

Use

After running the command, the status of the selected document will no longer read "Locked by me" and the document will be available to other users for committing changes.

Resolve Conflicts

Applied Parameters: ObjectKind=FocusedDocument|Action=Resolve

Summary

This command is used to resolve version control conflicts in the active document.

Access

This command can be accessed in the following ways:

Select Project » Version Control » Resolve Conflicts from the toolbar.
Ensure the desired project is highlighted, then select and right-click on the desired document in the Projects panel and select Version Control » Resolve Conflicts from the context menu.

Use

After running the command, a confirmation dialog appears. Click OK to override the current version in the design repository and replace it with your updated local copy.

Revert Local Modifications

Applied Parameters: ObjectKind=FocusedDocument|Action=Revert

Summary

This command is used to revert local modifications to a specified document back to the last saved version in the design repository.

Access

This command can be accessed in the following ways:

Select Project » Version Control » Resolve Conflicts from the toolbar.
Ensure the desired project is highlighted, then select and right-click on the desired document in the Projects panel and select Version Control » Resolve Conflicts from the context menu.

Use

After running the command, a confirmation dialog appears. Click OK the revert local modifications back to the last saved version in the repository.

Add Folder to Version Control

Applied Parameters: ObjectKind=FocusedDocument|Action=AddFolder

Summary

This command is used to add a project folder to a design repository.

Access

This command can be accessed in the following ways:

Select Project » Version Control » Add Folder to Version Control from the toolbar.
Ensure the desired project is highlighted, then select and right-click on the desired document in the Projects panel and select Version Control » Add Folder to Version Control from the context menu.

Use

After running the command, the Add to Version Control dialog opens. Select a repository folder and click OK.

Commit Whole Project

Applied Parameters: ObjectKind=FocusedDocument|Action=CommitProject

Summary

This command is used to commit an entire project to version control.

Access

This command can be accessed in the following ways:

Select Project » Version Control » Commit Whole Project from the toolbar.
Ensure the desired project is highlighted, then select and right-click on the desired document in the Projects panel and select Version Control » Commit Whole Project from the context menu.

Use

After running the command, the Commit to Version Control dialog launches. Select the files to commit to version control and click OK. The project will be marked for addition to version control.

Update Whole Project

Applied Parameters: ObjectKind=FocusedDocument|Action=UpdateProject

Summary

The command updates the working copy of the files from the selected focused project with changes from the VCS repository.

Access

This command can be accessed in the following ways:

Select Project » Version Control » Update Whole Project from the toolbar.
Ensure the desired project is highlighted, then select and right-click on the desired document in the Projects panel and select Version Control » Update Whole Project from the context menu.

Use

Use this command to update your local working copy of files in the selected folder and all sub-folders, with the latest version from the repository.

Add Project Folder to Version Control

Applied Parameters: ObjectKind=FocusedDocument|Action=AddProject

Summary

This command is used to add a project folder to version control.

Access

This command can be accessed in the following ways:

Select Project » Version Control » Add Project Folder from the toolbar.
Ensure the desired project is highlighted, then select and right-click on the desired document in the Projects panel and select Version Control » Add Project Folder from the context menu.

Use

After running the command, the Add to Version Control dialog opens. Select a target design repository and click OK. The project will be marked for addition to version control.

Refresh

Applied Parameters: ObjectKind=FocusedDocument|Action=RefreshProject

Summary

This command is used to refresh the status of working documents that are checked out from the version control repository.

Access

This command can be accessed in the following ways:

Select Project » Version Control » Refresh from the toolbar.
Ensure the desired project is highlighted, then select and right-click on the desired document in the Projects panel and select Version Control » Refresh from the context menu.

Use

After running the command, the VCS status for each document in the Projects and Storage Manager panels is refreshed and updated.