mirror of
https://github.com/boostorg/build.git
synced 2026-02-14 12:42:11 +00:00
116 lines
4.0 KiB
XML
116 lines
4.0 KiB
XML
<?xml version="1.0" encoding="UTF-8"?>
|
|
<!DOCTYPE section PUBLIC "-//Boost//DTD BoostBook XML V1.0//EN"
|
|
"http://www.boost.org/tools/boostbook/dtd/boostbook.dtd">
|
|
|
|
<section id="bbv2.reference.class.abstract-target">
|
|
|
|
<title>Class abstract-target</title>
|
|
<indexterm>
|
|
<primary>abstract-target</primary>
|
|
</indexterm>
|
|
|
|
<para>
|
|
Base class for all abstract targets.
|
|
</para>
|
|
|
|
<para>
|
|
Classes derived from <link linkend="bbv2.reference.class.abstract-target">abstract-target</link>:
|
|
<itemizedlist>
|
|
<listitem>
|
|
<link linkend="bbv2.reference.class.project-target">project-target</link>
|
|
</listitem>
|
|
<listitem>
|
|
<link linkend="bbv2.reference.class.main-target">main-target</link>
|
|
</listitem>
|
|
<listitem>
|
|
<link linkend="bbv2.reference.class.project-target">basic-target</link>
|
|
</listitem>
|
|
</itemizedlist>
|
|
</para>
|
|
|
|
<orderedlist>
|
|
|
|
<listitem id="bbv2.reference.class.abstract-target.__init__">
|
|
<code language="jam">rule __init__ ( name : project-target )</code>
|
|
<para>
|
|
<variablelist>
|
|
<varlistentry>
|
|
<literal>name</literal>
|
|
<listitem>
|
|
<para>Name of the target in Jamfile.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<literal>project-target</literal>
|
|
<listitem>
|
|
<para>The project target to which this one belongs.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</para>
|
|
</listitem>
|
|
|
|
<listitem id="bbv2.reference.class.abstract-target.name">
|
|
<indexterm zone="bbv2.reference.class.abstract-target.name">
|
|
<primary>name</primary>
|
|
<secondary>Abstract Target</secondary>
|
|
</indexterm>
|
|
<code language="jam">rule name ( )</code>
|
|
<para>Returns the name of this target.</para>
|
|
</listitem>
|
|
|
|
<listitem id="bbv2.reference.class.abstract-target.project">
|
|
<indexterm zone="bbv2.reference.class.abstract-target.project">
|
|
<primary>project</primary>
|
|
<secondary>Abstract Target</secondary>
|
|
</indexterm>
|
|
<code language="jam">rule project ( )</code>
|
|
<para>Returns the project for this target.</para>
|
|
</listitem>
|
|
|
|
<listitem id="bbv2.reference.class.abstract-target.location">
|
|
<indexterm zone="bbv2.reference.class.abstract-target.location">
|
|
<primary>location</primary>
|
|
<secondary>Abstract Target</secondary>
|
|
</indexterm>
|
|
<code language="jam">rule location ( )</code>
|
|
<para>Return the location where the target was declared.</para>
|
|
</listitem>
|
|
|
|
<listitem id="bbv2.reference.class.abstract-target.full-name">
|
|
<indexterm zone="bbv2.reference.class.abstract-target.full-name">
|
|
<primary>full-name</primary>
|
|
<secondary>Abstract Target</secondary>
|
|
</indexterm>
|
|
<code language="jam">rule full-name ( )</code>
|
|
<para>Returns a user-readable name for this target.</para>
|
|
</listitem>
|
|
|
|
<listitem id="bbv2.reference.class.abstract-target.generate">
|
|
<indexterm zone="bbv2.reference.class.abstract-target.generate">
|
|
<primary>generate</primary>
|
|
<secondary>Abstract Target</secondary>
|
|
</indexterm>
|
|
<code language="jam">rule generate ( property-set )</code>
|
|
<para>
|
|
Generates virtual targets for this abstract target using the specified
|
|
properties, unless a different value of some feature is required by the
|
|
target. This is an abstract method which must be overriden by derived
|
|
classes.
|
|
</para>
|
|
|
|
<para>
|
|
On success, returns:
|
|
<itemizedlist>
|
|
<listitem>a property-set with the usage requirements to be applied to dependents</listitem>
|
|
<listitem>a list of produced virtual targets, which may be empty.</listitem>
|
|
</itemizedlist>
|
|
If <code language="jam">property-set</code> is empty, performs the
|
|
default build of this target, in a way specific to the derived class.
|
|
</para>
|
|
</listitem>
|
|
|
|
</orderedlist>
|
|
|
|
</section>
|