RVDE7

VDE
VDE
Reference Manual



 q
Previous[ Contents] Index


N

MODIFY MODULE



7Modifies the attributes of modules in the VDE database.

,Requires CREMOD privilege. 




Format

0

MODIFY MODULE mod-name [, mod-name...]




Parameter



mod-name

:The name of an existing module in the current VDE library Gwhose attributes are to be modified. The module name must consist of a Gmodule name and a module type separated by a period (as in MODNAM.FOR) Eand may optionally be preceded by a facility name enclosed in square Gbrackets (as in [ACCTNG]MODNAM.FOR where ACCTNG is the facility name). EIf no facility name is specified, the module is assumed to belong to the current default facility.

HYou can modify more than one module by using wildcard characters in any Fof the three components of the module name. The percent sign (%) in a Fname 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.




Description

BThe MODIFY MODULE command allows you to modify various attributes >associated with a module. The MODIFY MODULE commands apply to 4attributes that span a number of module generations.

DFor information on changing the attributes specific to a particular gmodule generation, see MODIFY GENERATION. The MODIFY .GENERATION/MAIN_STREAM, /OBSOLETE, and /REMARKFqualifiers allow you to mark a module as the main line of descent, to Emark a module as obsolete, or to change the remark associated with a particular module generation.




Qualifiers



/BINARY



/NOBINARY

ASpecifies whether the source module is a binary file or not. The ?/BINARY qualifier specifies that the source module is a binary G(non-text) file. Binary source files cannot be reviewed or differenced Cwith the REVIEW REPLACEMENT command because they do not consist of Gordinary ASCII text. The /NOBINARY qualifier specifies that the source Amodule is an ordinary ASCII text file. These qualifiers are only meaningful for source modules.

ELarge files that undergo extensive changes at frequent intervals, or Care the output of a language or application, may not be suited for Astorage as standard delta files as the file delta is never used, Eoccupies a considerable amount of disk space, and grows rapidly. See Ethe /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

GSpecifies whether the module can be reserved concurrently by more than Eone user. The /CONCURRENT qualifier allows the module to be reserved Fconcurrently unless a user overrides this default with for a specific Creservation. 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 Battributes of each module modified. The /CONFIRM qualifier causes :VDE to print a message for each module giving the name of Dthe module and asking whether you want to modify the module. If you Ganswer YES (or Y), the module's attributes are modified. If you answer ENO (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)

ESets or clears the delete attribute for the module. FThis attribute allows the module to be deleted with the DELETE MODULE Ecommand. The /DELETE qualifier sets the delete attribute so that the Amodule can be deleted. The /NODELETE qualifier clears the delete Gattribute so that the module cannot be deleted without first resetting the attribute.

/HISTORY[="string"]



/NOHISTORY[="string"]

ASpecifies the CMS history string to be associated with the moduleHand whether history information should be included in source files when Amodules are retrieved with the FETCH or RESERVE command. History Hinformation gives a historical record of previous changes to the module.

DThe /HISTORY qualifier specifies that history information should be Gincluded in source files by default when such files are retrieved with Fthe FETCH or RESERVE command. The /NOHISTORY qualifier specifies that Chistory information should be omitted. The string Fparameter to either qualifier specifies the default history string if Dthe user specifies that history information should be included in a Gretrieved file. (If you specify the /NOHISTORY qualifier on the MODIFY DMODULE command, you must use the /HISTORY qualifier on the FETCH or BRESERVE command to use the default history string.) If you do not <specify a string parameter, VDE supplies a 7default history string that depends on the module type.

FSee the CMS documentation for a description of the CMS history string and its format.

/LOG (default)



/NOLOG

BControls whether log messages are printed after the attributes of Dmodules are modified. The /LOG qualifier causes such messages to be Cprinted and /NOLOG suppresses them. The messages indicate that the Amodules have been modified and that the database transaction has successfully committed.

/MARKER



/NOMARKER

CSpecifies whether the source module uses a marker file or not. The G/MARKER qualifier specifies that the source module uses a marker file. DWhen a source module uses a marker file, the module is stored as an Gordinary file in one of the delta-file directories. A small text file, Ccalled the marker file, contains the full file name of that source Efile, and this marker file is stored in the module's delta file (CMS Celement). In short, the delta file contains a small text file that Hpoints to the module's actual source file. The marker-file mechanism is Anormally only used for large or frequently changed binary source Fmodules, for which the delta-file mechanism may give poor performance or use excessive disk space.

HThe /NOMARKER qualifier specifies that the source module does not use a Hmarker file and that its text is stored directly in the delta file (CMS Delement) for the module. Ordinary ASCII text modules should not use marker files.

#Also see the /[NO]BINARY qualifier.

/NOTES[="string"]



/NONOTES[="string"]

DSpecifies the CMS notes string to be associated with the module and Fwhether CMS notes should be included in source files when modules are Hretrieved 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 Gincluded in source files by default when such files are retrieved with Dthe FETCH or RESERVE command. The /NONOTES qualifier specifies that Anotes information should be omitted. The string Hparameter to either qualifier specifies the default notes string if the Huser specifies that notes information should be included in a retrieved Bfile. (If you specify the /NONOTES qualifier on the MODIFY MODULE Ccommand, you must use the /NOTES qualifier on the FETCH or RESERVE Bcommand 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.

HSee the CMS documentation for a description of the CMS notes string and its format.*

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

/

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

AThe /NOTIFY qualifier specifies a list of users to notify of all <changes to the specified module. VDE appends these users to Hthe module's existing notification list. Each username ?parameter gives the OpenVMS username or mail address of a user Fwho should be notified by mail message each time the specified module !is replaced into the VDE library.

GEach username parameter can specify the username of a 5user already recorded in the VDE database, a OpenVMS Gmail address with one or more node names (such as NODE::SMITH), a mail Hforwarding alias, or a defined logical name bound to a list of users to Enotify. If you specify a logical name, keep in mind that the logical @name must be defined when it is later used to send notification Hmessages. 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.

FThe /NONOTIFY qualifier specifies that a list of users already on the Hmodule's notification list be removed from that notification list. Each ?username parameter gives the OpenVMS username Gor 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.

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

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

/POSITION=column-number

HSpecifies the default column number in which CMS notes are to be placed Fwhen this source module is retrieved with a FETCH or RESERVE command. DThe column number must be an integer in the range 1 to 511. If this Fqualifier is omitted, the default column number is 81. This qualifier Hhas no effect unless notes are enabled with the /NOTES qualifier on the CCREATE or MODIFY MODULE command or on the FETCH or RESERVE command.

GSee the CMS documentation for a description of CMS notes and how notes *are formatted at the ends of source lines.

/PROPAGATE



/NOPROPAGATE

CSpecifies whether automatic change propagation is allowed for this Emodule when it is reserved and replaced into the library. /PROPAGATE Fallows automatic change propagation and /NOPROPAGATE disallows change 6propagation. If change propagation is disallowed, VDE Fautomatically inhibits change propagation when the module is reserved Hor replaced as if the /NOPROPAGATE qualifier had been specified for the RESERVE or REPLACE command.

/REMARK="string"

CSpecifies a remark string to be stored for the module. This string Freplaces the remark string from the original CREATE MODULE command or Cfrom any previous MODIFY MODULE command. The quoted remark string, Dwhich can be up to 132 characters long, may contain any explanatory 8remark about the module that you want stored in the VDE Edatabase. Typically the remark describes the function or contents of the module.

DThis qualifier alters the module-level remark string. To change the Gremark on a particular module generation, see the documentation on the hMODIFY GENERATION/REMARK command in MODIFY GENERATION.,

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

1

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

FThe /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 Aparameter gives the OpenVMS username of a user who should review Dall changes to the module. The user must already be recorded in the 3VDE database. When the module is replaced into the 1VDE library, VDE notifies the user of the change Cby 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 Gmodule generation that was created, and the user may then inspect that generation.

FThe /NOREVIEWER qualifier specifies that a list of existing reviewers Afor the specified module be removed from the reviewer list. Each ?username parameter gives the OpenVMS username Hof 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.

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

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




Examples

 6    
#1

 
0VDEä MODIFY MODULE MODNAM.C/REMARK="New Comment"M%VDE-I-MODMOD, information for module [CODE]NEWNAM.C modified in the database>%VDE-I-COMMIT, database transaction has successfully committedVDEä      


FThis example changes the remark present on the module MODNAM.C. Since Ano facility is specified, the module is assumed to belong to the Gdefault facility, facility CODE in this case. The log messages confirm Fthat the attributes of the module were modified and that the database #transaction successfully completed.

 6    
#2

 
+VDEä MODIFY MODULE/NOLOG [TAPE]DEVDRV.MAR -9_VDEä                    /REMARK="Old tape device driver")VDEä MODIFY GENERATION [TAPE]DEVDRV.MAR -'_VDEä                  /NOLOG /OBSOLETEVDEä      


?In this example, the user changes the remark string for module ADEVDRV.MAR in facility TAPE, and then uses the MODIFY GENERATION @command to mark the module as obsolete. The /NOLOG qualifier is Dspecified on both commands; the qualifier suppresses the display of messages from either.


T

MODIFY REPLACEMENT



BModifies the attributes of one or more queued replacements in the VDEGdatabase. The attributes of a replacement you can modify are its name, !remark string, and reviewer list.

BRequires RESREP privilege to modify your own replacement. 4Requires PERFREP privilege to modify another user's replacement.




Format

5

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




Parameter



rep-name

FThe name of a queued replacement whose attributes are to be modified. EYou can modify more than one replacement at a time by using wildcard >characters in the replacement name. The percent sign (%) in a Areplacement name matches any single character in the position it Eoccupies and the asterisk (*) matches zero or more characters in the ;position it occupies. VDE modifies the attributes of those 4replacements whose names match the wildcard pattern.

FDo not specify the rep-name parameter if you use the /IDENTIFICATION qualifier.




Qualifiers



/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 Byou want that replacement modified. If you answer YES (or Y), the Ereplacement 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 Deach replacement whose name matches the wildcard specification. The 8/NOCONFIRM qualifier causes VDE to modify the specified -replacements without asking for confirmation.!

/IDENTIFICATION=id-range

FSpecifies that the replacements with the unique Replacement Ids given Gby the id-range parameter be modified. Do not specify Dthe rep-name parameter when you use this qualifier.

9VDE assigns a unique Replacement Id to each immediate or -queued replacement into the VDE library. VDE Aassigns Replacement Ids in chronological order so that the first Freplacement into the library has Id value 1, the next has Id value 2, Fand so on. When you use this qualifier, all replacements that have Id Evalues in the range given by the id-range parameter are modified.

GThe id-range parameter can be a single integer value, Da range of integers, or a wildcard character. If the parameter is a 9single integer (for example, /IDENT=5), VDE modifies the Ereplacement 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 Brange. Finally, if the id-range parameter is the ;asterisk wildcard character (as in /IDENT=*), VDE modifies all replacements.

0If you specify a zero or negative number in the Did-range parameter, that number is relative to the =largest Replacement Id value for the VDE library (the latest Hreplacement). For example, if the latest replacement has Replacement Id A250, then /IDENT=0 is equivalent to /IDENT=250 and /IDENT=--1 is equivalent to /IDENT=249.!

/INFORMATION[=file-spec]

GSpecifies that a new information file should be attached to the queued Hreplacement 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 Especified, this file is copied to the replacement's staging area and Fthen 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 Hyour preferred editor to edit the replacement's information file. If an Ginformation file already exists, the editor edits that file; otherwise Hit 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 Edeclare 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

EControls whether log messages are printed after the replacements are Dmodified. The /LOG qualifier causes such messages to be printed and D/NOLOG suppresses them. The messages indicate that the replacements Fhave been modified and that the database transaction has successfully committed.

/NAME=rep-name

DSpecifies a new name for the queued replacement. The new replacement<name can be up to 39 characters long and must follow normal 5VDE name syntax. After the replacement name has been Bchanged, you must refer to the replacement by its new name in all 7subsequent VDE commands. The old name is lost from the database.

/REMARK="string"

HSpecifies a new remark string for the replacement. This string replaces Bthe remark string from the original REPLACE or CREATE REPLACEMENT Dcommand or from any previous MODIFY REPLACEMENT command. The quoted Gremark string, which can be up to 132 characters long, may contain any Eexplanatory remark about the replacement that you want stored in the VDE database.,

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

1

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

>The /REVIEWER qualifier specifies a list of reviewers for the 0replacement. VDE appends these reviewers to the Ereplacement's existing reviewer list. Each username Aparameter gives the OpenVMS username of a user who should review Hall 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.

FThe /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 Hof 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.

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

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




Examples

 6    
#1

 
:VDEä MODIFY REPLACEMENT SMITH-2/REMARK="New remark string"K%VDE-I-REPMOD, information for replacement SMITH-2 modified in the database>%VDE-I-COMMIT, database transaction has successfully committedVDEä      


CThis example modifies replacement SMITH--2 to give it a new remark Dstring. The log messages show that the replacement has successfully been modified.


S

MODIFY RESERVATION



:Modifies the attributes of module reservations in the VDE database.

+Requires RESREP privilege.




Format

4

MODIFY RESERVATION mod-name [,mod-name...]




Parameter



mod-name

GSpecifies a reserved source module whose reservation attributes are to Cbe modified. The module name consists of an optional facility name Fenclosed in square brackets, a module name, and an optional type name Hpreceded by a period (such as [FACIL]MOD1.MAR). If the facility name is Eomitted, the module is assumed to belong to the default facility. If Cthe type name is omitted, the reservation attributes of all source Fmodules with the given module name in the given facility are modified.

HYou can modify the reservation attributes of more than one module using Ewildcard characters in any component of the module name. The percent Csign (%) in a name matches any single character in the position it Eoccupies and the asterisk (*) matches zero or more characters in the Gposition it occupies. The reservation attributes of the source modules 4whose names match the wildcard pattern are modified.

GIf you use the /SESSION qualifier, those reservations that are members Eof the specified reservation session are modified. In this case, you Dmust omit the mod-name parameters from the command.




Description

<When you reserve a module from the VDE library, the RESERVE 9command records the reservation in the VDE database. The HMODIFY RESERVATION command lets you modify various attributes of one or Dmore such reservations. The command modifies only reservations that Fcover the default development stream or the stream specified with the /STREAM qualifier.

HIf you have more than one reservation of a module, you must specify the Fexact reservation to be modified using the /IDENTIFICATION qualifier. DUse the SHOW RESERVATION command to determine the identification of each reservation.

ETo modify another user's reservation, use the /USERNAME qualifier to ?specify the OpenVMS username of that other user. You must have 6the USERNAME privilege to use the /USERNAME qualifier.




Qualifiers



/CONCURRENT

DSpecifies that the module can be reserved by another user while you Dhave 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 Dprint a message for each module that you specify asking whether you >want to modify its reservation. If you answer YES (or Y), the Freservation 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

FThe /FOLD qualifier specifies a fold record to be cancelled when this @module reservation is eventually replaced into the library. The Efold-ident parameter gives the fold identifier of a Ffold 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 9this fold record from the VDE database. You can omit the Gfold-ident parameter if there is only one fold record Hfor the specified module and stream. You can use the /FOLD qualifier if Eyou are modifying the module to satisfy an existing fold record. You Acan also specify the /FOLD qualifier with the REPLACE command to achieve the same effect.

FThe /NOFOLD qualifier specifies that no fold record be cancelled when Ethis module reservation is replaced into the library. This qualifier =cancels the effect of a /FOLD qualifier on a previous MODIFY 7RESERVATION command or on the original RESERVE command."

/IDENTIFICATION=res-ident

ESpecifies the reservation to be modified. This qualifier is required Fwhen you have multiple reservations of the same module in the default Ddevelopment 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 Areserved the module, usually a small integer value. Use the SHOW CRESERVATIONS command to display the reservation identifier of each reservation.

/LOG (default)



/NOLOG

DControls whether log messages are printed after each reservation is Gmodified. The /LOG qualifier causes the messages to be printed and the B/NOLOG qualifier suppresses them. The messages indicate that each Dreservation 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 Hnew reservation session by that name and adds the reservation to it. If Fthe reservation already belongs to an existing session, it is removed /from that session and added to the new session.

/NOCONCURRENT

GSpecifies that the module cannot be reserved by another user while you Bhave it reserved. You must replace or unreserve the module before 2others can reserve it. This qualifier changes the 4concurrent-reservation attribute of the reservation.

/PROPAGATE=stream-name



/NOPROPAGATE

HThis qualifier controls the default module propogation behaviour of the <subsequent REPLACE command, and it controls the reservation 3"shadow" for this particular reservation.

7When 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 Asuccessors of that stream---change propagation thus stops at the specified stream.

5The /NOPROPAGATE qualifier causes VDE to disable all Fpropagate of the change beyond the current stream (the default stream 4or the stream specified with the /STREAM qualifier).

DIf you omit both qualifiers, the REPLACE command will propagate the 8changed modules to all successors of the current stream.

EBecause these qualifiers determine what streams a subsequent REPLACE <command will affect, they also determine what streams---the F"shadow"---the new module reservations cover. A reservation Hthat covers fewer streams allows other users to reserve the same module 2in other streams with less likelihood of conflict.

/REMARK="string"

?Specifies a new remark string to be associated with the module Areservation. This qualifier changes the remark attribute and the Eprevious reservation remark is lost from the database. The remark is enclosed in quotation marks.

/SESSION=session-name

BSessions are used to logically group a set of module reservations Htogether, typically to group all modules related to a particular source Acode alteration or enhancement together. It allows all component Amodules reserved to be treated as a single entity for subsequent Greplacement operations. A session also allows additional modules to be Creserved and incorporated into an existing session at a later time.




 q
PreviousX Next[ Contents] Index