VDE
VDE
Reference Manual


Previous Contents Index

You must have the CRESTRM privilege to use this qualifier.

/NOTIFY=(username [,username...])

/NONOTIFY[=(username [,username...])]

The /NOTIFY qualifier specifies a list of users to notify of all replacements into the specified stream, and of all facility creation operations. VDE appends these users to the stream's existing notification list. Each username parameter gives the OpenVMS username or mail address of a user who should be notified by mail message each time a module is replaced into the stream.

Each username parameter can specify the username of a user already recorded in the VDE database, a OpenVMS mail address with one or more node names (such as NODE::SMITH), a mail forwarding alias, or a defined logical name bound to a list of users to notify. If you specify a logical name, keep in mind that the logical name must be defined when it is later used to send notification messages. It should thus be a group or system logical name or a logical name that is in some other way defined for all users of the VDE library.

The /NONOTIFY qualifier specifies that a list of users already on the stream's notification list be removed from that notification list. Each username parameter gives the OpenVMS username or mail address of a user to remove from the notification list. If you omit the username parameters, VDE removes the entire notification list for the stream.

If you specify both qualifiers, VDE removes the users specified with the /NONOTIFY qualifier from the notification list before adding the users specified with the /NOTIFY qualifier.

If you specify only one username parameter with either qualifier, you may omit the surrounding parentheses.

/OPEN

/FROZEN

/CLOSED

Sets the status of the stream to open, frozen, or permanently closed. If you specify the /OPEN qualifier, all users can reserve and replace source modules from the stream and thereby modify the contents of the stream.

If you specify the /FROZEN qualifier, all users may reserve modules from the stream. However, a user must have the FROZEN privilege to replace modules into the stream; non-privileged users cannot change the contents of the stream. You can later change the status to open with another MODIFY STREAM command, so the stream is not permanently frozen.

If you specify the /CLOSED qualifier, modules cannot be reserved from or replaced into the stream. This status cannot be changed with a subsequent MODIFY STREAM command unless you have the UNCLOSE privilege. Use the /CLOSED qualifier when you never want the contents of the stream to change again, for example, when capturing a base-level of your software system or when capturing the final state of a released version of your software.

You must have the UNCLOSE privilege to use the /OPEN or /FROZEN qualifier for a closed stream.

/OWNER=username

/NOOWNER

The /OWNER qualifier specifies the owner of the specified stream. The username parameter gives the OpenVMS username of a user who should be recorded as the "owner" of the stream. VDE assigns no special meaning to the owner of a stream, but the SHOW STREAM command displays the owner. The owner could thus be the person to contact with questions about the stream.

The /NOOWNER qualifier specifies that the stream has no owner. Both qualifiers remove the previous owner's ownership of the stream.

/POPULATE

/NOPOPULATE

Specifies whether the stream is allowed to be populated with generations from another stream using the POPULATE STREAM command. /POPULATE allows subsequent use of the POPULATE STREAM command to populate the stream and /NOPOPULATE disallows such use. You must have the CRESTRM privilege to use these qualifiers.

/PROCESS_COUNT=proc-count

Specifies the default number of processes to execute build jobs for the stream. This parameter determines the degree of parallelism for the stream's build jobs. See the description of the BUILD command for a detailed description of this qualifier.

/QUEUE=(queue-name [,queue-name...])

Specifies the default batch queues to which build jobs for the stream are submitted. See the description of the BUILD command for a detailed description of this qualifier and for a description of its interaction with the /PROCESS_COUNT qualifier.

/REMARK="string"

Specifies a remark string for the stream. The quoted remark string, which can be up to 132 characters long, may contain any explanatory remark about the stream that you want stored in the VDE database. Typically the remark describes what version or base-level of your system the stream represents. This string replaces the remark string from the original CREATE STREAM command or from any previous MODIFY STREAM command.

/REPLACEMENT=keyword

Sets or clears the queued-replacement attribute for the stream. This attribute controls whether the REPLACE command permits immediate replacements into the stream or requires queued replacements. If the keyword parameter is IMMEDIATE, the REPLACE command will immediately replace modules into the stream by default. If the parameter is QUEUE, the REPLACE command will always queue replacements for the stream so that modules are not replaced into the stream until a privileged user enters a PERFORM REPLACEMENT command.

/REVIEWER=(username [,username...])

/NOREVIEWER[=(username [,username...])]

The /REVIEWER qualifier specifies a list of reviewers for all module replacements into the specified stream. VDE appends these reviewers to the stream's existing reviewer list. Each username parameter gives the OpenVMS username of a user who should review all replacements into the stream. The user must already be recorded in the VDE database. When a module is replaced into the stream, VDE notifies the user of the replacement by mail message. If the replacement is queued, the user should then review the queued replacement before it is performed. If the replacement is immediate, VDE notifies the user of the new module generation that was created, and the user may then inspect that generation.

The /NOREVIEWER qualifier specifies that a list of existing reviewers for the specified stream be removed from the reviewer list. Each username parameter gives the OpenVMS username of a user who should be removed from the reviewer list. If you omit the username parameters, VDE removes the entire reviewer list for the stream.

If you specify both qualifiers, VDE removes the users specified with the /NOREVIEWER qualifier from the reviewer list before adding the users specified with the /REVIEWER qualifier.

If you specify only one username parameter with either qualifier, you may omit the surrounding parentheses.

/STEP_DELAY=time-interval

Specifies the default step-delay time interval used by build jobs for the stream. See the description of the BUILD command for a detailed description of this qualifier.

/SUCCESSOR=(succ-name [, succ-name...])

Specifies new successors to the stream being modified. A successor to a stream is another stream to which source changes are propagated by the REPLACE command. Each succ-name parameter specifies the name of a stream that becomes a successor to the stream given by the stream-name parameter. The specified successors are added to the list of successors already stored in the database. You must have the CRESTRM privilege to use this qualifier.

/TIMEOUT=time-interval

Specifies the default timeout interval used by build jobs for the stream. See the description of the BUILD command for a detailed description of this qualifier.

Examples

#1

VDE„ MODIFY STREAM V3.3-FT1 /REMARK="New remark string"
%VDE-I-STRMMOD, information for stream V3.3-FT1 modified in the database
%VDE-I-COMMIT, database transaction has successfully committed
      

In this example, the user specifies a new remark string for stream V3.3-FT1. This remark string can be retrieved with a subsequent SHOW STREAM command.

#2

VDE„ MODIFY STREAM/NAME=V5.3 HICKORY
%VDE-I-STRMMOD, information for stream V5.3 modified in the database
%VDE-I-COMMIT, database transaction has successfully committed
      

In this example, the name of stream HICKORY is changed to V5.3. You must refer to the stream by this new name in all subsequent VDE commands.

#3

VDE„ MODIFY STREAM/CONFIRM BLVL-7/REMARK="New remark string", -
_VDE„                       BLVL-9/REMARK="New remark string"
Modify stream BLVL-7 ? [No]: Y
%VDE-I-STRMMOD, stream BLVL-7 modified in the database
Modify stream BLVL-9 ? [No]: N
%VDE-I-COMMIT, database transaction has successfully committed
VDE„
      

This example illustrates the /CONFIRM qualifier. This qualifier causes VDE to ask the user whether each specified stream should be modified. For stream BLVL-7, the user answers Y (for YES) and the remark string for that stream is modified in the database, as the log message shows. For stream BLVL-9, the user answers N (for NO) and that stream is not modified. Hence there is no log message for that stream. The final log message indicates that the database transaction for the whole command has successfully committed.


MODIFY USER

Modifies one or more attributes of the database record of one or more users.

Requires CREUSR privilege.


Format

MODIFY USER username [, username...]


Parameter

username

The OpenVMS username of the user whose record is to be modified in the current VDE library. You can modify more than one user record by using wildcard characters in the username. The percent sign (%) in a username matches any single character in the position it occupies and the asterisk (*) matches zero or more characters in the position it occupies. The attributes of those user records whose usernames match the wildcard pattern are modified.

Qualifiers

/AUTH_PRIVILEGES=(priv [,priv...])

Specifies a new set of authorized privileges that the user is allowed to set with the SET PRIVILEGE command. The privilege list you create replaces the user's current privilege list. Therefore, you must specify all authorized privileges you want the user to have.

Each parameter to this qualifier names a single privilege. If only one privilege is specified, the parentheses may be omitted.

For a list of privileges, see Table 3-5 in SET PRIVILEGES.

/CONFIRM

/NOCONFIRM (default)

Controls whether VDE asks you to confirm that you want each user record modified. The /CONFIRM qualifier causes VDE to print a message for each user giving the username and asking whether you want to modify the user record. If you answer YES (or Y), the user record is modified. If you answer NO (or N), the user record is not modified. The /NOCONFIRM qualifier causes VDE to modify the user record without asking for confirmation.

/DEF_PRIVILEGES=(priv [,priv...])

Specifies the default privileges which are enabled each time the user starts a new VDE session. Each default privilege specified also becomes an authorized privilege for the user. The privilege list you create replaces the user's current privilege list. Therefore, you must specify all default privileges you want the user to have.

Each parameter to this qualifier names a single privilege. If only one privilege is specified, the parentheses may be omitted. For a list of the privilege names you can specify, see the SET PRIVILEGES command.

/LOG (default)

/NOLOG

Controls whether log messages are printed after the user records are modified. The /LOG qualifier causes such messages to be printed and /NOLOG suppresses them. The messages indicate that the user records have been modified and that the database transaction has successfully committed.

/NAME="string"

Specifies a full name for the user. The quoted name string, which can be up to 40 characters long, should contain a new full name string (first name, middle initial, and last name) for the user.

/NOTIFY=(username [,username...])

/NONOTIFY[=(username [,username...])]

The /NOTIFY qualifier specifies a list of users to notify each time the specified user replaces a module into the VDE library. VDE appends these users to the specified user's existing notification list. Each username parameter gives the OpenVMS username or mail address of a user who should be notified by mail message each time the specified user replaces a module into the library.

Each username parameter can specify the username of a user already recorded in the VDE database, a OpenVMS mail address with one or more node names (such as NODE::SMITH), a mail forwarding alias, or a defined logical name bound to a list of users to notify. If you specify a logical name, keep in mind that the logical name must be defined when it is later used to send notification messages. It should thus be a group or system logical name or a logical name that is in some other way defined for all users of the VDE library.

The /NONOTIFY qualifier specifies that a list of users already on the specified user's notification list be removed from that notification list. Each username parameter gives the OpenVMS username or mail address of a user to remove from the notification list. If you omit the username parameters, VDE removes the entire notification list.

If you specify both qualifiers, VDE removes the users specified with the /NONOTIFY qualifier from the notification list before adding the users specified with the /NOTIFY qualifier.

If you specify only one username parameter with either qualifier, you may omit the surrounding parentheses.

/REMARK="string"

Specifies a remark string to be stored for the user. The quoted remark string, which can be up to 132 characters long, may contain any explanatory remark about the user that you want stored in the VDE database. This string replaces the remark string from the original CREATE USER command or from any previous MODIFY USER command. Typically the remark describes the user's affiliation or function within the organization.

/REVIEWER=(username [,username...])

/NOREVIEWER[=(username [,username...])]

The /REVIEWER qualifier specifies a list of reviewers for all changes replaced into the VDE library by the specified user. VDE appends these reviewers to the user's existing reviewer list. Each username parameter gives the OpenVMS username of a user who should review all changes created by the specified user. The new reviewer must already be recorded in the VDE database. When the specified user replaces a module into the VDE library, VDE notifies the reviewer of the change by mail message. If the replacement is queued, the reviewer should then review the queued replacement before it is performed. If the replacement is immediate, VDE notifies the reviewer of the new module generation that was created, and he or she may then inspect that generation. This qualifier can be used to set up "buddy systems" where two users always review each other's code.

The /NOREVIEWER qualifier specifies that a list of existing reviewers for the specified user be removed from the reviewer list. Each username parameter gives the OpenVMS username of a user who should be removed from the reviewer list. If you omit the username parameters, VDE removes the entire reviewer list for the user.

If you specify both qualifiers, VDE removes the users specified with the /NOREVIEWER qualifier from the reviewer list before adding the users specified with the /REVIEWER qualifier.

If you specify only one username parameter with either qualifier, you may omit the surrounding parentheses.

/USERNAME=username

Specifies a new OpenVMS username for the user. The new username can be up to 12 characters long and must follow normal VDE name syntax. If you change a username in the VDE database you should also remember to have your system manager change it in the system User Authorization File. After the username is changed, you must refer to the user by the new name in all subsequent VDE commands and the user must access the database with the new username.

Examples

#1

VDE„ MODIFY USER SMITH /USERNAME=BROWN /NAME="Jane S. Brown"
%VDE-I-USERMOD, information for user BROWN modified in the database
%VDE-I-COMMIT, database transaction has successfully committed
      

In this example, Jane Smith has changed her name. The MODIFY USER command is used to enter her new OpenVMS username and full name string into the VDE database. Thereafter, Jane must access the VDE library as user BROWN and she must be referred to as BROWN on subsequent VDE commands. The log messages confirm that her user record was modified and that the database transaction successfully completed.

#2

VDE„ MODIFY USER DOE /REMARK="OpenVMS Documentation Supervisor" -
_VDE„       /DEF_PRIVILEGES=BUILD /NOLOG
VDE„
      

Here John Doe has been promoted to Documentation Supervisor. The MODIFY USER command changes his remark string to indicate his new role and reduces his default privileges to only the BUILD privilege. In this example, the /NOLOG qualifier suppresses the log messages.


PERFORM REPLACEMENT

Performs one or more queued replacements so that the corresponding modules are replaced into the VDE library.

Requires PERFREP privilege.


Format

PERFORM REPLACEMENT rep-name [, rep-name...]


Parameter

rep-name

The name of a queued replacement to be performed. You can perform more than one replacement at a time by using wildcard characters in the replacement name. The percent sign (%) in a name matches any single character in the position it occupies and the asterisk (*) matches zero or more characters in the position it occupies. Those queued replacements whose names match the wildcard pattern are performed.

Description

The PERFORM REPLACEMENT command replaces the modules that are members of a specified queued replacement into the VDE library. Once this command has completed, each member module has a new generation in the library and is no longer marked as reserved in the affected streams. In addition, the replacement is no longer queued in the VDE database.

The PERFORM REPLACEMENT command only performs those replacements that match the rep-name parameters and that belong to your default stream or to another stream specified with the /STREAM qualifier. To perform replacements belonging to more than one stream, you can use wildcard characters in the stream name you specify with the /STREAM qualifier.

The PERFORM REPLACEMENT command is normally used by a user who is authorized to determine when changed modules should be replaced into the VDE library. Other developers reserve source modules, make changes to them, and queue them for replacement with the REPLACE command. The REPLACE command queues modules for replacement (as opposed to replacing them immediately), if the user specifies the /QUEUE qualifier or if any affected development stream has the queued-replacement attribute. Once a replacement is queued, it can optionally be reviewed using the REVIEW REPLACEMENT command and its subcommands. When the authorized user decides that the modules that are members of the queued replacement are ready to be replaced into the VDE library, the user enters the PERFORM REPLACEMENT command to actually perform the replacement. When replacements are queued, it is the PERFORM REPLACEMENT command that actually creates new generations for the modules and that terminates the module reservations.

Whether you should use queued replacements or not is a policy decision that may be different for different VDE libraries or for different development stream within a given library. If you decide to always use immediate replacements, the REPLACE command will perform the actual replacement and you do not use the PERFORM REPLACEMENT command.


Qualifiers

/CONFIRM

/NOCONFIRM (default)

Controls whether VDE asks you to confirm that you want each replacement performed. The /CONFIRM qualifier causes VDE to print a message for each replacement asking whether you want that replacement performed. If you answer YES (or Y), that replacement is performed. If you answer NO (or N), the replacement is not performed. If you enter a replacement name with a wildcard specification, VDE asks you to confirm that VDE should perform each replacement whose name matches the wildcard specification. The /NOCONFIRM qualifier causes VDE to perform the specified replacements without asking for confirmation.

/LOG (default)

/NOLOG

Controls whether log messages are printed after each replacement has been performed. The /LOG qualifier causes such messages to be printed and the /NOLOG qualifier suppresses them. These messages indicate that the associated modules have been replaced, that the replacement has been performed, and that the database transaction has successfully committed.

/STREAM=stream-name

Specifies that only those replacements that belong to certain streams be performed. The stream-name parameter specifies a stream name and can contain wildcard characters. The percent sign (%) in a name matches any single character in the position it occupies and the asterisk (*) matches zero or more characters in the position it occupies. VDE performs a given replacement only if it belongs to a stream whose name matches the stream-name parameter. If you omit this qualifier, VDE performs only those replacements that belong to your default stream.

For each replacement that matches a rep-name parameter but does not belong to a stream matching the stream-name parameter, VDE prints an informational message saying that the replacement is not performed.


Examples

#1

VDE„ PERFORM REPLACEMENT SMITH-2
%VDE-I-REPLACED, generation [FACNAM]A.REQ;9(9) replaced into stream V2.0
%VDE-I-REPLACED, generation [FACNAM]B.REQ;6(6) replaced into stream V2.0
%VDE-I-REPPERF, replacement SMITH-2 performed
%VDE-I-COMMIT, database transaction has successfully committed
VDE„
      

This example performs the queued replacement SMITH--2. The PERFORM REPLACEMENT command replaces the two modules that are members of the replacement, A.REQ and B.REQ in facility FACNAM, into the VDE library. Thereafter, these two modules are no longer reserved. The command also deletes replacement SMITH--2 from the VDE database.


Previous Next Contents Index