HDL Designer Series Command Reference

Version 2018.1

Description
VersionManagement Commands.


runVMChangeLock (args)

change lock on a specified library, design unit, view
Uses options set by setupVMChangeLock.
Argument: args listed below
library The library name - This is required
designUnit design unit name (optional)
view view name (optional, absent if design unit not specified)

runVMCheckIn (args)

check in a specified library, design unit, view
Uses options set by setupVMCheckIn.
Argument: args listed below
library The library name - This is required
designUnit design unit name (optional)
view view name (optional, absent if design unit not specified)

runVMCheckOut (args)

check out a specified library, design unit, view
Uses options set by setupVMCheckOut.
Argument: args listed below
library The library name - This is required
designUnit design unit name (optional)
view view name (optional, absent if design unit not specified)

runVMGet (args)

get a specified library, design unit, view
Uses options set by setupVMGet.
Argument: args listed below
library The library name - This is required
designUnit design unit name (optional)
view view name (optional, absent if design unit not specified)

runVMHistory (args)

get the history of a specified library, design unit, view
Argument: args listed below
library The library name - This is required
designUnit design unit name (optional)
view view name (optional, absent if design unit not specified)

runVMLabel (args)

label a specified library, design unit, view
Uses options set by setupVMLabel.
Argument: args listed below
library The library name - This is required
designUnit design unit name (optional)
view view name (optional, absent if design unit not specified)

runVMSynchronize (args)

synchronize a specified library, design unit, view
Uses options set by setupVMSynchronize.
Argument: args listed below
library The library name - This is required
designUnit design unit name (optional)
view view name (optional, absent if design unit not specified)

runVMUndoCheckOut (args)

check out a specified library, design unit, view
Argument: args listed below
library The library name - This is required
designUnit design unit name (optional)
view view name (optional, absent if design unit not specified)

setupVM (option arg)

Setup the options for Version Management.
Argument: option Option name
Argument: arg Option value
-tool <string> The Version management interface required.
-library <string> Specify the library on which you want to invoke these options (this is only necessary if you want to set the repository mappings).
-repository <string> Specify the repository mapping
-hds_repository <string> Specify the hds repository mapping
-hdl_repository <string> The hdl repository mapping
-include_default_view 1|0 You can choose the version manage the default view file
-include_side_data 1|0 Side data for a version managed object is included
-verbose 1|0 Additional info is displayed in the log window
-create_empty_side_data 1|0 Automatically create side data directories if they do not exist
-multiple_repository_mode 1|0 Repository is defined on a mapping by mapping basis
-include_generated_hdl 1|0 Generated HDL for a version managed object is included

setupVMChangeLock (option arg)

Setup the change lock options for Version Management.
Argument: option Option name
Argument: arg Option value
-version <string> The version required.
-change_lock 1|0 When you lock an object, the version in your private workspace is made editable. If you unlock an object, the version in your workspace is made read-only.

setupVMCheckIn (option arg)

Setup the check-in options for Version Management.
Argument: option Option name
Argument: arg Option value
-version <string> The version required.
-label <string> You can specifiy a symbolic label which is associated wih a particular set of objects
-description <string> Specify a description for the check in
-overwrite_label 1|0 Transfer the label to the new version number
-retain_lock 1|0 You can choose to retain a lock on the checked in objects

setupVMCheckOut (option arg)

Setup the check-out options for Version Management.
Argument: option Option name
Argument: arg Option value
-version <string> The version required.
-lock 1|0 The objects are normally checked out with a lock to prevent concurrent editing by other users but you can choose to unset this option.
-comment <string> If you are using ClearCase, you can enter a comment in the descrption field.

setupVMGet (option arg)

Setup the Get options for Version Management.
Argument: option Option name
Argument: arg Option value
-version <string> The version required.
-overwrite 1|0 Transfer the label to the new version number.

setupVMHierarchy (option arg)

Setup the hierarchy options for Version Management.
Argument: option Option name
Argument: arg Option value
-hierarchy 1|0 Include the hierarchy below the selected object.
-through_components 1|0 If hierarchy selected, then include components.
-through_libraries 1|0 You can choose to limit the scope to the current library or operate on objects through all libraries.
-include_protected_libraries 1|0 Include objects in protected libraries.
-packages 1|0 Automatically include referenced VHDL packages or Verilog include files.
-current_design_only 1|0 Version Management operations on a parent design unit will run on the specified view for each instance. If no view is specified, they will run on the default view.

setupVMLabel (option arg)

Setup the label options for Version Management.
Argument: option Option name
Argument: arg Option value
-version <string> The version required.
-label <string> Specify the required label.
-add 1|0 Add or remove the label.
-overwrite 1|0 Transfer the label to the new version number.
-description <string> Specify a description for the label.

setupVMSynchronize (option arg)

Setup the Synchronize options for Version Management.
Argument: option Option name
Argument: arg Option value
-version <string> The version required.
-add_files 1|0 If this option is not set, only objects that already exist are synchronized


Copyright © Mentor Graphics Corporation 2018. All Rights Reserved.