| Previous | Contents | Index |
Modifies the attributes of modules in the VDE database.
MODIFY MODULE mod-name [, mod-name...]
mod-name
The name of an existing module in the current VDE library whose attributes are to be modified. The module name must consist of a module name and a module type separated by a period (as in MODNAM.FOR) and may optionally be preceded by a facility name enclosed in square brackets (as in [ACCTNG]MODNAM.FOR where ACCTNG is the facility name). If no facility name is specified, the module is assumed to belong to the current default facility.You can modify more than one module by using wildcard characters in any of the three components of the module 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. VDE modifies the attributes of those modules whose names match the wildcard pattern.
The MODIFY MODULE command allows you to modify various attributes associated with a module. The MODIFY MODULE commands apply to attributes that span a number of module generations.For information on changing the attributes specific to a particular module generation, see MODIFY GENERATION. The MODIFY GENERATION/MAIN_STREAM, /OBSOLETE, and /REMARK qualifiers allow you to mark a module as the main line of descent, to mark a module as obsolete, or to change the remark associated with a particular module generation.
/BINARY
/NOBINARY
Specifies whether the source module is a binary file or not. The /BINARY qualifier specifies that the source module is a binary (non-text) file. Binary source files cannot be reviewed or differenced with the REVIEW REPLACEMENT command because they do not consist of ordinary ASCII text. The /NOBINARY qualifier specifies that the source module is an ordinary ASCII text file. These qualifiers are only meaningful for source modules.Large files that undergo extensive changes at frequent intervals, or are the output of a language or application, may not be suited for storage as standard delta files as the file delta is never used, occupies a considerable amount of disk space, and grows rapidly. See the /MARKER qualifier. Executable images, object modules, Postscript files, and BACKUP savesets are all example of "source" modules for which the marker-file mechanism may be appropriate.
/CONCURRENT
/NOCONCURRENT
Specifies whether the module can be reserved concurrently by more than one user. The /CONCURRENT qualifier allows the module to be reserved concurrently unless a user overrides this default with for a specific reservation. The /NOCONCURRENT qualifier specifies that the module cannot be reserved concurrently./CONFIRM
/NOCONFIRM (default)
Controls whether VDE asks you to confirm that you want the attributes of each module modified. The /CONFIRM qualifier causes VDE to print a message for each module giving the name of the module and asking whether you want to modify the module. If you answer YES (or Y), the module's attributes are modified. If you answer NO (or N), the attributes are not modified. The /NOCONFIRM qualifier causes VDE to modify the attributes of each module without asking for confirmation./DELETE
/NODELETE (default)
Sets or clears the delete attribute for the module. This attribute allows the module to be deleted with the DELETE MODULE command. The /DELETE qualifier sets the delete attribute so that the module can be deleted. The /NODELETE qualifier clears the delete attribute so that the module cannot be deleted without first resetting the attribute./HISTORY[="string"]
/NOHISTORY[="string"]
Specifies the CMS history string to be associated with the module and whether history information should be included in source files when modules are retrieved with the FETCH or RESERVE command. History information gives a historical record of previous changes to the module.The /HISTORY qualifier specifies that history information should be included in source files by default when such files are retrieved with the FETCH or RESERVE command. The /NOHISTORY qualifier specifies that history information should be omitted. The string parameter to either qualifier specifies the default history string if the user specifies that history information should be included in a retrieved file. (If you specify the /NOHISTORY qualifier on the MODIFY MODULE command, you must use the /HISTORY qualifier on the FETCH or RESERVE command to use the default history string.) If you do not specify a string parameter, VDE supplies a default history string that depends on the module type.
See the CMS documentation for a description of the CMS history string and its format.
/LOG (default)
/NOLOG
Controls whether log messages are printed after the attributes of modules are modified. The /LOG qualifier causes such messages to be printed and /NOLOG suppresses them. The messages indicate that the modules have been modified and that the database transaction has successfully committed./MARKER
/NOMARKER
Specifies whether the source module uses a marker file or not. The /MARKER qualifier specifies that the source module uses a marker file. When a source module uses a marker file, the module is stored as an ordinary file in one of the delta-file directories. A small text file, called the marker file, contains the full file name of that source file, and this marker file is stored in the module's delta file (CMS element). In short, the delta file contains a small text file that points to the module's actual source file. The marker-file mechanism is normally only used for large or frequently changed binary source modules, for which the delta-file mechanism may give poor performance or use excessive disk space.The /NOMARKER qualifier specifies that the source module does not use a marker file and that its text is stored directly in the delta file (CMS element) for the module. Ordinary ASCII text modules should not use marker files.
Also see the /[NO]BINARY qualifier.
/NOTES[="string"]
/NONOTES[="string"]
Specifies the CMS notes string to be associated with the module and whether CMS notes should be included in source files when modules are retrieved with the FETCH or RESERVE command. CMS notes indicate in what module generation each source line was created.The /NOTES qualifier specifies that notes information should be included in source files by default when such files are retrieved with the FETCH or RESERVE command. The /NONOTES qualifier specifies that notes information should be omitted. The string parameter to either qualifier specifies the default notes string if the user specifies that notes information should be included in a retrieved file. (If you specify the /NONOTES qualifier on the MODIFY MODULE command, you must use the /NOTES qualifier on the FETCH or RESERVE command to use the default notes string.) If you do not specify a string parameter, VDE supplies a default notes string that depends on the module type.
See the CMS documentation for a description of the CMS notes string and its format.
/NOTIFY=(username [,username...])
/NONOTIFY[=(username [,username...])]
The /NOTIFY qualifier specifies a list of users to notify of all changes to the specified module. VDE appends these users to the module'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 module is replaced into the VDE 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 module'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 module.
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.
/POSITION=column-number
Specifies the default column number in which CMS notes are to be placed when this source module is retrieved with a FETCH or RESERVE command. The column number must be an integer in the range 1 to 511. If this qualifier is omitted, the default column number is 81. This qualifier has no effect unless notes are enabled with the /NOTES qualifier on the CREATE or MODIFY MODULE command or on the FETCH or RESERVE command.See the CMS documentation for a description of CMS notes and how notes are formatted at the ends of source lines.
/PROPAGATE
/NOPROPAGATE
Specifies whether automatic change propagation is allowed for this module when it is reserved and replaced into the library. /PROPAGATE allows automatic change propagation and /NOPROPAGATE disallows change propagation. If change propagation is disallowed, VDE automatically inhibits change propagation when the module is reserved or replaced as if the /NOPROPAGATE qualifier had been specified for the RESERVE or REPLACE command./REMARK="string"
Specifies a remark string to be stored for the module. This string replaces the remark string from the original CREATE MODULE command or from any previous MODIFY MODULE command. The quoted remark string, which can be up to 132 characters long, may contain any explanatory remark about the module that you want stored in the VDE database. Typically the remark describes the function or contents of the module.This qualifier alters the module-level remark string. To change the remark on a particular module generation, see the documentation on the MODIFY GENERATION/REMARK command in MODIFY GENERATION.
/REVIEWER=(username [,username...])
/NOREVIEWER[=(username [,username...])]
The /REVIEWER qualifier specifies a list of reviewers for all changes to the specified module. VDE appends these reviewers to the module's existing reviewer list. Each username parameter gives the OpenVMS username of a user who should review all changes to the module. The user must already be recorded in the VDE database. When the module is replaced into the VDE library, VDE notifies the user of the change 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 module 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 module.
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.
| #1 |
|---|
VDE„ MODIFY MODULE MODNAM.C/REMARK="New Comment"
%VDE-I-MODMOD, information for module [CODE]NEWNAM.C modified in the database
%VDE-I-COMMIT, database transaction has successfully committed
VDE„
|
This example changes the remark present on the module MODNAM.C. Since no facility is specified, the module is assumed to belong to the default facility, facility CODE in this case. The log messages confirm that the attributes of the module were modified and that the database transaction successfully completed.
| #2 |
|---|
VDE„ MODIFY MODULE/NOLOG [TAPE]DEVDRV.MAR -
_VDE„ /REMARK="Old tape device driver"
VDE„ MODIFY GENERATION [TAPE]DEVDRV.MAR -
_VDE„ /NOLOG /OBSOLETE
VDE„
|
In this example, the user changes the remark string for module DEVDRV.MAR in facility TAPE, and then uses the MODIFY GENERATION command to mark the module as obsolete. The /NOLOG qualifier is specified on both commands; the qualifier suppresses the display of messages from either.
Modifies the attributes of one or more queued replacements in the VDE database. The attributes of a replacement you can modify are its name, remark string, and reviewer list.Requires RESREP privilege to modify your own replacement. Requires PERFREP privilege to modify another user's replacement.
MODIFY REPLACEMENT rep-name [, rep-name...]
rep-name
The name of a queued replacement whose attributes are to be modified. You can modify more than one replacement at a time by using wildcard characters in the replacement name. The percent sign (%) in a replacement name matches any single character in the position it occupies and the asterisk (*) matches zero or more characters in the position it occupies. VDE modifies the attributes of those replacements whose names match the wildcard pattern.Do not specify the rep-name parameter if you use the /IDENTIFICATION qualifier.
/CONFIRM
/NOCONFIRM (default)
Controls whether VDE asks you to confirm that you want each queued replacement modified. The /CONFIRM qualifier causes VDE to print a message for each replacement asking whether you want that replacement modified. If you answer YES (or Y), the replacement is modified. If you answer NO (or N), the replacement is not modified. If you enter a replacement name with a wildcard specification, VDE asks you to confirm the modification of each replacement whose name matches the wildcard specification. The /NOCONFIRM qualifier causes VDE to modify the specified replacements without asking for confirmation./IDENTIFICATION=id-range
Specifies that the replacements with the unique Replacement Ids given by the id-range parameter be modified. Do not specify the rep-name parameter when you use this qualifier.VDE assigns a unique Replacement Id to each immediate or queued replacement into the VDE library. VDE assigns Replacement Ids in chronological order so that the first replacement into the library has Id value 1, the next has Id value 2, and so on. When you use this qualifier, all replacements that have Id values in the range given by the id-range parameter are modified.
The id-range parameter can be a single integer value, a range of integers, or a wildcard character. If the parameter is a single integer (for example, /IDENT=5), VDE modifies the replacement with that Replacement Id. If the parameter is a range of integers (specified as two integers separated by a colon as in /IDENT=3:5), VDE modifies the replacements with Ids in that range. Finally, if the id-range parameter is the asterisk wildcard character (as in /IDENT=*), VDE modifies all replacements.
If you specify a zero or negative number in the id-range parameter, that number is relative to the largest Replacement Id value for the VDE library (the latest replacement). For example, if the latest replacement has Replacement Id 250, then /IDENT=0 is equivalent to /IDENT=250 and /IDENT=--1 is equivalent to /IDENT=249.
/INFORMATION[=file-spec]
Specifies that a new information file should be attached to the queued replacement or that the existing information file should be edited. The file-spec parameter gives the OpenVMS file specification of a new information file for the replacement. If specified, this file is copied to the replacement's staging area and then supercedes any previous information file for the replacement. If this parameter is omitted, VDE asks you whether you want to edit the information file. If you answer YES, VDE invokes your preferred editor to edit the replacement's information file. If an information file already exists, the editor edits that file; otherwise it creates a new information file. The information file is used to pass information about the replacement to reviewers and others.To edit an information file through VDE, you should first declare your preferred editor with the SET EDITOR command. If you do not declare an editor, VDE invoked the system default text editor.
/LOG (default)
/NOLOG
Controls whether log messages are printed after the replacements are modified. The /LOG qualifier causes such messages to be printed and /NOLOG suppresses them. The messages indicate that the replacements have been modified and that the database transaction has successfully committed./NAME=rep-name
Specifies a new name for the queued replacement. The new replacement name can be up to 39 characters long and must follow normal VDE name syntax. After the replacement name has been changed, you must refer to the replacement by its new name in all subsequent VDE commands. The old name is lost from the database./REMARK="string"
Specifies a new remark string for the replacement. This string replaces the remark string from the original REPLACE or CREATE REPLACEMENT command or from any previous MODIFY REPLACEMENT command. The quoted remark string, which can be up to 132 characters long, may contain any explanatory remark about the replacement that you want stored in the VDE database./REVIEWER=(username [,username...])
/NOREVIEWER[=(username [,username...])]
The /REVIEWER qualifier specifies a list of reviewers for the replacement. VDE appends these reviewers to the replacement's existing reviewer list. Each username parameter gives the OpenVMS username of a user who should review all code included in the replacement. The user must already be recorded in the VDE database. VDE notifies the user by mail message that he or she should review the replacement.The /NOREVIEWER qualifier specifies that a list of existing reviewers for the replacement 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 replacement.
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.
| #1 |
|---|
VDE„ MODIFY REPLACEMENT SMITH-2/REMARK="New remark string"
%VDE-I-REPMOD, information for replacement SMITH-2 modified in the database
%VDE-I-COMMIT, database transaction has successfully committed
VDE„
|
This example modifies replacement SMITH--2 to give it a new remark string. The log messages show that the replacement has successfully been modified.
Modifies the attributes of module reservations in the VDE database.
MODIFY RESERVATION mod-name [,mod-name...]
mod-name
Specifies a reserved source module whose reservation attributes are to be modified. The module name consists of an optional facility name enclosed in square brackets, a module name, and an optional type name preceded by a period (such as [FACIL]MOD1.MAR). If the facility name is omitted, the module is assumed to belong to the default facility. If the type name is omitted, the reservation attributes of all source modules with the given module name in the given facility are modified.You can modify the reservation attributes of more than one module using wildcard characters in any component of the module 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. The reservation attributes of the source modules whose names match the wildcard pattern are modified.
If you use the /SESSION qualifier, those reservations that are members of the specified reservation session are modified. In this case, you must omit the mod-name parameters from the command.
When you reserve a module from the VDE library, the RESERVE command records the reservation in the VDE database. The MODIFY RESERVATION command lets you modify various attributes of one or more such reservations. The command modifies only reservations that cover the default development stream or the stream specified with the /STREAM qualifier.If you have more than one reservation of a module, you must specify the exact reservation to be modified using the /IDENTIFICATION qualifier. Use the SHOW RESERVATION command to determine the identification of each reservation.
To modify another user's reservation, use the /USERNAME qualifier to specify the OpenVMS username of that other user. You must have the USERNAME privilege to use the /USERNAME qualifier.
/CONCURRENT
Specifies that the module can be reserved by another user while you have it reserved. This qualifier changes the concurrent-reservation attribute of the reservation./CONFIRM
/NOCONFIRM (default)
Controls whether VDE asks you to confirm that you want each reservation modified. The /CONFIRM qualifier causes VDE to print a message for each module that you specify asking whether you want to modify its reservation. If you answer YES (or Y), the reservation is modified. If you answer NO (or N), it is not modified. The /NOCONFIRM qualifier causes VDE to modify each specified reservation without asking for confirmation./FOLD[=fold-ident]
/NOFOLD
The /FOLD qualifier specifies a fold record to be cancelled when this module reservation is eventually replaced into the library. The fold-ident parameter gives the fold identifier of a fold record for the module being reserved and for the stream in which the reservation is done. When you later replace the module and VDE performs the replacement, VDE will cancel this fold record from the VDE database. You can omit the fold-ident parameter if there is only one fold record for the specified module and stream. You can use the /FOLD qualifier if you are modifying the module to satisfy an existing fold record. You can also specify the /FOLD qualifier with the REPLACE command to achieve the same effect.The /NOFOLD qualifier specifies that no fold record be cancelled when this module reservation is replaced into the library. This qualifier cancels the effect of a /FOLD qualifier on a previous MODIFY RESERVATION command or on the original RESERVE command.
/IDENTIFICATION=res-ident
Specifies the reservation to be modified. This qualifier is required when you have multiple reservations of the same module in the default development stream. The res-ident parameter is the reservation identifier of the reservation to be modified. The reservation identifier is the identifier you specified when you reserved the module, usually a small integer value. Use the SHOW RESERVATIONS command to display the reservation identifier of each reservation./LOG (default)
/NOLOG
Controls whether log messages are printed after each reservation is modified. The /LOG qualifier causes the messages to be printed and the /NOLOG qualifier suppresses them. The messages indicate that each reservation has been modified and that the database transaction has successfully committed./NEW_SESSION=session-name
Specifies that VDE should add the module reservation to the reservation session given by the session-name parameter. If no session by that name exists, VDE creates a new reservation session by that name and adds the reservation to it. If the reservation already belongs to an existing session, it is removed from that session and added to the new session./NOCONCURRENT
Specifies that the module cannot be reserved by another user while you have it reserved. You must replace or unreserve the module before others can reserve it. This qualifier changes the concurrent-reservation attribute of the reservation./PROPAGATE=stream-name
/NOPROPAGATE
This qualifier controls the default module propogation behaviour of the subsequent REPLACE command, and it controls the reservation "shadow" for this particular reservation.When specified, the /PROPAGATE qualifier causes VDE to propagate the changed module(s) to the stream specified by the stream-name parameter, but not to any successors of that stream---change propagation thus stops at the specified stream.
The /NOPROPAGATE qualifier causes VDE to disable all propagate of the change beyond the current stream (the default stream or the stream specified with the /STREAM qualifier).
If you omit both qualifiers, the REPLACE command will propagate the changed modules to all successors of the current stream.
Because these qualifiers determine what streams a subsequent REPLACE command will affect, they also determine what streams---the "shadow"---the new module reservations cover. A reservation that covers fewer streams allows other users to reserve the same module in other streams with less likelihood of conflict.
/REMARK="string"
Specifies a new remark string to be associated with the module reservation. This qualifier changes the remark attribute and the previous reservation remark is lost from the database. The remark is enclosed in quotation marks./SESSION=session-name
Sessions are used to logically group a set of module reservations together, typically to group all modules related to a particular source code alteration or enhancement together. It allows all component modules reserved to be treated as a single entity for subsequent replacement operations. A session also allows additional modules to be reserved and incorporated into an existing session at a later time.
Previous Next Contents Index