metaonly module xdc.tools.configuro.ccs.Main
index URL

Command-line configuration tool adapter for Code Composer Studio

This command is a wrapper for Configuro that adapts it for use inside Code Composer Studio. It is not intended to be called directly by users.
XDCscript usage meta-domain sourced in xdc/tools/configuro/ccs/Main.xdc
var Main = xdc.useModule('xdc.tools.configuro.ccs.Main');
module-wide config parameters
    Main.usage// usage help message = String[] [
        '[-v|--help]',
        '[-@ optionsfile] [--xp xdcpath]',
        '[-b config_bld | -c codegen_dir | --cb]',
        '[-t target] [-p platform[:instance]] [-r profile]',
        '[-Dname=value] [--tcf] [--bios5]',
        '[-w|-x regexp]',
        '[-o outdir] infile.cfg'
    ];
module-wide functions
    Main.exec// 'xs' script entry point(Any args) returns Any
    Main.main// 'xs' shell entry point(Any args) returns Any
per-instance config parameters
    var params = new Main.Params// Instance config-params object;
        params.bios5Incs// Add "include" directory from pacakge "ti.bios" to compiler options = Bool false;
        params.configbld// config.bld file name = String null;
        params.defines// set Java properties in the configuration environment = String[] [ ];
        params.exclude// exclude packages from compatibility checking = String null;
        params.hasTconf// Process infile.tcf in addition to infile.cfg = Bool false;
        params.output// name of the output directory = String null;
        params.platform// the platform to use = String null;
        params.profile// build profile to use = String 'release';
        params.rootdir// root directory of the code generation tools = String null;
        params.searchForConfigBld// Use a config.bld found along the package path = Bool false;
        params.target// target module = String null;
        params.verbose// show details during build = Bool false;
        params.warn// incompatibilites are treated only as warnings = Bool false;
        params.xdcPath// XDC path = String[] [ ];
per-instance functions
    inst.gen// Generate and build the configuration package(String infile) returns Int
    inst.run// Underlying implementation(Cmdr.Instance cmdr, String[] args) returns Any
 
config Main.usage  // module-wide
index URL

usage help message

XDCscript usage meta-domain
Main.usage = String[] [
    '[-v|--help]',
    '[-@ optionsfile] [--xp xdcpath]',
    '[-b config_bld | -c codegen_dir | --cb]',
    '[-t target] [-p platform[:instance]] [-r profile]',
    '[-Dname=value] [--tcf] [--bios5]',
    '[-w|-x regexp]',
    '[-o outdir] infile.cfg'
];
Main.exec()  // module-wide
index URL

'xs' script entry point

XDCscript usage meta-domain
Main.exec(Any args) returns Any
Main.main()  // module-wide
index URL

'xs' shell entry point

XDCscript usage meta-domain
Main.main(Any args) returns Any
Instance Config Parameters
index URL

XDCscript usage meta-domain
var params = new Main.Params;
// Instance config-params object
    params.bios5Incs = Bool false;
    // Add "include" directory from pacakge "ti.bios" to compiler options
    params.configbld = String null;
    // config.bld file name
    params.defines = String[] [ ];
    // set Java properties in the configuration environment
    params.exclude = String null;
    // exclude packages from compatibility checking
    params.hasTconf = Bool false;
    // Process infile.tcf in addition to infile.cfg
    params.output = String null;
    // name of the output directory
    params.platform = String null;
    // the platform to use
    params.profile = String 'release';
    // build profile to use
    params.rootdir = String null;
    // root directory of the code generation tools
    params.searchForConfigBld = Bool false;
    // Use a config.bld found along the package path
    params.target = String null;
    // target module
    params.verbose = Bool false;
    // show details during build
    params.warn = Bool false;
    // incompatibilites are treated only as warnings
    params.xdcPath = String[] [ ];
    // XDC path
config Main.bios5Incs  // instance
index URL

Add "include" directory from pacakge "ti.bios" to compiler options

XDCscript usage meta-domain
var params = new Main.Params;
  ...
params.bios5Incs = Bool false;
config Main.configbld  // instance
index URL

config.bld file name

XDCscript usage meta-domain
var params = new Main.Params;
  ...
params.configbld = String null;
DETAILS
The path to the user's config.bld. Replaces ROOTDIR.
config Main.defines  // instance
index URL

set Java properties in the configuration environment

XDCscript usage meta-domain
var params = new Main.Params;
  ...
params.defines = String[] [ ];
DETAILS
-Dconfig.importPath is treated specially -- these directories are added to the end of the package path.
config Main.exclude  // instance
index URL

exclude packages from compatibility checking

XDCscript usage meta-domain
var params = new Main.Params;
  ...
params.exclude = String null;
DETAILS
A list of regular expressions used to select packages that should be excluded from the set of packages checked during configuration.
SEE
xdc.cfg
config Main.hasTconf  // instance
index URL

Process infile.tcf in addition to infile.cfg

XDCscript usage meta-domain
var params = new Main.Params;
  ...
params.hasTconf = Bool false;
config Main.output  // instance
index URL

name of the output directory

XDCscript usage meta-domain
var params = new Main.Params;
  ...
params.output = String null;
config Main.platform  // instance
index URL

the platform to use

XDCscript usage meta-domain
var params = new Main.Params;
  ...
params.platform = String null;
DETAILS
If undefined, the default platform for the XDC build target named.
config Main.profile  // instance
index URL

build profile to use

XDCscript usage meta-domain
var params = new Main.Params;
  ...
params.profile = String 'release';
DETAILS
The name of the build profile to use for the XDC content, for example 'release' or 'debug'. The list of allowed profiles is determined by the XDC build target named.
config Main.rootdir  // instance
index URL

root directory of the code generation tools

XDCscript usage meta-domain
var params = new Main.Params;
  ...
params.rootdir = String null;
DETAILS
The path to the installation directory of the compiler and linker.
config Main.searchForConfigBld  // instance
index URL

Use a config.bld found along the package path

XDCscript usage meta-domain
var params = new Main.Params;
  ...
params.searchForConfigBld = Bool false;
config Main.target  // instance
index URL

target module

XDCscript usage meta-domain
var params = new Main.Params;
  ...
params.target = String null;
DETAILS
The name of an XDC build target module to use, for example ti.targets.C64P. If no target is named, the target used is Build.targets[0], from config.bld.
config Main.verbose  // instance
index URL

show details during build

XDCscript usage meta-domain
var params = new Main.Params;
  ...
params.verbose = Bool false;
config Main.warn  // instance
index URL

incompatibilites are treated only as warnings

XDCscript usage meta-domain
var params = new Main.Params;
  ...
params.warn = Bool false;
DETAILS
If set to "true", force any incompatibilities detected to be treated as warnings only; otherwise incompatibilities are fatal.
SEE
xdc.cfg
config Main.xdcPath  // instance
index URL

XDC path

XDCscript usage meta-domain
var params = new Main.Params;
  ...
params.xdcPath = String[] [ ];
Main.gen()  // instance
index URL

Generate and build the configuration package

XDCscript usage meta-domain
inst.gen(String infile) returns Int
Main.run()  // instance
index URL

Underlying implementation

XDCscript usage meta-domain
inst.run(Cmdr.Instance cmdr, String[] args) returns Any
generated on Tue, 24 Aug 2010 15:39:22 GMT