From 73dfe96b04efa2fc11762e1a121b6b621b4517b5 Mon Sep 17 00:00:00 2001 From: Leo Treggiari Date: Wed, 28 Sep 2005 23:20:05 +0000 Subject: [PATCH] Add the assignToOption attribute and update other attribute descriptions --- .../Managed_Build_Extensibility.html | 137 +++++++++++++----- 1 file changed, 102 insertions(+), 35 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 e6e11c38680..d5d21108b6d 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 @@ -86,7 +86,7 @@ managed build system and how to extend it. Leo Treggiari - Revision Date + Revision Date 10/21/2003 - Version: 0.1.0 @@ -99,8 +99,11 @@ managed build system and how to extend it. 8/10/2005 - Version 3.0.0 - Change History - 0.1.0 - Document Creation + 9/28/2005 - Version 3.0.1 + + + Change History + 0.1.0 - Document Creation 2.0.0 - Updated for CDT 2.0 @@ -111,6 +114,9 @@ managed build system and how to extend it. 3.0 - Updated for CDT 3.0 + + 3.0.1 - Updated for CDT 3.0.1 +
@@ -664,6 +670,8 @@ ancestor that specifies a value for the attribute.

indicate attributes that are deprecated in CDT 3.0.  Each of these attributes describes the new method to use to obtain equivalent functionality. +
  • Attributes highlighted in green + implement functionality that is new for CDT 3.0.1.
  • The "Required" column can contain 3 values.  "Yes" means that the attribute is required by the schema for every instance of the element.  "No" means that the attribute is never required and an appropriate default is @@ -930,7 +938,7 @@ project/configurations for modification by the user.

    style="border-style: none solid solid none; border-width: medium 1pt 1pt medium; border-right: 1pt solid windowtext; border-bottom: 1pt solid windowtext; padding: 0in 5.4pt;" valign="top" height="17"> The name for the managedProject that is displayed to the user in the -UI. +UI. This is the name that the user entered in the New Project wizard. @@ -1336,7 +1344,7 @@ the schema table below.

    - The list of operating systems that the tool-chain is supported on.  The + The comma separated list of operating systems that the tool-chain is supported on.  The valid list of operating systems is the string values returned by Platform.getOS().
    I    f @@ -1358,7 +1366,7 @@ the schema table below.

    style="border-style: none solid solid none; border-width: medium 1pt 1pt medium; border-right: 1pt solid windowtext; border-bottom: 1pt solid windowtext; padding: 0in 5.4pt;" valign="top"> - The list of architectures that the tool-chain is supported on.  The + The comma separated list of architectures that the tool-chain is supported on.  The valid list of architectures is the string values returned by Platform.getOSArch().
    @@ -1619,8 +1627,11 @@ track of this specific builder.     command - The command used to invoke the builder.  The default is - “make”. + Specifies the default command to start the build + utility for your toolchain. If the user changes this through the UI, the + overriden value will be stored in the project build file. The build + model will default to this value if the user ever resets a change.  + The default is "make". no @@ -1631,8 +1642,12 @@ track of this specific builder.     arguments - The default flags passed to the builder on the command - line.  The default is “-k”. + Specifies the additional, default arguments + that will be passed to the build utility when it is called by the + builder. If the user changes the flags through the UI, the overriden + value will be stored in the project build settings file. The build model + will default to this value if the user ever resets a change. The default + is “-k”. no @@ -1643,8 +1658,11 @@ track of this specific builder. errorParsers - The semi-colon separated list of the default error parsers - to be used with this builder. + Specifies the default list of error parsers used by the builder. These + error parsers are added to this list specified by the parent tool-chain. + It is an ordered, semi-colon separated list of parser IDs. The order + specifies the order in which the error parsers are invoked during a + build. @@ -2084,7 +2102,9 @@ the workspace.

    The list of operating systems that is valid for this target platform.  The valid list of operating systems - is the string values returned by Platform.getOS(). + is the string values returned by Platform.getOS().      If + the osList attribute is not specified, or if the value is "all", then + the target platform supports all operating systems. @@ -2101,7 +2121,9 @@ the workspace.

    The list of architectures that is valid for this target platform.  The valid list of architectures - is the string values returned by Platform.getOSArch(). + is the string values returned by Platform.getOSArch().  If + the archList attribute is not specified, or if the value is "all", then + the target platform supports all architectures. @@ -2350,8 +2372,14 @@ the '-o' flag, whereas the archiver that creates libraries does not.

    - Specify the project natures the tool should apply to.  The default - value is "both". + Filters the display (and use) of the tool by the nature of the project. + Selecting a value of 'cnature' insures that the tool will be + displayed IFF there is a cnature associated with the project. A ccnature + will filter this tool out. If 'ccnature' is selected, the tool + will only be available for C++ projects. If 'both' is + selected, the tool will be displayed when either nature is present. This + attribute is required if it is not inherited from its superClass. The + default value is "both". @@ -2385,7 +2413,8 @@ Gnu C compiler, or g++ for the Gnu C++ compiler. pattern consists of the replaceable variables COMMAND, FLAGS, OUTPUT_FLAG, OUTPUT_PREFIX, OUTPUT and INPUTS.  The default command line pattern is
    - ${COMMAND} ${FLAGS} ${OUTPUT_FLAG}${OUTPUT_PREFIX}${OUTPUT} ${INPUTS}
    + ${COMMAND} ${FLAGS} ${OUTPUT_FLAG}${OUTPUT_PREFIX}${OUTPUT} ${INPUTS}, + except when customBuildStep is true, where the default is $(COMMAND).  White space and other characters are significant and are copied to the generated command. - The id of the option that - is used on the command line to identify this input.  The default is to - not use a command line option and to assign this input to the ${Inputs} - part of the command line. + The id of an Option element that is used on the command line to identify + inputs of this type. If specified, the name(s) of the input files for + this input type are taken from the value specified for the option. @@ -2726,6 +2754,25 @@ attributes of the InputType element are described in the table below.

    + assignToOption + + The id of an Option element whose value is to be assigned to the file(s) + calculated for this input type. The default is not to assign the input + file(s) to a command line option but to assign the files to the + ${Inputs} part of the command line. Note that the option value is only + updated during build file generation and therefore could be out of sync + with the project until build file generation occurs. + +   + + + multipleOfType - The name of the input type that is displayed to the user in the UI. + The name of the output type that is displayed to the user in the UI. @@ -3007,7 +3054,8 @@ attribute.

    output.  The default is to use the Tool “outputFlag” attribute if primaryOutput is True.  If option is not specified, and primaryOutput is False, then the output file(s) of this outputType are not added to the - command line. + command line.  If specified, the nameProvider, namePattern and + outputNames are ignored. @@ -3022,7 +3070,8 @@ attribute.

    style="border-style: none solid solid none; border-width: medium 1pt 1pt medium; border-right: 1pt solid windowtext; border-bottom: 1pt solid windowtext; padding: 0in 5.4pt;" valign="top"> True if multiple outputs of this type are created by one invocation of the - tool.  The default is False. + tool.  The default is False.  If True, the nameProvider + attribute or outputNames attribute must be specified. @@ -3038,7 +3087,7 @@ attribute.

    valign="top"> Id of the input type that is used in determining the build “rules” for the output type and for the default name of the output file.  The default is - the input type with primaryInput == true.. + the input type with primaryInput == true. @@ -3086,7 +3135,8 @@ attribute.

    style="border-style: none solid solid none; border-width: medium 1pt 1pt medium; border-right: 1pt solid windowtext; border-bottom: 1pt solid windowtext; padding: 0in 5.4pt;" valign="top"> Specifies the semi-colon delimited, complete set of output resource names - created by the output type. + created by the output type.  If specified, the namePattern is + ignored. @@ -3222,9 +3272,9 @@ Options'. This will be the name the user sees displayed in the UI.

    -

    Option categories can be nested inside other option -categories. This is the ID of the owner of the category.  The default owner - if the parent tool.

    +

    Option categories can belong to a tool, a toolChain or be nested inside + other option categories. This is the ID of the owner of the category.  The default owner + if the parent tool or tool-chain.

    - Type of value the option contains. + General options can be one of the following types; 'string' for catch-all + entries for options that cannot be easily defined any other way, 'string + list' for entries that consist of a list of values such as defined + symbols or paths, 'boolean' for options that have two values, and + 'enumerated' for options that are one-of a list of values.
    +
    + Additional special types exist to flag options of special relevance to + the build model; 'include', 'libs', 'userObjs' and 'definedSymbols'. You + can pre-populate with optionValues, and they will display in the UI the + same way the 'stringList' options do. The build model will look + specifically for these value types when clients query for include paths + and preprocessor defines. The makefile generator treats the libs and + userObjs entries differently than other stringLists. in hierarchy @@ -3598,7 +3660,8 @@ can be the id of the tool which is also a category.  The default category Value assigned to the option by the end user or in a - default configuration. + default configuration.  For options containing a Boolean + value, the string ‘true’ is treated as true, any other value as false. no @@ -3663,7 +3726,7 @@ False. valign="top">browseType This value is used for list (and related) + valign="top">This value is used for string and stringlist (and related) options only. If you need a list option to prompt the user to browse for a file or directory when adding a new value, set the value of the attribute accordingly. By default the value is treated as no browsing @@ -3794,8 +3857,12 @@ clients of the build model that specifically request them.

    -

    An optional Boolean field that tells the build model to treat -the value defined as read-only.

    +

    This attribute flags the list value as a built-in value as opposed to + something the user has entered. Built-ins will not be passed to clients + that generate command lines (like the makefile generator). However, + clients that need to take these settings into account (like the indexing + service), will receive these settings. These values will appear grey in + the UI.

    @@ -3957,7 +4024,7 @@ attributes are specified in the schema table below.

    style="border-style: none solid solid none; border-width: medium 1pt 1pt medium; border-right: 1pt solid windowtext; border-bottom: 1pt solid windowtext; padding: 0in 5.4pt; vertical-align: top;"> Specifies whether the resource is excluded from building in the parent configuration.  The default value is false.  The - resourceConfiguration element should retain its tool children, if any + resourceConfiguration element retains its tool children, if any exist, even when excluded from the build.