VDE
VDE
Reference Manual


Previous Contents Index

The /NONOTES qualifier specifies that CMS notes are not to be appended to the lines of the file placed in your directory.

If the /NOTES and /NONOTES qualifiers are both omitted, the RESERVE command generates CMS notes only if the notes attribute is enabled for the module. This attribute is set with the CREATE MODULE or MODIFY MODULE command.

If the history-notes attribute for the VDE library is disabled, the RESERVE command will not generate CMS notes information into the output file and will not accept the /NOTES qualifier. See the description of the /HISTORY_NOTES qualifier to CREATE LIBRARY for more information.

/NOOUTPUT

Specifies that the reserve operation is to be performed along with any history processing and error checking but that no output file is to be created.

/OUTPUT=file-specification

Directs VDE to write the reserved module to the specified file. If you omit the directory from the file specification, VDE writes the file to your default directory. If you omit the file name or file type, VDE uses the module name and type by default. If you omit the /OUTPUT and /NOOUTPUT qualifiers entirely, VDE creates a file in your current default directory with the same name as the module.

If you reserve more than one module with the same /OUTPUT qualifier and you specify the file name and type on that qualifier, VDE creates successive versions of the file indicated by the /OUTPUT qualifier.

/OVERRIDE=CONCURRENT

Specifies that VDE should create a concurrent reservation if a module being reserved is already reserved for the same stream. If this qualifier is omitted and a module you are trying to reserve is already reserved, VDE displays an error message and does not reserve the module for you. To create a second, concurrent reservation, you must use this qualifier. Even when you use this qualifier, VDE does not allow you to create a concurrent reservation if a previous reservation for the module does not allow concurrent reservations.

/POSITION=column-number

Specifies the column in which CMS notes are to be placed. The column number must be an integer in the range 1 to 511. If the length of an output line is less than the specified column number, the note appears at the specified column number. If the length of the line is greater than or equal to the column number, the note is placed at the next tab stop after the end of the line. (Tab stops are at position 9 and every 8 characters thereafter.)

If the /POSITION qualifier is omitted, the default notes position for the module is used. The default notes position is set with the CREATE MODULE or MODIFY MODULE command. The /POSITION qualifier has no effect unless the /NOTES qualifier is specified or the notes attribute is set for the module.

If the history-notes attribute for the VDE library is disabled, the RESERVE command will not generate CMS notes information into the output file and will not accept the /POSITION qualifier. See the description of the /HISTORY_NOTES qualifier to CREATE LIBRARY for more information.

/PROPAGATE=stream-name

/NOPROPAGATE

This qualifier controls the default module propogation behaviour of the subsequent and associated 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) only as far as 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.

For information on propogation, see REPLACE.

/QUEUE

Specifies that VDE should queue a reservation request for you if you cannot reserve a module because it is already reserved by another user. If the requested module can be reserved now, the module is reserved and this qualifier has no effect. However, if the module is not available, VDE queues a reservation request for it in its database. When the user who owns the current reservation later replaces or unreserves it, VDE sends you a mail message saying that the module is now available. To actually reserve the module, you must then enter another RESERVE command. If multiple users have queued reservation requests for the same module, all of them are notified when the module becomes available. They must then decide among themselves who should reserve the module first.

To display queued reservation requests, use the SHOW RESERVATION command.

/REMARK="string"

Specifies a character string to be stored in the database for this reservation, usually explaining why the reservation is made. The remark is enclosed in quotation marks. If no remark is entered, a null remark is stored.

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

If no session with the specified session-name session name currently exists, VDE will create a new reservation session under the specified session name and will incorporate the module reservation(s) into it.

If the session-name parameter is omitted, VDE generates a unique session name, creates a new session by that name, and adds the module reservation to it.

If the /SESSION qualifier is omitted on the RESERVE command, VDE will reserve the module (as expected), and will not add the new module reservation to any session.

Sessions can be manipulated via the REPLACE, RESERVE, UNRESERVE, MODIFY SESSION, MODIFY RESERVATION, CREATE MODULE, and CANCEL SESSION commands. And modules created by CREATE MODULE (on a queued-replacement stream) and reserved via RESERVE can be combined into the same session.

/STREAM=stream-name

Specifies that modules be reserved in the development stream given by the stream-name parameter. The RESERVE command fetches the latest generation of each specified module in that stream and records that each reservation belongs to that stream. If this qualifier is omitted, modules are reserved in the default development stream. If this qualifier is omitted and no default stream is defined, VDE prompts you for the stream name.

/USERNAME=username

Reserves modules in another user's name. The username parameter specifies the OpenVMS username of the other user. You must have the USERNAME privilege to use this qualifier.

Examples

#1

VDE„ RESERVE FOO/REMARK="Fix problem reported in QAR 23"
%VDE-I-FETCHED, generation [FACIL]FOO.MAR;7(5A2) fetched from library
%VDE-I-OUTFILE, output file is DEV$:[MYDIR]FOO.MAR;
%VDE-I-RESERVED, module generation [FACIL]FOO.MAR;7(5A2) reserved from stream MAIN
%VDE-I-COMMIT, database transaction has successfully committed
VDE„
      

This command reserves all source modules named FOO in the default facility, FACIL. In this case, there is only one such module, FOO.MAR. This module is copied to the user's default directory and is marked as reserved in the VDE database.

#2

VDE„ RESERVE MOD1 /IDENTIFICATION=BUGFIX
Please supply required information for module [FACIL]MOD1.*;0:
Enter the reservation remark: FIX ACCESS VIOLATION
%VDE-I-FETCHED, generation [FACIL]MOD1.PAS;9(9) fetched from library
%VDE-I-OUTFILE, output file is DEV$:[MYDIR]MOD1.PAS;
%VDE-I-RESERVED, module generation [FACIL]MOD1.PAS;9(9) reserved from stream V6.0
%VDE-I-COMMIT, database transaction has successfully committed
VDE„ SHOW RESERVATION
Reservation BUGFIX of [FACIL]MOD1.PAS       SMITH        29-DEC-1989 V6.0
VDE„
      

The RESERVE command reserves module MOD1.PAS in facility FACIL and assigns the reservation identifier BUGFIX to the reservation. (If you do not use the /IDENTIFICATION qualifier, the RESERVE command assigns a numeric reservation identifier to the reservation.) The SHOW RESERVATION command indicates that the module is reserved with the BUGFIX identifier. This identifier can later be used on a REPLACE or UNRESERVE command to identify this particular reservation.

#3

VDE„ RESERVE/SESSION=SPEEDUP A.REQ,B.REQ "Remark string"
%VDE-I-FETCHED, generation [FACIL]A.REQ;11(11) fetched from library
%VDE-I-OUTFILE, output file is DEV$:[MYDIR]A.REQ;
%VDE-I-FETCHED, generation [FACIL]B.REQ;7(7) fetched from library
%VDE-I-OUTFILE, output file is DEV$:[MYDIR]B.REQ;
%VDE-I-RESERVED, module generation [FACIL]A.REQ;11(11) reserved from stream MAIN
%VDE-I-RESERVED, module generation [FACIL]B.REQ;7(7) reserved from stream MAIN
%VDE-I-COMMIT, database transaction has successfully committed
VDE„
      

This example shows how module reservations are made members of a reservation session. This command reserves modules A.REQ and B.REQ in facility FACIL and makes the resulting reservations members of a reservation session called SPEEDUP. These modules can later be replaced (or unreserved) as a unit by specifying the session name instead of the names of the individual modules.


REVIEW BUILD_JOB

Reviews the build-step log files for a specified build job.

Format

REVIEW BUILD_JOB [stream-name]


Parameter

stream-name

The name of a development stream. VDE reviews the results of the most recent build job for the specified stream. If you omit the stream-name parameter, VDE reviews the results of the most recent build job for the default stream.

Description

The REVIEW BUILD_JOB command allows you to review the log files of the individual build steps of a specified build job. The command enters you into a subsystem of VDE. Once in the subsystem, you are prompted with the string VDEREVBLD> and you can then use a restricted set of commands, different from usual VDE commands, to display selected log files. After reviewing build results, use the EXIT command to exit from the subsystem and return to VDE.

The REVIEW BUILD_JOB command creates a build-step review list which is a list of build steps to be reviewed. By default, the list includes only those steps that completed with errors. Commands in the REVIEW BUILD_JOB subsystem list the steps in the review list and display the log files for those steps. The subsystem thus gives you a convenient way to determine which build steps failed and why they failed. The subsystem can also review build steps that completed successfully. Use the /STEP qualifier to include successful steps in the build-step review list.

When you are in the REVIEW BUILD_JOB subsystem, you enter commands at the VDEREVBLD> prompt. The commands can display either the build-step review list or the log files for individual build steps on that list.

The REVIEW BUILD_JOB subsystem accepts the commands documented in Review Build Job Commands.


Qualifiers

/STEP [=(status [, status...])]

Reviews either all build steps or, if you specify the status parameter, those steps whose status is specified. Each status parameter must be one of the following keywords: NOTSTARTED, RUNNING, SUCCESS, or ERRORS.

If you specify only one status parameter, the parentheses may be omitted. If you do not specify a parameter, all build steps of specified build job are reviewed.

If you omit the /STEP qualifier, only those build steps that completed with errors are reviewed.


Examples

#1

VDE„ REVIEW BUILD_JOB
Reviewing steps of build job 38 for stream MAIN
Number of build steps selected: 1
 
VDEREVBLD> DIRECTORY
Steps being reviewed in build job 38 for stream MAIN:
   Compile step for module [BUILD_TEST]E.B32
 
VDEREVBLD> NEXT
Build job 38 for stream MAIN
Log file of compile step for module [BUILD_TEST]E.B32:
 
     1: --->> ERROR: MISSING SCRIPT IN VDE DATABASE <<---
     2: No script found in database to perform build step
[End of file]
 
VDEREVBLD> NEXT
%VDE-E-NOMORESTEP, no more build steps in review list
VDEREVBLD> EXIT
VDE„
      

In this example, one step completed with errors in build job 38 for stream MAIN. The REVIEW BUILD_JOB command displays messages that identify the build job and gives the number of steps selected for review. By default, the command includes only those steps from the build-step review list that completed with errors; in this case, there is one such step. At the VDEREVBLD> prompt, the user enters the DIRECTORY command to display the build steps on the current review list. Then the user enters the NEXT command to see the log file for the next build step. (Pressing the RETURN key has the same effect.) The log file shows that the compile step failed because no script for it was found in the VDE database. A second NEXT command shows that there are no more build steps on the review list. The EXIT command then exits from the REVIEW BUILD_JOB subsystem and returns the user to the VDE„ prompt.

#2

VDE„ REVIEW BUILD_JOB/STEP=SUCCESS
Reviewing steps of build job 39 for stream MAIN
Number of build steps selected: 5
 
VDEREVBLD> DIRECTORY
Steps being reviewed in build job 39 for stream MAIN:
   Compile step for module [BUILD_TEST]B.REQ
   Compile step for module [BUILD_TEST]C.B32
   Compile step for module [BUILD_TEST]D.B32
   Compile step for module [BUILD_TEST]E.B32
   Link step for module [BUILD_TEST]X.EXE
 
VDEREVBLD> SELECT X
Build job 39 for stream MAIN
Log file of link step for module [BUILD_TEST]X.EXE:
 
     1: $ DEFINE OBJLIB DISK$:[LIBROOT.MAIN.BUILD_TEST.OBJ]
     2: $ LINK/EXE=OBJLIB:X.EXE/MAP=OBJLIB:X.MAP  -
     3:         OBJLIB:OBJLIB.OLB/INCLUDE=C,OBJLIB:OBJLIB.OLB/LIBRARY
     4: $ DEASSIGN OBJLIB
     5: $ !
     6: $ SET NOVERIFY   ! Successful script completion
[End of file]
 
VDEREVBLD> EXIT
VDE„
      

In this example, the /STEP=SUCCESS qualifier causes the REVIEW BUILD_JOB command to include only those steps from the build-step review list that completed successfully. The subsystem DIRECTORY command then lists all such steps. The SELECT command displays the log file of the link step for module X.EXE. Finally, the EXIT command exits from the REVIEW BUILD_JOB subsystem and returns the user to the VDE„ prompt.


Review Build Job Commands

The Review Build Job commands are used to review the results of a build job. The commands are valid at the VDEREVBLD> prompt during the REVIEW BUILD_JOB command.

Format

DIRECTORY [mod-name [, mod-name...]]

SELECT [mod-name]

NEXT [STEP]

BACK

CURRENT

FIRST

LAST

SPAWN

ATTACH

EXIT


Description

The review commands allow you to review the log files of the individual build steps of a specified build job. The command enters you into a subsystem of VDE. Once in the subsystem, you are prompted with the string VDEREVBLD> and you can then use a restricted set of commands, different from usual VDE commands, to display selected log files. After reviewing build results, use the EXIT command to exit from the subsystem and return to VDE.

The REVIEW BUILD_JOB command creates a build-step review list which is a list of build steps to be reviewed. By default, the list includes only those steps that completed with errors. Commands in the REVIEW BUILD_JOB subsystem list the steps in the review list and display the log files for those steps. The subsystem thus gives you a convenient way to determine which build steps failed and why they failed. The subsystem can also review build steps that completed successfully. Use the /STEP qualifier to include successful steps in the build-step review list.

When you are in the REVIEW BUILD_JOB subsystem, you enter commands at the VDEREVBLD> prompt. The commands can display either the build-step review list or the log files for individual build steps on that list. The subsystem accepts the following commands:


REVIEW REPLACEMENT

Reviews the modules, comment files, information file, and log file associated with a specified queued replacement.

Format

REVIEW REPLACEMENT rep-name


Parameter

rep-name

The name of the queued replacement to review. This parameter is required; if you omit it, VDE prompts you for it.

Description

The REVIEW REPLACEMENT command allows you to review all files associated with a given queued replacement. These files include the modules being replaced, the information file that the replacing user may have provided, the comment files that other reviewers may have written, and possibly a log file for an attempt to perform the replacement. The log file is only present if an earlier attempt to perform the replacement failed; the log file then tells you wnat went wrong. For each module being replaced, you may examine the new version queued for replacement, the old version in the VDE library, and the differences between the two.

The REVIEW REPLACEMENT command enters you into a subsystem of VDE. Once in the subsystem, you are prompted with the string VDEREVREP> and you can then use a restricted set of commands, different from the usual VDE commands, to display the files associated with the replacement. After reviewing these files, you must use the EXIT command to exit from the subsystem and return to VDE.

The REVIEW REPLACEMENT command creates a list of files to be reviewed called the replacement review list. This list includes the replacement's information file (if any), the comment file for each reviewer that has provided one, the log file for the last attempt to perform replacement (if any), and the modules that are queued for replacement. Subsystem commands list, display, and navigate among the elements in the review list. One element is always designated as the current element. Initially, the first element on the list is the current element, but various command can change that designation. The SHOW and EDIT subcommands display the text of the current element.


Qualifiers

/COMMENT

Specifies that reviewer comment files be included in the replacement review list. If this qualifier is omitted, comment files are only included if all other qualifiers are omitted as well.

/INFORMATION

Specifies that the queuing user's information file be included in the replacement review list. If this qualifier is omitted, the information file is only included if all other qualifiers are omitted as well.

/MODULE

Specifies that all modules that are members of the queued replacement be included in the replacement review list. If this qualifier is omitted, modules are only included if all other qualifiers are omitted as well.

/STREAM=stream-name

This qualifier specifies the name of the stream associated with the replacement. It is currently ignored.

Examples

#1

VDE„ REVIEW REPLACEMENT SMITH-1
Reviewing replacement SMITH-1 queued by user SMITH (Jane Smith)
Number of modules and files selected: 4
 
VDEREVREP> DIRECTORY
Modules and files being reviewed for replacement SMITH-1:
   Information file by user SMITH (Jane Smith)
   Comment file by reviewer BROWN (Bill Brown) rejecting replacement
   Module [FACIL]A.REQ
   Module [FACIL]C.B32
 
VDEREVREP> CURRENT
 
Information file by user SMITH (Jane Smith)
 
VDEREVREP>
      

In this example, the REVIEW REPLACEMENT command displays some information identifying the requested queued replacement and enters the REVIEW REPLACEMENT subsystem. The DIRECTORY subcommand displays the elements on the review list and the CURRENT subcommand prints a line identifying the current element of the review list (namely the first element).

#2

VDEREVREP> SHOW
 
Text of the queuing user's information file displayed here.
This file may consist of many lines.
 
VDEREVREP> NEXT
 
Comment file by reviewer BROWN (Bill Brown) rejecting replacement
 
VDEREVREP> SHOW
 
Text of comment file written by reviewer BROWN displayed here.
This file may consist of many lines.
 
VDEREVREP>
      

This example continues the previous example. The SHOW command displays the text of the current review-list element, user SMITH's information file. The NEXT command makes the next element the current element and prints its name. The subsequent SHOW command then displays the text of that file, the comment file by reviewer BROWN.

#3

VDEREVREP> NEXT
 
Module [FACIL]A.REQ
 
VDEREVREP> SHOW
%VDE-I-FETCHED, generation [FACIL]A.REQ;7(7) fetched from library
%VDE-I-OUTFILE, output file is DEV:[VDELIB.VDE$STAGE.VDE$STG_0.VDE$REP_11.
FACIL]A.REQ_VDE$OLD;
 
Number of difference sections found: 0
Number of difference records found: 0
 
DIFFERENCES /IGNORE=()/MERGED=1/OUTPUT=DEV:[VDELIB.VDE$STAGE.VDE$STG_0.
VDE$REP_11.FACIL]A.REQ_VDE$DIFF;1-
    DEV:[VDELIB.VDE$STAGE.VDE$STG_0.VDE$REP_11.FACIL]A.REQ;1-
    DEV:[VDELIB.VDE$STAGE.VDE$STG_0.VDE$REP_11.FACIL]A.REQ_VDE$OLD;1
 
VDEREVREP> NEXT
 
Module [FACIL]C.B32
 
VDEREVREP> NEXT
%VDE-E-NOMOREMOD, no more modules in review list
VDEREVREP> EXIT
VDE„
      

Yet another NEXT command makes module [FACIL]A.REQ the current element of the review list. The SHOW command displays the differences file for that module. To do so, it first fetches out the old generation of the module, differences it with the new generation queued for replacement, and displays the differences file. The EDIT command could have been used just as well, and is more suitable for long differences files. Another NEXT command make module [FACIL]C.B32 the current element and displays its name. A final NEXT command shows that there are no more elements in the review list. The user then enters the EXIT command to return to the VDE„ prompt.


Previous Next Contents Index