bmsclean

Description

Cleans all the BMS map build artefacts created by the bms task.

Parameters

Attribute	Description	Required
binarydir	The directory containing the .MOD file output to be cleaned.	Yes
configuration	The name of the build configuration.	No
copydir	The directory containing the .CPY file outputs to be cleaned.	No
dsect	If true, causes file output(s) of the extension specified by dsectextension to be cleaned. Defaults to `false`. Important: This attribute is deprecated.	Ignored
dsectextension	Specify the extension of DSECT output file to be cleaned. Should be either ".CPY" or ".INC". Important: This attribute is deprecated.	Ignored
failonerror	If true, stops the build process if the task exits with a return-code other than 0. Defaults to `false`.	No
map	If true, binary (.MOD) output are cleaned. Defaults to `false`. Important: This attribute is deprecated.	Ignored
verbose	If true, causes additional informational messages to be displayed by the task. Defaults to `false`.	No

Parameters specified as nested elements

mfdirlist: Use nested <mfdirlist> elements to specify directives to be used to compile the program(s). See mfdirlist.
fileset: Use nested <fileset> elements to specify the source file name(s) whose artefacts should be cleaned.
mffilelist: Use nested <mffilelist> elements to specify the source file name(s). See mffilelist.
mfdestfilelist: Use nested <mfdestfilelist> elements to specify any additional build artefact(s) that need to be cleaned. See mfdestfilelist.

Errors and return codes

By default, the return code of a <bmsclean> task is ignored. When you set failonerror="true", any non-zero response is treated as an error and means the build exits.

Examples

Remove all BMS build artefacts for a referenced mffilelist element using the directives in a referenced mfdirlist element:

<mfdirlist id="bms_directive_set_1">
    <directive name="/IGNORE"/>
    <directive name="/SYSPARM" value="MAP"/>
    <directive name="/DP" value="."/>
    <directive name="/SYSPARM" value="DSECT"/>
    <directive name="/CS" value="$"/>
</mfdirlist>
<mffilelist id="bms_file_set_1" srcdir="${basedir}" type="srcfile">
    <file name="MAPSET1.bms"/>
</mffilelist>

<bmsclean dsect="true" verbose="false" map="true" failonerror="true" binarydir="${basedir}/bin" copydir="${basedir}" dsectextension=".INC">
    <mfdirlist refid="bms_directive_set_1"/>
    <mffilelist refid="bms_file_set_1"/>
</bmsclean>

Remove all BMS build artefacts for a nested mffilelist element using the directives in a nested mfdirlist element and additional build artefacts using a nested mfdestfilelist element:

<bmsclean dsect="true" verbose="false" map="true" failonerror="true" binarydir="${basedir}/bin" copydir="${basedir}" dsectextension=".INC">
    <mfdirlist>
        <directive name="/IGNORE"/>
        <directive name="/SYSPARM" value="MAP"/>
        <directive name="/DP" value="."/>
        <directive name="/SYSPARM" value="DSECT"/>
        <directive name="/CS" value="$"/>
    </mfdirlist>
    <mffilelist srcdir="${basedir}" type="srcfile">
        <file name="MAPSET1.bms"/>
    </mffilelist>
    <mfdestfilelist>
        <file name="${basedir}/bin/Mapset1.MOD"/>
    </mfdestfilelist>
</bmsclean>