From 47134db8a261f58f2a3c2e02760da0183f106839 Mon Sep 17 00:00:00 2001 From: Leo Treggiari Date: Fri, 22 Jul 2005 13:27:21 +0000 Subject: [PATCH] Additional 3.0 functionality --- .../Managed_Build_Extensibility.html | 319 ++++++++++++++++-- 1 file changed, 294 insertions(+), 25 deletions(-) diff --git a/doc/org.eclipse.cdt.doc.isv/guide/mbs/extensibilityGuide/Managed_Build_Extensibility.html b/doc/org.eclipse.cdt.doc.isv/guide/mbs/extensibilityGuide/Managed_Build_Extensibility.html index eb47eaccf59..7fe0c649a0b 100644 --- a/doc/org.eclipse.cdt.doc.isv/guide/mbs/extensibilityGuide/Managed_Build_Extensibility.html +++ b/doc/org.eclipse.cdt.doc.isv/guide/mbs/extensibilityGuide/Managed_Build_Extensibility.html @@ -692,6 +692,10 @@ at least one configuration defined for it. A configuration must define (or inherit) a set of tool-chain definitions that work together to produce the build goal as an output.

A projectType may define a project +level environment variable provider in the projectEnvironmentSupplier attribute.  See § +7.6 for additional information.
+

+

A projectType may define a project level macro provider in the projectMacroSupplier attribute.  See § 7.8 for additional information.

@@ -825,7 +829,8 @@ UI.

-   + The name of a class that implements the IProjectEnvironmentVariableSupplier + interface in order to provide project level environment variables. @@ -839,7 +844,8 @@ UI.

-   + The name of a class that implements the IConfigurationNameProvider + interface in order to provide a default name for a configuration. @@ -948,11 +954,6 @@ The configuration contains the information needed to “clean” the bui the host machine.  The configuration can specify the cleanCommand attribute which specifies a command that removes the build files. 

-

A configuration may define a -configuration -level macro provider in the configurationMacroSupplier attribute.  See § -7.8 for additional information.
-

Additional configuration attributes are described in the schema table below.

3.4.1 Schema

valign="top"> no - + + style="border-style: none solid solid double; border-width: medium 1pt 1pt 1.5pt; border-left: 1.5pt double windowtext; border-right: 1pt solid windowtext; border-bottom: 1pt solid windowtext; padding: 0in 5.4pt;" + valign="top"> + prebuildStep + valign="top"> + Specifies the pre-build command(s), which runs prior to the standard MBS + build. + preannouncebuild + Step + Specifies the post-build command(s), which runs after the standard MBS + build. + no + + + + + + + + + + + + + + +
- configurationMacro Supplier - The name of a class that implements the IConfigurationBuildMacroSupplier - interface in order to provide configuration level build macros. + valign="top"> no
-   -   -  
+ postbuildStep + Specifies the string to be displayed when the pre-build command step is + run. + no
+ postannouncebuild + Step + Specifies the string to be displayed when the post-build command step is + run. + no
+ description + Specifies the description of the configuration that will be displayed to + the user while creating a project and managing configurations. + no
@@ -1125,6 +1174,15 @@ build output.  If this is not specified, then MBS uses the file extension of the build artifact name supplied by the user.  This will work when the user uses one of the extensions expected by the tool, but will not work if they do not.

+

A tool-chain may define a +configuration level environment variable provider in the configurationEnvironmentSupplier attribute.  See § +7.6 for additional information.
+

+

A tool-chain may define a +configuration +level macro provider in the configurationMacroSupplier attribute.  See § +7.8 for additional information.
+

Additional tool-chain attributes are described in the schema table below.

3.5.1 Schema

@@ -1288,6 +1346,79 @@ the schema table below.

+ configurationMacro Supplier + + The name of a class that implements the IConfigurationBuildMacroSupplier + interface in order to provide configuration level build macros. + + no + + + + configurationEnviron mentSupplier + + The name of a class that implements the IConfigurationEnvironmentVariableSupplier + interface in order to provide configuration level environment variables. + + no + + + + isToolChain + Supported + +   + + no + + + + versionsSupported + +   + + no + + + + convertToId + +   + + no + + + scannerInfoCollector

A tool contains one or more children of type inputType and outputType.  These define the inputs and outputs of the tool in the detail necessary for build file generation.

+

A tool contains one or more +children of type envVarBuildPath.  These specify the names of the +environment variables used by the tool for specifying the include and the +library paths.

Certain tools logically belong to certain kinds of projects. For example, the Gnu compiler is invoked differently for C and C++ source files. You can specify a filter for a tool based on the @@ -2211,6 +2346,62 @@ Gnu C compiler, or g++ for the Gnu C++ compiler. + announcement + +   + + no + + + + icon + +   + + no + + + + versionsSupported + +   + + no + + + + convertToId + +   + + no + + +

dependencyCalculator

@@ -2944,6 +3135,19 @@ categories. This is the ID of the owner of the category.

yes

+ + + icon + +   + + no +

3.13 Option

@@ -3021,14 +3225,14 @@ unaware that there are libraries and external object files that participate in the final build step.

3.13.1.4.2 Browse Types

-

Certain types of list options that deal with files or directories -are easier for the user to manipulate if there is a browse button -supplied in the UI. This is especially true for include and library -search paths, as well as library and object file lists. Because the UI -needs to know what "type" of browser to display, the implementer must -specify the browseType for list options as none +

Certain types of list and string options that deal with files or directories +are easier for the user to manipulate if there is a browse button supplied in +the UI. This is especially true for include and library search paths, as well as +library and object file lists. Because the UI needs to know what "type" of +browser to display, the implementer may +specify the browseType for list and string options as none (default), file, or directory. Note that -the browseType attribute is only used for list options. It +the browseType attribute is only used for list and string options. It is ignored for all other option types.

3.13.2 Values and Default Values

@@ -3380,6 +3584,40 @@ needed. individual file’s options.  Specifying “file” indicates the opposite. no + + + valueHandler +   + no + + + valueHandlerExtra + Argument +   + no + + + applicability Calculator +   + no @@ -3616,6 +3854,37 @@ attributes are specified in the schema table below.

resourceConfiguration element should retain its tool children, if any exist, even when excluded from the build. + no + + + + rcbsApplicability + + Identifies how the user desires to apply a resource custom build step:
+ 1. Apply rcbs tool before any other tools defined for the resource.
+ 2. Apply rcbs tool after any other tools defined for the resource.
+ 3. Apply rcbs tool overriding any other tools defined for the resource.
+ 4. Disable (don't apply) the rcbs tool. + + no + + + + toolsToInvoke + + Identifies which tools to invoke by a semicolon separated list of child + tool ids. Applies as follows:
+ 1. Defaults to all tools in the order found
+ 2. Use specified ordered list of children to invoke
+ 3. If empty string, treat as if no resource configuration existed, i.e., + use project level tool. + no