Code:
- :pnlgrp.
- .************************************************************************
- .* Help for command BUILD
- .************************************************************************
- :help name='BUILD'.
- Build an object from source - Help
- :p.The Build an object from source (BUILD) command scans your source
- code for the commands needed to create a program or service program.
- .*
- :p.The BUILD command scans for the :hp2.*>:ehp2. character sequence.
- When this is found, it's considered to be the start of a command
- that you want to run to create your program. Everything after the
- after the :hp2.*>:ehp2. characters is considered part of the command
- command, up until the end of the line is reached, or a :hp2.<*:ehp2.
- character sequence is reached. The :hp2.<*:ehp2. sequence designates
- the end of a command string.
- .*
- :p.After executing your command, the BUILD tool will then search
- for the next line that contains a :hp2.*>:ehp2. sequence, and will
- run that line as a separate command.
- .*
- :p.You can add the - character as the last character of a command.
- When BUILD finds a command that ends with the - character (meaning
- that - is the last non-blank character before <* or the end of a
- record) it will proceed to read the next command string, and add it
- to the end of the current one. This can be done multiple times
- to build a command that's up to 32702 characters long.
- .*
- :p.The BUILD command can also insert variables into your command
- text. If the following values are found, they are replaced with
- the corresponding value calculated by the BUILD program:
- :dl.
- :dt.&O
- :dd.Object Library
- :dt.&ON
- :dd.Object name
- :dt.&F
- :dd.Source file name
- :dt.&L
- :dd.Source file library
- :dt.&N
- :dd.Member name
- :dt.&DV
- :dd.Debug view value specified when BUILD was run.
- :dt.&OV
- :dd.OPM debug view (*LSTDBG or *SRCDBG)
- :dt.&EV
- :dd.The *EVENTF or *NOEVENTF specified when BUILD was run.
- :dt.&R
- :dd.REPLACE option specified when BUILD was run.
- :dt.&X
- :dd.Source member text (with single quotes added)
- :dt.&YY
- :dd.Current year, 2-digit
- :dt.&YYYY
- :dd.Current year, 4-digit
- :edl.
- .*
- :p.Normally, if a command designated in your source code fails,
- the BUILD utility will stop processing and return an error.
- However, if a command is prefixed with :hp2.ign::ehp2. then
- failure will be ignored, and BUILD will proceed to the next command.
- .*
- :p.:hp2.Restrictions::ehp2.
- :ul.
- :li.
- The BUILD command runs the commands that were desginated in the
- source code. You must have proper authority to run any of the
- commands that you list.
- :li.
- This command has not been tested in a multi-threaded environment,
- but should work properly, provided that it is not invoked twice
- concurrently.
- :eul.
- :ehelp.
- .*******************************************
- .* Help for parameter OBJ
- .*******************************************
- :help name='BUILD/OBJ'.
- Object Name (OBJ) - Help
- :xh3.Object Name (OBJ)
- :p.Specifies the name of the object to build. The value you
- specify will be used to supply the value for the &O (object library)
- and &ON (object name) variables in the commands you execute.
- .*
- :p.This is a required parameter.
- :p.:hp2.Qualifier 1: Object Name:ehp2.
- :parml.
- :pt.:pv.name:epv.
- :pd.
- Specify the name of name of the object that you (ostensibly) will
- be building.
- :eparml.
- :p.:hp2.Qualifier 2: Object Library:ehp2.
- :parml.
- :pt.:pk def.*CURLIB:epk.
- :pd.
- Specify the current library (or QGPL if you have no current library)
- as the location to build objects in.
- .*
- :pt.:pv.name:epv.
- :pd.
- Specify the name of name of the library in which to build objects.
- .*
- :eparml.
- :ehelp.
- .*******************************************
- .* Help for parameter SRCFILE
- .*******************************************
- :help name='BUILD/SRCFILE'.
- Source File (SRCFILE) - Help
- :xh3.Source File (SRCFILE)
- :p.Specifies the source file containing the commands to execute.
- .* Describe the function provided by the parameter.
- :p.:hp2.Qualifier 1: Source File:ehp2.
- :parml.:pt.:pk def.QRPGLESRC:epk.
- :pd.
- Look for commands in the QRPGLESRC file (the default source file
- for ILE RPG source code.)
- .* Describe the function provided by the default parameter value.
- :pt.:pv.name:epv.
- :pd.
- Specify the name of a source physical file that contains your
- source code with the *> and <* strings.
- .*
- :eparml.
- :p.:hp2.Qualifier 2: Library:ehp2.
- :parml.
- :pt.:pk def.*LIBL:epk.
- :pd.
- Search the library list for the source file that contains the proper
- member.
- .*
- :pt.:pk.*CURLIB:epk.
- :pd.
- Expect the source file containing the member to be in your current
- library.
- .*
- :pt.:pv.name:epv.
- :pd.
- Specify the name of the library that contains your source file.
- .*
- :eparml.
- :ehelp.
- .*******************************************
- .* Help for parameter SRCMBR
- .*******************************************
- :help name='BUILD/SRCMBR'.
- Source member (SRCMBR) - Help
- :xh3.Source member (SRCMBR)
- :p.Specifies the source member containing the *> and <* strings.
- .*
- :parml.
- :pt.:pk def.*OBJ:epk.
- :pd.
- Use the same name as the OBJ() parameter, above.
- .*
- :pt.:pv.name:epv.
- :pd.
- Specify the name of the source member to use.
- .*
- :eparml.
- :ehelp.
- .*******************************************
- .* Help for parameter DBGVIEW
- .*******************************************
- :help name='BUILD/DBGVIEW'.
- Debug View (DBGVIEW) - Help
- :xh3.Debug View (DBGVIEW)
- :p.Specifies the debugging view that will be used to calculate the
- &DV and &OV variables in your build script.
- .*
- :parml.
- :pt.:pk def.*LIST:epk.
- :pd.
- The &DV variable will be set to *LIST for ILE modules and programs,
- or *SOURCE for embedded SQL precompiler. The &OV variable will be
- set to *LSTDBG for OPM programs.
- .*
- :pt.:pk.*SOURCE:epk.
- :pd.
- The &DV variable will be set to *SOURCE for ILE modules and progams,
- as well as the embedded SQL precompiler. The &OV variable will be
- set to *SRCDBG for OPM programs.
- .*
- :pt.:pk.*STMT:epk.
- :pd.
- The &DV variable will be set to *STMT for ILE programs. The &OV
- variable will be set to *NOSRCDBG.
- .*
- :pt.:pk.*NONE:epk.
- :pd.
- The &DV variable will be set to *NONE, and &OV will be set to *NOSRCDBG
- .*
- :eparml.
- :ehelp.
- .*******************************************
- .* Help for parameter REPLACE
- .*******************************************
- :help name='BUILD/REPLACE'.
- Replace object (REPLACE) - Help
- :xh3.Replace object (REPLACE)
- :p.Specifies whether an existing object should be sent to QRPLOBJ
- and replaced (or not.) The value given is available to the commands
- you run using the &R variable.
- .*
- :parml.
- :pt.:pk def.*YES:epk.
- :pd.
- An existing program (or whatever) should be replaced.
- .*
- :pt.:pk.*NO:epk.
- :pd.
- Existing programs should not be replaced. The BUILD command
- does not have any way to enforce this, however -- it assumes
- you will make use of &R in your build script.
- .*
- :eparml.
- :ehelp.
- .*******************************************
- .* Help for parameter ALWF9
- .*******************************************
- :help name='BUILD/ALWF9'.
- Allow F9=Retrieve on commands (ALWF9) - Help
- :xh3.Allow F9=Retrieve on commands (ALWF9)
- :p.Specifies whether F9=Retrieve can be used to retrieve the commands
- that were included in the source member. For example, if you had
- coded the CRTBNDRPG command in your *> <* tags in the source code,
- should F9=Retrieve display the CRTBNDRPG command? Or should it
- display the BUILD command?
- .*
- :parml.
- :pt.:pk.*YES:epk.
- :pd.
- Pressing F9 will retrieve the commands that were executed by BUILD
- .*
- :pt.:pk def.*NO:epk.
- :pd.
- Pressing F9 will retrieve the BUILD command itself, but not any of
- the commands that BUILD ran for you.
- .*
- :eparml.
- :ehelp.
- .*******************************************
- .* Help for parameter OPTION
- .*******************************************
- :help name='BUILD/OPTION'.
- Compiler Options (OPTION) - Help
- :xh3.Compiler Options (OPTION)
- :p.Specifies special options sometimes required by the Rational tools
- for editing your source.
- :parml.
- :pt.:pk.*NOEVENTF:epk.
- :pd.
- The &EV variable will contain *NOEVENTF.
- .*
- :pt.:pk.*EVENTF:epk.
- :pd.
- The &EV variable will contain *EVENTF.
- .* Describe the function provided by the pre-defined parameter value.
- :eparml.
- :ehelp.
- .*******************************************
- .* Help for parameter USECMD
- .*******************************************
- :help name='BUILD/USECMS'.
- Compiler Options (USECMS) - Help
- :xh3.Compiler Options (USECMS)
- :p.Specifies special instructions in the tool to look up object
- information from your CMS database and then use the CMS create
- tool(s) to perform the actual create object function.
- :parml.
- :pt.:pk.*NO:epk.
- :pd.
- The BUILD tool will look for a pre-determined CRTxxx command to use.
- .*
- :pt.:pk.*YES:epk.
- :pd.
- The BUILD tool will query the CMS database for all the required parameter
- values that cannot be had from the Rational LPEX tool / PDM tool by default.
- It will then run a pre-determined CMS create command.
- :eparml.
- :ehelp.
- .*******************************************
- .* Help for parameter LIST
- .*******************************************
- :help name='BUILD/LIST'.
- Compiler Options (LIST) - Help
- :xh3.Compiler Options (LIST)
- :p.Specifies the create command to produce a compile listing for
- those types that offer one. Most do and all of the typical
- compile commands included offer a listing.
- :parml.
- :pt.:pk.*NO:epk.
- :pd.
- The compile listing will not be retained.
- .*
- :pt.:pk.*YES:epk.
- :pd.
- The compile listing will be retained. This value is most important
- for those CMS compiles in which some CMS systems will remove a
- good compile listing for the programmer.
- :eparml.
- :ehelp.
- .**************************************************
- .*
- .* Examples for BUILD
- .*
- .**************************************************
- :help name='BUILD/COMMAND/EXAMPLES'.
- Examples for BUILD - Help
- :xh3.Examples for BUILD
- :p.:hp2.Example 1: Simple Command Example:ehp2.
- :xmp.
- BUILD OBJ(FOO)
- :exmp.
- :p.This command builds an object named FOO. To determine
- how to do that, it looks for a source member named FOO in a
- QRPGLESRC source file in your library list.
- .*
- :p.:hp2.Example 2: Complex Command Example:ehp2.
- :xmp.
- BUILD OBJ(&L/&N) SRCFILE(&L/&F) DBGVIEW(*SOURCE) REPLACE(*YES)
- USECMS(*YES) OPTION(*EVENTF)
- :exmp.
- :p.This command builds an object named using the PDM style
- replacement parameters. The replacement parameters can be
- determined by using F16 or option 9 in PDM. Or by adding a
- custom compile command to the LPEX editor.
- There is a list of variable you can insert.
- .*
- :ehelp.
- .**************************************************
- .*
- .* Error messages for BUILD
- .*
- .**************************************************
- :help name='BUILD/ERROR/MESSAGES'.
- &msg(CPX0005,QCPFMSG). BUILD - Help
- :xh3.&msg(CPX0005,QCPFMSG). BUILD
- :p.Refer to the list of errors for the command(s) in your build
- comments for a list of the errors that can be returned by this
- utility.
- :ehelp.
- :epnlgrp.
|
|