The macro is used to determine the restart point in a series of build scripts and the projects they represent. It should be invoked in the top-level section of the script and be passed the path to the restart directory and the name of the restart project. The macro will bypass execution of projects until the specified project is found. Once the restart project is found, execution begins and will include the restart project and all subsequent projects.

The macro can also be used to restart a project at a specific target. A target level restart requires the list of targets within the project, the required targets, and the name of the restart target. When this option is used, execution begins at the named target in the named project and continues through all subsequent projects.

The macro also supports embedded restart points; a restart point in a series of build scripts that are within a restart point in an outer layer of build scripts.

Attributes

The following table describes the macro specific attributes for the macro:

Macro Specific Attributes
Attribute	Description	Required
defined	A comma delimited list of target names that are defined to the project.	No^*
dir	Path to the restart directory. This directory must not be deleted after a failed build, prior to a restart build, or during a restart build. The restart directory should only be deleted after a successful and complete build.	Yes
project	Name of the restart project. This is the value of the project element’s name attribute specified at the start of the Ant script: <project name="EndaparBuild" ... > For a target restart, the project attribute should be specified in one of the following forms: projectName(targetName) projectName(tagetName,targetName) where both the project and a list of comma delimited target names are identified.	Yes
required	A comma delimited list of target names that are required. These targets will be executed for a target level restart, even if the are not explicitly specified.	No^*
target	Name of the exit target for the script. The default exit target name is `end`.	No
type	Type of restart. The default is `project`. This attribute is required for an embedded restart, otherwise it is ignored.	No

^*This attribute is required for a target level restart, otherwise it is ignored.

Notes

None

Examples

Check for restart at the start of the script:

<!-- Check restart request -->
<ac:if>
    <isset property="team.enterprise.smpe.build.restartProject"/>
    <ac:then>
        <AntRestart dir="${dir.work}" project="${team.enterprise.smpe.build.restartProject}" defined="init,main,term" required="init,term"/>
    </ac:then>
</ac:if>

getTaskNameHdr()

Attributes

Notes

Examples