PVDE5

VDE
Guide to Using
VDE

2.8 Change Propagation and Fold Records

BWhen you replace a module, you make your new source file the most >recent generation of the module in the specified (or default) Gdevelopment stream. That instance of the module is thus the generation Gyou get by default in a subsequent FETCH or RESERVE command and is the )generation that is built for that stream.

;If the specified stream has successors, VSC propagates the @new module generation to all successor streams if possible. For Gexample, if stream V5.4 is a successor of stream V5.3, then any module Bthat is replaced into stream V5.3 is also replaced in stream V5.4 Hautomatically. If stream V5.4 has additional successors (such as stream HV5.5), the new module generation is propagated to those streams, and so on recursively.

FChange propagation works as follows. If the latest generations of the Hmodule for the original development stream and the successor stream are Bthe same, then the new module instance being replaced becomes the Blatest generation for both streams. Both streams are thus equally Hup-to-date with respect to the changes made to that module. However, if Gthe latest generations of the module differ for the two streams, which Fmeans that the module has already diverged between those two streams, Gthe source control system does not propagate the new module generation <to the successor stream. Instead, it creates a fold Hrecord in the database to remind the developer that the change 9made to the module for the first stream must be manually -"folded" into the successor stream.

HYou display fold records with the SHOW FOLD command. This example shows the brief output of the command:

"
VSC> SHOW FOLD *.MARHFold 1 of [FACIL]FOO.MAR;29(27B2) into stream V5.4 23-MAR-1989 SMITHHFold 2 of [FACIL]BAR.MAR;2(1A1) into stream V5.5 24-MAR-1989 JONESVSC>

FEach fold record is identified by a fold identifier. :This identifier is a unique, small integer value that VSC &assigns when creating the fold record.

EThe following example shows the full output of the SHOW FOLD command for one fold record:

"
VSC> SHOW FOLD/FULL FOO.MAR!Fold 1 of [FACIL]FOO.MAR;29(27B2)8 Module to be folded from stream V5.3 into stream V5.43 Reservation performed by user SMITH (Jane Smith)3 Reservation performed on 23-MAR-1989 18:09:51.803 Replacement performed on 25-MAR-1989 20:29:05.23 Remark: Fix QAR 23 again VSC>

HThe normal way to remove fold records is to specify the /FOLD qualifier Gwith the REPLACE command that replaces the folded source file. This is an example:

"
1VSC> REPLACE/STREAM=V5.4 [FACIL]FOO.MAR/FOLD=2

EThis example replaces module FOO.MAR into stream V5.4 to propagate a 7change that VSC could not automatically propagate. The Gparameter to the /FOLD qualifier (the value "2") is the fold Gidentifier of a fold record to delete as part of the replacement. This Eparameter can be omitted if the module only has one outstanding fold =record. For queued replacements, VSC deletes the fold record :when the release project leader performs your replacement.

EYou can also delete a fold record that is no longer needed (possibly Gbecause the change is no longer required) with an explicit CANCEL FOLD command:

"
@VSC> CANCEL FOLD [FACIL]FOO.MAR/IDENTIFICATION=2/STREAM=BIRCH

DThis command deletes fold record 2 (as given by the /IDENTIFICATION Gqualifier) for module FOO.MAR in facility FACIL. This fold record is a Greminder to fold a change into stream BIRCH. If there is only one fold 9record for the given module and stream, you can omit the /IDENTIFICATION qualifier.]

2.9 Displaying Queued Replacements

COnce the REPLACE command has entered a queued replacement into the Gsource control system's database, you can display the replacement with Ethe SHOW REPLACEMENT command. This example illustrates the command's syntax:

"
VSC> SHOW REPLACEMENT SMITH-1

?This command displays all queued replacements specified by the =replacement name parameter (SMITH--1 in the example). If the =replacement name is omitted, the command displays all queued replacements.

=With the SHOW REPLACEMENT command, you can specify a list of Hreplacement names separated by commas, and you can use the asterisk (*) Gand percent sign (%) wildcard characters. All queued replacements that *match the wildcard patterns are displayed.

FThe SHOW REPLACEMENT command accepts a number of qualifiers. The help Atext and the reference manual have the details on the qualifiers jaccepted by the command. Table 2-6 lists some of the more commonly-used qualifiers.

w
Table 2-6 Qualifiers to the SHOW REPLACEMENT command
/ACCEPTED
M Specifies that only those replacements that have been accepted by all $ their reviewers be displayed.
( /BEFORE=date-time
M Displays only those replacements queued before the specified date and time.
/BRIEF
/FULL
I Determine the type of information displayed for each replacement. N /BRIEF displays the replacement name, the date of the replacement, the N replacing user, and the replacement status. This display normally fits I on one line. /FULL displays all information about the replacement H stored in the database; this display requires multiple lines per replacement.
! /IN_REVIEW
O Specifies that only those replacements that are in review be displayed. O A replacement is in review if it has not been rejected by any reviewer, H has been accepted by at least one reviewer, and has not yet been ! accepted by all reviewers.
$ /NOT_REVIEWED
N Specifies that only those replacements that have not yet been accepted 1 or rejected by any reviewers be displayed.
' /OUTPUT=filespec
J Directs the printed output of this command to a specified file. TheJ filespec parameter specifies the name of the file. C VSC creates a new file with that name, directs the command's N print output to that file, and prints nothing on your terminal. If this ? qualifier is omitted, all output appears on the terminal.
/REJECTED
L Specifies that only those replacements that have been rejected by at ' least one reviewer be displayed.
+ /REVIEWER[=username]
N Specifies that only those replacements for which the specified user is # a reviewer be displayed. TheE username parameter specifies the OpenVMS user E name of the reviewer whose replacements are to be shown. If theM username parameter is omitted, those replacements for F which you are a reviewer are shown. If the qualifier is omitted 9 entirely, replacements for all reviewers are shown.
' /SINCE=date-time
N Displays only those replacements queued on or after the specified date and time.
, /STREAM[=stream-name]
D Displays replacements for the development stream given by theL stream-name parameter. If this parameter is omitted, M the command displays replacements for your default development stream. I If the /STREAM qualifier is omitted entirely, the command displays / replacements for all development streams.
/TOTAL
G Shows the total number of replacements that match the specified O replacement names and other selection criteria. Only the total count is O shown; other information about the individual replacements is not shown.
+ /USERNAME[=username]
F Specifies the OpenVMS user name of the user whose replacements I are to be shown. If this qualifier is specified, only that user's % replacements are shown. If theD username parameter is omitted, only your own N replacements are shown. If the /USERNAME qualifier is omitted entirely, + replacements for all users are shown.

**Table 2-6 Qualifiers to the SHOW REPLACEMENT command**
/ACCEPTED
	M Specifies that only those replacements that have been accepted by all $ their reviewers be displayed.
( /BEFORE=date-time
	M Displays only those replacements queued before the specified date and time.
/BRIEF /FULL
	I Determine the type of information displayed for each replacement. N /BRIEF displays the replacement name, the date of the replacement, the N replacing user, and the replacement status. This display normally fits I on one line. /FULL displays all information about the replacement H stored in the database; this display requires multiple lines per replacement.
! /IN_REVIEW
	O Specifies that only those replacements that are in review be displayed. O A replacement is in review if it has not been rejected by any reviewer, H has been accepted by at least one reviewer, and has not yet been ! accepted by all reviewers.
$ /NOT_REVIEWED
	N Specifies that only those replacements that have not yet been accepted 1 or rejected by any reviewers be displayed.
' /OUTPUT=filespec
	J Directs the printed output of this command to a specified file. TheJ filespec parameter specifies the name of the file. C VSC creates a new file with that name, directs the command's N print output to that file, and prints nothing on your terminal. If this ? qualifier is omitted, all output appears on the terminal.
/REJECTED
	L Specifies that only those replacements that have been rejected by at ' least one reviewer be displayed.
+ /REVIEWER[=username]
	N Specifies that only those replacements for which the specified user is # a reviewer be displayed. TheE username parameter specifies the OpenVMS user E name of the reviewer whose replacements are to be shown. If theM username parameter is omitted, those replacements for F which you are a reviewer are shown. If the qualifier is omitted 9 entirely, replacements for all reviewers are shown.
' /SINCE=date-time
	N Displays only those replacements queued on or after the specified date and time.
, /STREAM[=stream-name]
	D Displays replacements for the development stream given by theL stream-name parameter. If this parameter is omitted, M the command displays replacements for your default development stream. I If the /STREAM qualifier is omitted entirely, the command displays / replacements for all development streams.
/TOTAL
	G Shows the total number of replacements that match the specified O replacement names and other selection criteria. Only the total count is O shown; other information about the individual replacements is not shown.
+ /USERNAME[=username]
	F Specifies the OpenVMS user name of the user whose replacements I are to be shown. If this qualifier is specified, only that user's % replacements are shown. If theD username parameter is omitted, only your own N replacements are shown. If the /USERNAME qualifier is omitted entirely, + replacements for all users are shown.

:Examples

GThis is an example of the brief output of the SHOW REPLACEMENT command:

"
VSC> SHOW REPLACEMENT SMITH-5FQueued replacement SMITH-5 23-MAR-1989 SMITH RejectedJQueued replacement JONES-3 24-MAR-1989 JONES Not reviewedVSC>

DThe following example shows the full output of the SHOW REPLACEMENT Dcommand for one queued replacement. Note that this output lists all Amodules that belong to the replacement and all reviewers for the replacement.

"
%VSC> SHOW REPLACEMENT/FULL SMITH-5Queued replacement SMITH-50 Replacement queued by user SMITH (Jane Smith)0 Replacement queued on 4-OCT-1990 16:55:02.06S Replacement staging directory is VSC$STAGEDISK:[VMS.STAGE.VDE$STG_1.VDE$REP_115]& Replacement review status: Rejected$ Replacement is for stream PHOENIX# Unique replacement number is 115 Reservations in replacement:8 Reservation 1 of [FACIL]FOO.MAR for stream PHOENIX9 Reservation 1 of [RMS]FUMBLE.B32 for stream PHOENIX& Replacement contains 2 reservations Reviewers for replacement:H Accepted by user HOFFMAN (Bill Hoffman) on 4-OCT-1990 17:08:03.08C Rejected by user JONES (Jim Jones) on 4-OCT-1990 17:08:03.08, Remark: Bad choice of variable name- Not reviewed by SNURD (Mortimer Snurd) Remark: Fix bad-status bug VSC>

a

2.10 Cancelling Queued Replacements

EIf you decide that a replacement you queued should not be performed, ;you can cancel that replacement with the following command:

"
"VSC> CANCEL REPLACEMENT SMITH-1

=This command removes the queued replacement specified by the Greplacement name parameter (SMITH--1) from the source control system's ?database. The original module reservations associated with the Ecancelled replacement remain in the database. The typical reason for Ccancelling a replacement is that you or a reviewer found something Ewrong with the code to be replaced. After fixing the erroneous code, =you can queue a new replacement with another REPLACE command.

?With the CANCEL REPLACEMENT command, you can specify a list of Hreplacement names separated by commas, and you can use the asterisk (*) Cand percent sign (%) wildcard characters in the names. The command @deletes all queued replacements that match the wildcard pattern.

HThe CANCEL REPLACEMENT command accepts a number of qualifiers. The help Dtext and the reference manual contain the details on the qualifiers paccepted by the command. Table 2-7 lists the more commonly-used qualifiers.

y
Table 2-7 Qualifiers to the CANCEL REPLACEMENT command
/CONFIRM
! /NOCONFIRM
L /CONFIRM asks you to confirm that you want each replacement deleted. O This qualifier is particularly useful if you use wildcard characters in I the replacement name. /NOCONFIRM deletes each replacement without : asking for confirmation. /NOCONFIRM is the default.
/LOG
/NOLOG
H Specify whether informational log messages are printed after the K replacement is deleted. /LOG causes such messages to be printed and 3 /NOLOG suppresses them. /LOG is the default.

**Table 2-7 Qualifiers to the CANCEL REPLACEMENT command**
/CONFIRM ! /NOCONFIRM
	L /CONFIRM asks you to confirm that you want each replacement deleted. O This qualifier is particularly useful if you use wildcard characters in I the replacement name. /NOCONFIRM deletes each replacement without : asking for confirmation. /NOCONFIRM is the default.
/LOG /NOLOG
	H Specify whether informational log messages are printed after the K replacement is deleted. /LOG causes such messages to be printed and 3 /NOLOG suppresses them. /LOG is the default.

Chapter 3
Displaying Information

@This chapter tells you how to display information stored in the ?OpenVMS source control database. Earlier sections have already mdescribed how you display module reservations ( Section 2.6), fold Ürecords ( Section 2.8), and queued replacements ( Section 2.9). This Hchapter describes how to display information about facilities, modules, Emodule generations, development streams, and the users of the source control system.S

3.1 Displaying Facilities

FThe SHOW FACILITY command lists information about the facilities into 3which the OpenVMS sources are divided. For example:

"
VSC> SHOW FACILITY FACNAM

@This example displays information about facility FACNAM. If the Efacility name is omitted, the command displays information about all Hfacilities in the current library. With this command, you can specify a @list of facility names separated by commas, and you can use the Fasterisk (*) and percent sign (%) wildcard characters in the facility Enames. All facilities that match the wildcard patterns are displayed.

qTable 3-1 lists the qualifiers for the SHOW FACILITY command and describes their functions.

t
Table 3-1 Qualifiers to the SHOW FACILITY command
/BRIEF
/NORMAL
/FULL
M Determine the type of information displayed for each facility. /BRIEF I displays the name of each facility that matches the facility-name H parameters. /NORMAL displays the name and remark string for each N facility; this is the default output. /FULL displays all attributes of M each facility, including its name, creation date and time, and remark string.
' /OUTPUT=filespec
J Directs the printed output of this command to a specified file. TheJ filespec parameter specifies the name of the file. C VSC creates a new file with that name, directs the command's N print output to that file, and prints nothing on your terminal. If this ? qualifier is omitted, all output appears on the terminal.
/TOTAL
E Shows the total number of facilities that match the specified F facility-name parameters. Only the total count is shown; other @ information about the individual facilities is not shown.

**Table 3-1 Qualifiers to the SHOW FACILITY command**
/BRIEF /NORMAL /FULL
	M Determine the type of information displayed for each facility. /BRIEF I displays the name of each facility that matches the facility-name H parameters. /NORMAL displays the name and remark string for each N facility; this is the default output. /FULL displays all attributes of M each facility, including its name, creation date and time, and remark string.
' /OUTPUT=filespec
	J Directs the printed output of this command to a specified file. TheJ filespec parameter specifies the name of the file. C VSC creates a new file with that name, directs the command's N print output to that file, and prints nothing on your terminal. If this ? qualifier is omitted, all output appears on the terminal.
/TOTAL
	E Shows the total number of facilities that match the specified F facility-name parameters. Only the total count is shown; other @ information about the individual facilities is not shown.

9Examples

EThis is an example of the normal output of the SHOW FACILITY command:

"
VSC> SHOW FACILITY B*)Facility BACKUP "BACKUP facility3Facility BAD "Michael Jackson facility".Facility BADBLK "Bad-block faciility"9Facility BASRTL "BASIC Run-Time Libary facility"/Facility BLAS1 "Blasphemous facility"0Facility BOOTS "OpenVMS boot facility"VSC>

EThe following is an example of the brief output of the SHOW FACILITY command:

"
VSC> SHOW FACILITY/BRIEF B*Facility BACKUPFacility BADFacility BADBLKFacility BASRTLFacility BLAS1Facility BOOTSVSC>

AThe following example shows the full output of the SHOW FACILITY command for one facility:

"
VSC> SHOW FACILITY/FULL SYSFacility SYS8 Facility added to database on 19-OCT-1990 10:38:05.448 Facility added to database by user SMITH (Jane Smith) Facility cannot be deleted$ Remark: OpenVMS Executive modules VSC>

6This example shows the effect of the /TOTAL qualifier:

"
VSC> SHOW FACILITY/TOTAL *)Number of facilities matching name *: 228VSC>

P

3.2 Displaying Modules

BThe SHOW MODULE command lists information about the modules under source control. For example:

"
"VSC> SHOW MODULE [FACIL]MOD.TYP

7In this example, VSC displays information about module HMOD.TYP in facility FACIL. If the facility name is omitted, the current Cdefault facility is assumed. If the whole module-name parameter is Homitted, information about all modules in the default facility is shown.

EWith the SHOW MODULE command, you can specify a list of module names Gseparated by commas, and you can use the asterisk (*) and percent sign H(%) wildcard characters in the module names. All modules that match the wildcard patterns are displayed.

oTable 3-2 lists the qualifiers for the SHOW MODULE command and describes their functions.

r
Table 3-2 Qualifiers to the SHOW MODULE command
/BRIEF
/NORMAL
/FULL
K Determine the type of information displayed for each module. /BRIEF E displays the name of each module that matches the module-name H parameters. /NORMAL displays the name and remark string for each L module; this is the default output. /FULL displays all attributes of L each module, including its name, creation date and time, CMS history J and notes attributes, reviewer and notify lists, and remark string.
' /OUTPUT=filespec
J Directs the printed output of this command to a specified file. TheJ filespec parameter specifies the name of the file. C VSC creates a new file with that name, directs the command's N print output to that file, and prints nothing on your terminal. If this ? qualifier is omitted, all output appears on the terminal.
; /STATISTICS=(keyword [, keyword...])
N Computes and displays certains statistics about the modules that match & the module-name parameters. TheM keyword parameters specify what statistics to display H and how to sort them. The qualifier accepts the following keyword parameters:
L
ALPHABETICALLY---Sort the display alphabetically by facility name > or type name. If this keyword is omitted, VSC sorts the 2 display in descending order by module count.G
FACILITY---Compute and display the number of modules in each facility.K
TYPES---Compute and display the number of modules that have each module type.
M
If you specify only one of these keywords, the surrounding * parentheses can be omitted.
K When this qualifier is used, other information about the individual H modules is not shown. Use wildcard characters in the module-name E parameters to select the module population for which you want statistics.
/TOTAL
N Shows the total number of modules that match the specified module-name N parameters. Only the total count is shown; other information about the ' individual modules is not shown.

**Table 3-2 Qualifiers to the SHOW MODULE command**
/BRIEF /NORMAL /FULL
	K Determine the type of information displayed for each module. /BRIEF E displays the name of each module that matches the module-name H parameters. /NORMAL displays the name and remark string for each L module; this is the default output. /FULL displays all attributes of L each module, including its name, creation date and time, CMS history J and notes attributes, reviewer and notify lists, and remark string.
' /OUTPUT=filespec
	J Directs the printed output of this command to a specified file. TheJ filespec parameter specifies the name of the file. C VSC creates a new file with that name, directs the command's N print output to that file, and prints nothing on your terminal. If this ? qualifier is omitted, all output appears on the terminal.
; /STATISTICS=(keyword [, keyword...])
	N Computes and displays certains statistics about the modules that match & the module-name parameters. TheM keyword parameters specify what statistics to display H and how to sort them. The qualifier accepts the following keyword parameters: L ALPHABETICALLY---Sort the display alphabetically by facility name > or type name. If this keyword is omitted, VSC sorts the 2 display in descending order by module count.G FACILITY---Compute and display the number of modules in each facility.K TYPES---Compute and display the number of modules that have each module type. M If you specify only one of these keywords, the surrounding * parentheses can be omitted.
	K When this qualifier is used, other information about the individual H modules is not shown. Use wildcard characters in the module-name E parameters to select the module population for which you want statistics.
/TOTAL
	N Shows the total number of modules that match the specified module-name N parameters. Only the total count is shown; other information about the ' individual modules is not shown.

9Examples

CThis is an example of the normal output of the SHOW MODULE command:

"
#VSC> SHOW MODULE [ADARTL]PPLSS_*5Module [ADARTL]PPLSS_DISPATCH.MAR "SS dispatcher"&Module [ADARTL]PPLSS_KERNEL_WORKER.B325 "Kernel worker"7Module [ADARTL]PPLSS_RESET.MAR "Cleanup routine"<Module [ADARTL]PPLSS_SERVICES.MAR "Service entry points"?Module [ADARTL]PPLSS_TABLE.B32 "Sys Service definitions"?Module [ADARTL]PPLSS_TABLE.REQ "Sys Service definitions"AModule [ADARTL]PPLSS_USER_WORKER.B32 "User mode worker routines"VSC>

CThe following is an example of the brief output of the SHOW MODULE command:

"
VSC> SHOW MODULE/BRIEFModule [FACIL]FOO.BARModule [FACIL]MOD1.FORModule [FACIL]MOD2.FORModule [FACIL]MOD3.FORModule [FACIL]MOD4.FORModule [FACIL]MOD5.FORModule [FACIL]MOD6.FORVSC>

GThe following example shows the full output of the SHOW MODULE command for one module:

"
(VSC> SHOW MODULE [FACIL]MOD1.FOR/FULLModule [FACIL]MOD1.FOR6 Module added to database on 4-APR-1989 14:58:39.666 Module added to database by user SMITH (Jane Smith) Module is a source module Module cannot be deleted& Module may be concurrently reserved1 History information is not provided by default History string: C #B/ Notes information is not provided by default Notes string: ! #G Note position: 81 Reviewers: JONES, SNURD Users to notify: MERMAN Remark: Test module VSC>

6This example shows the effect of the /TOTAL qualifier:

"
VSC> SHOW MODULE/TOTAL [RMS]*-Number of modules matching name [RMS]*.*: 236VSC>

PreviousW

NextZ

Contents\

Index

VDEGuide to Using VDE