| Previous [ | Contents ] | Index |
G The Review Replacement Commands are used to review replacements queued D to the current library. The commands are valid at the VDEREVREP> - prompt during the REVIEW REPLACEMENT command.
.DIRECTORY [mod-name [, mod-name...]]
SELECT [mod-name]
SHOW [keyword]
EDIT [keyword]
NEXT
BACK
CURRENT
FIRST
LAST
"ACCEPT ["remark-string"]
REJECT "remark-string"
SPAWN
ATTACH
EXIT
G The REVIEW REPLACEMENT subsystem accepts the following commands at the VDEREVREP> prompt:
3
- DIRECTORY [mod-name [, mod-name...]] A
Displays a list of all information files, comment files, K replacement log files, and modules on the replacement review list. For J each file, this command displays the type (information, comment, log, H module, or binary module) and the name of user who created the file J (for information and comment files) or the name of the module. If you J specify one or more mod-name parameters, the command J displays only those modules whose names match the parameters. You can A use wildcards in the mod-name parameter. An E information or comment file has the author's OpenVMS username as < its file name, so these files can also be selected with G mod-name parameters. The replacement log file (if + present) has the file name LOG.VDE$LOG. !- SELECT [mod-name] H
Selects the first review list element whose module or file name G matches the mod-name parameter and makes that the J current review list element. This command prints one line identifying J the selected module or file. You can select an information or comment < file by specifying the author's OpenVMS username in the I mod-name parameter. You can select the log file (if K present) by specifying LOG in the mod-name parameter. I
If you omit the mod-name parameter, the command G displays the next element on the review list that matches the most I recently specified module name from a previous SELECT command. Using 8 this feature, you can enter a SELECT command with a K mod-name parameter containing wildcards to select the J first module (or other file) that matches the parameter. You can then H enter SELECT commands without parameters to successively select all J other modules and files that match the original parameter, one module or file per SELECT command.- SHOW [keyword] C
Prints the text of the current review-list element on your H terminal. If the current element is an information or comment file, ? VDE reads that file and prints it on your terminal. If the ? current element is a module, VDE prints the new version of L the module (the version about to be replaced into the library), the old K version of the module (the generation that was fetched when the module ; was reserved), or the differences between the two. The J keyword parameter determines what is displayed for a H module; this parameter may be the keyword NEW, OLD, or DIFFERENCES. G This parameter is ignored for information, comment, and log files. @
If you specify the OLD keyword, VDE fetches out the old H module generation unless a previous reviewer has already fetched it @ into the replacement's staging area. VDE then displays that ( file. If you specify the DIFFERENCES 6 keyword, VDE fetches out the old module generation if 1 necessary. VDE then runs the OpenVMS DIFFERENCES D command to create a differences file unless a previous reviewer has : already created it. VDE then displays that file.
This = command will not display any files for binary source modules.- EDIT [keyword] L
Invokes your preferred editor in read-only mode to display the text E of the current review-list element. If the current element is an : information or comment file, VDE spawns the editor to ? display that file. If the current element is a module, VDE L spawns the editor to display the new version of the module (the version J about to be replaced into the library), the old version of the module K (the generation that was fetched when the module was reserved), or the H differences between the two. The keyword parameter I determines what is displayed for a module; this parameter may be the D keyword NEW, OLD, or DIFFERENCES. This parameter is ignored for D information, comment, and log files.
If you specify the OLD @ keyword, VDE fetches out the old module generation unless a L previous reviewer has already fetched it into the replacement's staging : area. VDE then displays that file. If you specify the 8 DIFFERENCES keyword, VDE fetches out the old module 7 generation if necessary. VDE then runs the OpenVMS G DIFFERENCES command to create a differences file unless a previous < reviewer has already created it. VDE then displays that H file.
This command will not display any files for binary source B modules.
Use the SET EDITOR command at the VDE„ prompt to D specify your preferred editor. If you do not declare an editor, * VDE invokes the system default editor.- NEXT J
Makes the next element on the review list the current element and K displays the name of that element.
Pressing the KP0 key (the 0 key J on the numeric keypad) is the same as entering the NEXT command. As a L result, you can step from element to element by repeatedly pressing the K KP0 key. Similarly, the COMMA (,) key on the numeric keypad enters the J NEXT and SHOW commands with a single keystroke and the MINUS (--) key < on the numeric keypad enters the NEXT and EDIT commands.- BACK J
Makes the previous element on the review list the current element * and displays the name of that element.- CURRENT K
Displays the name of the current element of the replacement review list.- FIRST K
Makes the first element on the review list the current element and & displays the name of that element.- LAST J
Makes the last element on the review list the current element and & displays the name of that element.(- ACCEPT ["remark-string"] 8
Records in the VDE database that you accept the I replacement currently being reviewed. You must be a reviewer for the I replacement to use this command. You can specify the optional remark H string to give a reason for accepting the replacement. This command 8 accepts the same qualifiers as the VDE-level ACCEPT REPLACEMENT command.&- REJECT "remark-string" 8
Records in the VDE database that you reject the I replacement currently being reviewed. You must be a reviewer for the H replacement to use this command. The remark string should specify a L reason for rejecting the replacement. If you omit the remark parameter, @ VDE prompts you for a remark. This command accepts the same A qualifiers as the VDE-level REJECT REPLACEMENT command. Like K REJECT REPLACEMENT, the REJECT command lets you specify a comment file E to more fully explain your reasons for rejecting the replacement.- SPAWN J
Spawns a subprocess and attaches the terminal to that subprocess. = See the description of the VDE SPAWN command for details.- ATTACH J
Attaches the terminal to a specified process. See the description * of the VDE ATTACH command for details.- EXIT K
Exits from the REVIEW REPLACEMENT subsystem and returns you to the VDE„ prompt.
< The following keywords are used in VDE build scripts stored in the VDE database.
EMIT
EXIT
FETCH
C Scripts are used to add various user-defined extensions to various 0 VDE functions and commands. VDE invokes various 5 scripts at various times during VDE processing---see ` Script Types for further information on this.= Scripts of various types are recorded in the VDE database. A = script is a sequence of keywords in the VDE = script language that VDE can execute to create a DCL command 5 file. VDE can then invoke that DCL command file in a 9 subprocess to perform the action of the script. VDE uses A scripts to perform many different kinds of actions. For example, = VDE uses "compile scripts" to compile modules in a @ build job. Similarly, it uses "new-stream scripts" to E populate the directories of a new stream with files when it performs F the CREATE STREAM command. There are many other kinds of scripts, all E distinguished by the keywords or circumstances that cause them to be invoked.
: The primary purpose of VDE scripts is to insert names and = directory specifications from the VDE database into text you F specify to generate DCL command files that perform various actions. A ; VDE script is thus a mixture of plain text and invocations H of functions that retrieve names (such as module names, type names, and E facility names) and directory strings (such as the names of facility & subdirectories) from the VDE database.
< Since you define scripts, you define how VDE should perform G the corresponding actions. For example, you decide how a Pascal module > is compiled because you define the Pascal compilation script. E Similarly, you can define a script that defines auxiliary actions of D the REPLACE command. Scripts thus let you make policy decisions for 9 your own project, while VDE provides the mechanisms that implement your policies.
F When a new development stream is created, all script definitions from C the parent stream are copied to the child stream. If modified, the D script definitions then evolve independently in the two development streams.
6 A VDE script is a sequence of text lines that contain . VDE script keywords. There are only three VDE ' script commands: EMIT, FETCH, and EXIT.
E In addition, a script may contain blank lines and comment lines. The / exclamation point (!) is the comment character. ; VDE ignores any text on a script line after an exclamation E point, provided the exclamation point is not within quotes. A script 5 keyword command may be continued from one line to the B next by ending the first line with the sequence space-minus ( --).
7 VDE accepts the following keyword commands in a script:
(
- EMIT string [, string...] G
Emits one line into the DCL command file. This keyword command G evaluates each string parameter, concatenates the L resulting character strings into a single line of text, and writes this ? line of text to the DCL command file being generated. Each K string parameter may be a quoted character string, an ' invocation of a script function, or E a directory symbol name.
If the EMIT command parameter contains F spaces or other characters, the string must be enclosed in a pair of F quoting characters. (eg: If the command is a typical DCL command and I contains blanks and various other characters, it must be quoted.) Valid E quoting character pairs include the double-quote pair: (") and > ("), and the double-caret pair: («) and (»). G Use of the end-quoting character within the string is permissible, but F requires that the character be doubled. (eg: a double-quote character ? within the string is specified by double double-quotes; by two G consecutive double-quotes: ("").)
If the parameter is an G invocation of a script function, you must specify the function name or ? the function name followed by a parenthesized list of function 4 parameters. VDE evaluates the function to produce a G character string that is concatenated to the current DCL command line. @ (Next section lists the available script functions.)
If the 7 parameter is a directory symbol name, VDE looks up the > OpenVMS directory specification associated with the directory = symbol from the VDE database and concatenates that string to ; the current DCL command line. OpenVMS directory symbols are I defined using the SET DIRECTORY command.
To exit from the generated ? DCL in the script, issue one of the following script commands:
", EMIT «$ GOTO VDE$ERROR». EMIT «$ GOTO VDE$SUCCESS» EMIT "$ EXIT"- EXIT I
Exits from the script during script execution. Subsequent script K commands are thus not executed to produce DCL commands. (Note that the J EXIT keyword does not create an EXIT command in the DCL command file; F it only stops script execution. See the documentation on the EMIT E script command for information on generating the proper DCL exit # sequence from within a script.) )- FETCH string [, string...] ?
Fetches a module generation from the VDE library. This K keyword evaluates each string parameter, concatenates D the resulting character strings into a single line of text, and > interprets the line as the qualifiers and parameters to a > VDE FETCH command. Each string parameter J may be a quoted character string, an invocation of a script function, L or a directory symbol name.
Your string parameters 8 should generate the full VDE FETCH command you want H performed except for the FETCH keyword. The string C parameters can generate all qualifiers and parameters that the ? VDE FETCH keyword accepts, and can use script functions to F include strings such as module names, stream names, and directory K specifications. The resulting command string is parsed and executed as L if it belonged to a normal FETCH keyword entered from the terminal. Use > the FETCH keyword when you want VDE to fetch a generation J directly, without using a DCL command file, and you want it performed E in the same database transaction as the operation performing the A script.
By default, VDE fetches the latest generation of L the specified module in the stream for which the script is invoked. You A can override this default by generating a /STREAM qualifier, I /GENERATION qualifier, or a generation number for the FETCH keyword. I The script FETCH keyword suppresses log messages by default, but you I can override this default by generating a /LOG qualifier. Otherwise, E all parameters, qualifiers, and defaults are the same as for the < regular VDE FETCH keyword described elsewhere.
If a H string parameter is a quoted character string, the F string must be enclosed in double quotes ("). A double-quote G character within the string is specified by two consecutive double A quotes (""). VDE concatenates the quoted string to J the current FETCH keyword line.
If the parameter is an invocation D of a script function, you must specify the function name or the K function name followed by a parenthesized list of function parameters. = VDE evaluates the function to produce a character string J that is concatenated to the current FETCH keyword line. (Next section E lists the available script functions.)
If the parameter is a directory symbol name, 1 VDE looks up the OpenVMS directory specification ; associated with the directory symbol from the VDE database @ and concatenates that string to the current FETCH keyword line. > OpenVMS directory symbols are defined using the SET DIRECTORY command.8 When executing a script, VDE executes successive script H keywords from the script until it encounters an EXIT keyword or the end : of the script. VDE executes FETCH keywords immediately as = they are encountered. VDE writes all lines generated by EMIT C keywords to the output DCL command file. At the end of the script, : VDE executes that command file in a subprocess to perform the action of the script.
C Many types of scripts are invoked when a certain operation must be A applied to a specific module, such as compiling or reserving the = module. For such operations, VDE must select the script that F is appropriate to the module. The type of the script is of course the B primary selection criterion, but even for a given type, different E scripts are needed for different modules. The script that compiles a G Fortran module is not appropriate for a C module, for example, and the z script that links one image cannot link another. (Script Functions 0 contains the types of scripts supported by VDE.)
9 To accommodate such situations, VDE lets you specify how F scripts are selected based on the module name. You can specify that a G script should be used only for a specific module, for all modules of a B certain type in a given facility, for all modules of a given type A regardless of facility, or for all modules regardless of type or E facility. When you create such a script, you specify the script type E with a qualifier, such as /COMPILE or /RESERVE. You also specify the G modules to which the script applies through a module-name parameter to H the qualifier. A restricted form of wildcarding determines what modules E the script can be used for. The following module-name specifications are allowed:
J
H No other forms of wildcarding are allowed in the module-name parameters to script-type qualifiers.- [FACIL]MOD.TYP
If you fully specify the module name, the script C applies only to that specific module. For example, the qualifier H /LINK=[CODE]X.EXE says that the script can only be used to link image E X.EXE in facility CODE. If you omit the facility name, the current default facility is assumed.J- [FACIL]*.TYP
If you specify the facility name and type name but J specify an asterisk (*) in place of the module name, the script applies A to all modules of that type in that facility. For example, the D qualifier /COMPILE=[FACIL]*.C says that the script can be used to J compile all C modules in facility FACIL. If you omit the facility name, * the current default facility is assumed.H- [*]*.TYP
If you specify the type name but specify an asterisk I (*) in place of both the facility name and the module name, the script J applies to all modules of that type in all facilities. For example, the J qualifier /COMPILE=[*]*.FOR says that the script can be used to compile ( all Fortran modules in all facilities.F- [*]*.*
If you specify an asterisk (*) for each of the three C components of the module name, the script applies to all modules > regardless of type and facility. For example, the qualifier J /RESERVE=[*]*.* says that the script can be used to reserve all modules in all facilities.9 When VDE looks for a script to perform some action for a C module, it always selects the script that is most specific to that C module. If it can find a script with a fully specified module name B ([FACIL]MOD.TYP) for the module in question, it uses that script. = Otherwise, it looks for a script with a matching module-name F specification of the form [FACIL]*.TYP or [*]*.TYP or [*]*.*, in that E order. This rule allows you to specify generic scripts that apply to G all modules or to all modules of a certain type, but to override those H scripts for specific modules or for modules in specific facilities when appropriate.
@ Similar rules apply to scripts that are selected by facility. A E NEW_STREAM script, for example, is invoked for each facility in your 7 system when you create a new stream. In this case, VDE D accepts two forms of facility-name specification on the script-type qualifiers:
C
? No other forms of wildcarding are allowed in the facility-name % parameters to script-type qualifiers.- FACIL
If you fully specify the facility name, the script E applies only to that specific facility. For example, the qualifier I /NEW_STREAM=RMS says that the script can only be used for facility RMS when VDE creates new streams. F- *
If you specify an asterisk (*) for the facility name, the ? script applies to all facilities. For example, the qualifier J /NEW_STREAM=* says that the script can be invoked for every facility in + your system when VDE creates new streams.7 When VDE looks for a script to perform an action for a F facility, it first looks for a script with a fully specified facility < name. If no such script exists in the database, VDE selects G the script with the wildcard in the facility name, provided it exists. F You can thus specify a generic script that applies to all facilities, G and then override that script for specific facilities when appropriate.
X Generating Command Files in Segments
= Normally, VDE generates the DCL command file to perform some 5 action from a single VDE script. In some situations, G however, it is necessary to generate different "segments" of G the DCL command file from different scripts. The DCL command file that C compiles a MACRO module, for example, may need to consist of three segments:
I
- The first segment sets up logical names for the MACRO assembler and D includes the MACRO command and its qualifiers. The MACRO command is H ended with the continuation character. This segment is the same for all < MACRO modules, and the VDE script that generates it has the selection template [*]*.MAR.I
- The second segment contains the name of the module to assemble and J a plus-list of macro libraries to use with that module. This segment of ? the command file is different for each MACRO module, and the ? VDE script that generates it has a selection template of the form [FAC]MOD.TYP.D
- The third segment inserts the assembled object module into an F object library and runs VDE/DEPEND to collect dependency data. This I segment of the DCL command file is the same for all MACRO modules, and > the VDE script that generates it has the selection template [*]*.MAR.
< One VDE script could generate all three segments of the DCL B command file, but then a separate script is needed for each MACRO G module in the library. This solution is undesirable because the script G keywords that generate the first and third segments of the DCL command C file are the same for all MACRO modules, thus wasting space in the : VDE database and making it difficult to modify the common G parts of the scripts. A better solution is to have two generic scripts D with selection templates [*]*.MAR that generate the first and third F segments of each MACRO module's DCL command file, and to have a small D script specific to each module to generate the second segment. This H solution makes it easy to modify the module-independent segments of the 9 keyword files because they are derived from just two VDE scripts.
G To allow you to generate different segments of a DCL command file from 9 separate scripts, VDE allows you to assign a segment H number to each script. A segment number is an integer value in the H range from 1 to 20 that is specified with the /SEGMENT qualifier to the = CREATE SCRIPT command. When VDE generates a DCL command file C from scripts, it looks for an appropriate script for each possible 8 segment number. VDE selects the script for each segment < number using the normal script selection rules so that more C module-specific or facility-specific scripts are favored over more = generic scripts. After selecting the scripts, VDE interprets E them in order by segment number to generate the DCL command file. If A there are no scripts for a given segment, that segment is simply F omitted from the command file. As a result, you can have up to twenty H segments in a DCL command file, each generated by a separately selected script.
9 If you do not specify a segment number for a script, VDE F assigns segment number 10 to the script. If your DCL command files do H not need multiple segments, you can thus ignore segment numbers and let 9 VDE generate segment 10 (and only that segment) for each D command file. If you later decide that you need additional segments H before or after the original segment, you have ample segment numbers to choose from in both directions.
* The INVOKE SCRIPT command is a useful tool F for debugging scripts. INVOKE SCRIPT allows you to fetch and invoke a F specified script, and then to examine the DCL command(s) generated by the script.
n For further information on this command, see INVOKE SCRIPT.
| #1 |
|---|
$ TYPE [MYDIR]SCRIPT_C.VDESCRIPT ! Script to compile a C module. ! EMIT "$ SET VERIFY" & EMIT "$ DEFINE/NOLOG SRC$ ", $DIR(SRC)& EMIT "$ DEFINE/NOLOG OBJ$ ", $DIR(OBJ)3 EMIT "$ CC/DEBUG/OBJ=OBJ$:/ANA=OBJ$: SRC$:",$MODTYP ' EMIT "$ VDE/DEPEND C OBJ$:",$MOD,".ANA" EXIT $ VDE = VDE„ CREATE SCRIPT/COMPILE=[RMS]*.C [MYDIR]SCRIPT_C.VDESCRIPT L %VDE-I-SCRPADDED, script from file DEV$:[MYDIR]SCRIPT_C.VDESCRIPT;9 added to the database / script to compile module [RMS]*.C (segment 10) > %VDE-I-COMMIT, database transaction has successfully committed VDE„ |
6 In this example, the user first types the script file D [MYDIR]SCRIPT_C.VDESCRIPT on the terminal. The script contains five @ EMIT keywords followed by an EXIT keyword. The user then enters < VDE and uses the CREATE SCRIPT keyword to enter that script ; file into the VDE database as the compile script for all C F modules in facility RMS. The log messages confirm that the script was ' successfully entered into the database.
| #2 |
|---|
% $ TYPE [MYDIR]SCRIPT_LINK_X.VDESCRIPT F ! VDE script to generate the DCL commands needed to link module X.EXE. ! EMIT "$ SET VERIFY" ' EMIT "$ DEFINE OBJLIB ", $DIR(OBJ,CODE) 2 EMIT "$ LINK/EXE=OBJLIB:X.EXE/MAP=OBJLIB:X.MAP -"D EMIT " OBJLIB:OBJLIB.OLB/INCLUDE=C,OBJLIB:OBJLIB.OLB/LIBRARY" EMIT "$ DEASSIGN OBJLIB" $ VDE - VDE„ CREATE SCRIPT/LINK=X.EXE [MYDIR]SCRIPT_C H %VDE-I-SCRPADDED, script from file DEV$:[MYDIR]SCRIPT_LINK_X.VDESCRIPT;2 added to the database/ script to link module [CODE]X.EXE (segment 10) > %VDE-I-COMMIT, database transaction has successfully committed VDE„ SHOW SCRIPT/TEXT/LINK=X.EXE. Script to link module [CODE]X.EXE (segment 10) Text of script:N 1: ! VDE script to generate the DCL commands needed to link module X.EXE. 2: ! 3: EMIT "$ SET VERIFY" / 4: EMIT "$ DEFINE OBJLIB ", $DIR(OBJ,CODE) : 5: EMIT "$ LINK/EXE=OBJLIB:X.EXE/MAP=OBJLIB:X.MAP -"L 6: EMIT " OBJLIB:OBJLIB.OLB/INCLUDE=C,OBJLIB:OBJLIB.OLB/LIBRARY" 7: EMIT "$ DEASSIGN OBJLIB" VDE„ |
q Previous X Next[ Contents ] Index