SCM Menu (with Version Management)
ASCET-SCM adds the SCM menu to the menu bar in the ASCET component manager.
- Before you connect the current database or workspace to an SCM
Source Configuration Management, a general term for versioning of software elements and their relationships. tool, the SCM menu contains the commands described in SCM Menu (without Version Management). - Once you have connected to an SCM tool, this menu contains the commands required for source control. The content of this menu depends on the software version control product (e.g. Subversion) you are using, on the mode (i.e. online or offline) and on the access method through which you display the menu.
This topic describes the content of the SCM menu when the database/workspace is connected to Subversion, both in online and offline mode.
Most commands of the SCM menu are available as Source Control context menu in the "Database" or "Workspace" list of the Component Manager, in the Outline tab of the component editors, and in the drawing area of block diagrams. Some of the commands included in the SCM menu are also available via toolbar icons. |
Online Mode
According to whether the Simple Mode user interface is activated or deactivated, dialog boxes will be shown in Simple Mode or Advanced Mode. |
Source Control
The Source Control submenu of the SCM menu contains the following options.
Show Source Control Settings
Lists the current settings of the selected SCM driver (read-only). The contents depend on the currently selected SCM tool interface. For instance, if you are using Subversion, this command displays the Subversion Settings dialog box.
Remove Source Control Bindings
Deletes any SCM information from the database or workspace. This comprises source control settings (SCM tool driver data) as well as SCM information on each item (e.g. version name, comment, …). This menu command can be used e.g. to clear all SCM-specific data before sending the data to other users who do not have the current SCM add-on installed or who have no access to the used repository.
Please be aware that, after clearing all SCM information, no further SCM activities can be performed for the database/workspace (e.g. no storing of new versions). To reconnect to an SCM repository, use the menu command Configure Source Control.
Remove Source Control Bindings for Selection
Deletes any SCM information for currently selected items. This command does not remove the current SCM settings for the database/workspace. This command is useful if items contain invalid SCM data (e.g. because the item’s repository entry was deleted externally).
Remove Configuration Data
Removes all configuration data from the database or workspace. Version information remains intact.
Remove Configuration Data for Selection
Removes all configuration data for the currently selected items. Version information remains intact. This command is useful if items contain invalid configuration data.
Check Source Control Compatibility
Checks whether the current database or workspace contains items that may cause problems with source control.
Show
The Show submenu of the SCM menu contains the following options.
Items under Source Control
Opens the Items under Source Control dialog box which lists all items that are currently under version control.
Items Not under Source Control
Opens a list which contains all items that are not yet under version control (or that do not contain any SCM information in the current database/workspace). Apart from that, the functionality of this option is similar to Items under Source Control described above.
Locally Modified Items
Lists only those items of a selection, or within a selected folder, that are under version control and differ from the version stored in the current repository, i.e. the item contents have changed after the item had been loaded from the SCM repository.
Invalid Items
Opens a list which contains all items that are in the "invalid" state. This state is set by ASCET or the SCM connection if the item content does not correspond to the revision stated behind the item name. An item can become invalid state e.g. by being overwritten through a "local" import (the standard ASCET import menu instead of SCM menu operations like SVN Update).
Items Modified in Repository
Opens a list of items that are not in the most recent version state. The status modified in repository is set by the SCM interface after a previous version of the item has been loaded by means of the Update command or after Check for Modifications detects a more recent version (probably stored by another user) in the repository.
Items Referencing Missing Components:
Opens a list of items that reference components not present in the current database/workspace.
Single-clicking an item in the list returned by the Show submenu options moves the ASCET database/workspace item selection to the corresponding item. Double-clicking on an item opens the corresponding item editor.
Checkout
Displays the Checkout dialog box in Simple Mode or Advanced Mode which enables you to check out items from the repository so that these can be edited in ASCET. See also: Checking out.
Update
If a folder is selected, this command does not search for items in the same folder that exist in the repository but not yet in the ASCET database/workspace. To retrieve new items, use the Checkout command. |
Displays the Update dialog box in Simple Mode or Advanced Mode. In the Update dialog box, you can select items to be refreshed by applying current data related to these items from the Subversion repository. See also: Updating.
Update to Latest Revision
Retrieves the most recent data for the selected items from the Subversion repository.
Get Lock
Locks (reserves) the selected items exclusively for you in the repository. While in the locked state, items can be edited only by you; other users cannot access these items at the same time. Other users who try to access an item locked by someone else will see a padlock in the item's icon in the browser tree. See also: Locking and Unlocking.
Commit
Stores the current status of the selected items (including your edits) as a new version in the Subversion repository. See also: Committing.
Add and Commit
Adds the currently selected items to version control and stores their current status (including your edits) as a new version in the Subversion repository. The Add and Commit dialog box prompts you to complete this procedure.
Check for Modifications
Compares all selected items that are under version control to their current status in the repository.
- If the local status is out of date, the overlay icons change accordingly.
- If any items have been locked (or unlocked) by another user in the meantime,
the status is set to locked by other user (or back to revision).
- If any items have been removed from the repository by another user, these items are marked as deleted (e.g.,
).
The items checked for modifications are listed in a separate dialog box.
Show Log
Reads the Subversion history of the selected items in ASCET, retrieves the current history status of these items from the Subversion repository, and displays the result in the Show Log dialog box.
Properties
Displays the Version Details dialog box for the selected item.
Configuration Management
The Configuration Management submenu of the SCM menu or the Source Control context menu contains the following options.
Checkout Configuration
Shown as part of the SCM menu in online mode only. |
Displays the Checkout Configuration dialog box which enables you to check out configurations from the repository so that these can be edited in ASCET.
Update Configuration
Displays the Update Configuration dialog box which enables you select a configuration to be updated.
Update to Latest Configuration
Retrieves the most recent data for the selected configuration from the Subversion repository and applies these to the configuration.
Get Lock for Configuration
Locks (reserves) the selected configuration exclusively for you in the repository. While in the locked state, the configuration can be edited only by you; other users cannot access this configuration at the same time. Other users who try to access a configuration locked by someone else will see a padlock in the configuration's icon in the browser tree. See also: Locking and Unlocking.
Release Lock for Configuration
Unlocks the (currently locked) configuration.
Commit Configuration
Displays the Commit Configuration dialog box which enables you to commit the selected configuration to the Subversion repository.
Add and Commit New Configuration
Displays the Add and Commit Configuration dialog box which enables you to save the current configuration in the repository.
You are recommended to use Add and Commit New Configuration for an individual configuration, but not for a folder. If you apply this command at a folder level, each item within this folder will receive its own configuration. |
Show Configuration Log
Displays the Configuration Log dialog box which enables you to write the revision history of the selected configuration to a log file and/or to update this configuration.
Show Configuration Properties
Displays the Details of <Item Name> dialog box.
Compare Configuration
Displays the Compare Configuration dialog box which enables you to compare (i.e. identify differences between) two versions of the selected configuration.
Verify Configuration
Displays the Verify Configuration for Verification dialog box which checks the local status of the currently selected configuration against its status in the repository.
Additional Commands
The Additional Commands submenu of the SCM menu or the Source Control context menu contains the following options.
Update and Lock
Combines Update to Latest and Lock in a single operation. The most recent revisions of the selected items are collected and imported to ASCET. After that, the corresponding entries in the Subversion repository are locked so you can edit them in ASCET. The result of this combined operation is shown in the Items Changed by SCM Update and Lock dialog box. See also: Updating and Locking and Unlocking.
Release Lock
Removes an existing lock (i.e. takes the selected item out of the locked state). After that, you can no longer edit the items. Any local changes are be deleted; the item is updated to its revision status in the repository. See also: Locking and Unlocking.
Edit without Lock
Makes the selected items editable without locking them in the Subversion repository. Consequently, other users are not notified when they try to edit the same item. Therefore, this command requires caution.
This command is mainly intended for temporary tests which will not yield a new revision, or to support changes in ASCET in offline mode (i.e. while you do not have access to the selected Subversion repository server, e.g. during field tests). See also Editing Items in Offline Mode.
Commit New Revision without Lock
If you changed an item using Edit without Lock, this command enables you to store this item in the repository. See also: Editing Items in Offline Mode.
Delete
Takes the selected item out of source control and deletes it from the current database and from the repository. Following this operation, the item will no longer be available to you and/or to other users. The ASCET-SCM Delete Elements dialog box prompts you to confirm this deletion.
If you only want to delete the item locally, use the standard ASCET command Delete. |
Disconnect from Repository
Shown as part of the SCM menu in online mode only. Disconnects the Subversion driver from the repository URL. Note that you can reconnect to the Subversion repository by selecting Connect to Repository. See also Online versus Offline Mode.
Including References
To handle entire groups of ASCET items in Subversion, some of the commands in the SCM menu or the Source Control context menu are also available for selected items together with all their references. They can be found in the Including References submenu.
Update with References
Performs an Update for the selected item and for its references.
Update to Latest Revision with References
Performs an Update to Latest Revision for the selected item and for its references.
Update and Lock with References
Performs an Update and Lock for the selected item and for its references.
Commit with References
Performs a Commit for the selected item and for its references.
Add and Commit with References
Performs an Add and Commit for the selected item and for its references.
Offline Mode
In offline mode, the SCM menu contains
Source Control
The Source Control submenu of the SCM menu contains the following options.
Show Source Control Settings
Lists the current settings of the selected SCM driver (read-only). The contents depend on the currently selected SCM tool interface. For instance, if you are using Subversion, this command displays the Subversion Settings dialog box.
Remove Source Control Bindings
Deletes any SCM information from the database or workspace. This comprises source control settings (SCM tool driver data) as well as SCM information on each item (e.g. version name, comment, …). This menu command can be used e.g. to clear all SCM-specific data before sending the data to other users who do not have the current SCM add-on installed or who have no access to the used repository.
Please be aware that, after clearing all SCM information, no further SCM activities can be performed for the database/workspace (e.g. no storing of new versions). To reconnect to an SCM repository, use the menu command Configure Source Control.
Remove Source Control Bindings for Selection
Deletes any SCM information for currently selected items. This command does not remove the current SCM settings for the database/workspace. This command is useful if items contain invalid SCM data (e.g. because the item’s repository entry was deleted externally).
Remove Configuration Data
Removes all configuration data from the database or workspace. Version information remains intact.
Remove Configuration Data for Selection
Removes all configuration data for the currently selected items. Version information remains intact. This command is useful if items contain invalid configuration data.
Check Source Control Compatibility
Checks whether the current database or workspace contains items that may cause problems with source control.
Show
The Show submenu of the SCM menu contains the following options.
Items under Source Control
Opens the Items under Source Control dialog box which lists all items that are currently under version control.
Items Not under Source Control
Opens a list which contains all items that are not yet under version control (or that do not contain any SCM information in the current database/workspace). Apart from that, the functionality of this option is similar to Items under Source Control described above.
Locally Modified Items
Lists only those items of a selection, or within a selected folder, that are under version control and differ from the version stored in the current repository, i.e. the item contents have changed after the item had been loaded from the SCM repository.
Invalid Items
Opens a list which contains all items that are in the "invalid" state. This state is set by ASCET or the SCM connection if the item content does not correspond to the revision stated behind the item name. An item can become invalid state e.g. by being overwritten through a "local" import (the standard ASCET import menu instead of SCM menu operations like SVN Update).
Items Modified in Repository
Opens a list of items that are not in the most recent version state. The status modified in repository is set by the SCM interface after a previous version of the item has been loaded by means of the Update command or after Check for Modifications detects a more recent version (probably stored by another user) in the repository.
Items Referencing Missing Components:
Opens a list of items that reference components not present in the current database/workspace.
Single-clicking an item in the list returned by the Show submenu options moves the ASCET database/workspace item selection to the corresponding item. Double-clicking on an item opens the corresponding item editor.
Connect to Repository
Shown in offline mode only. Switches to online mode by connecting the Subversion driver to the repository URL. Note that you can disconnect from the Subversion repository by selecting DisconnectfromRepository from the Additional Commands submenu. See also Online versus Offline Mode.
Edit without Lock
Makes the selected items editable without locking them in the Subversion repository. Consequently, other users are not notified when they try to edit the same item. Therefore, this command requires caution.
This command is mainly intended for temporary tests which will not yield a new revision, or to support changes in ASCET in offline mode (i.e. while you do not have access to the selected Subversion repository server, e.g. during field tests). See also Editing Items in Offline Mode.
See also
SCM Menu (without Version Management)
Toolbar
Version Handling Based on Subversion
Repository