This tools scans the specified repositories looking for package
incompatibilities.
By default, if a package appears in more than one repository, only the
package in the first repository is added to the set of packages to check.
This allows one to check the consistency of all packages that can be found
along a specified package path by simply listing the package path
repositories on the command line.
If no repositories are specified, the repositories named in the current
package path are checked.
struct Main.Results |
 |
XML output format
var obj = new Main.Results;
obj.header = String ...
// user specified header
obj.errors = String[] ...
// array of all errors detected
obj.warnings = String[] ...
// array of all warnings detected
DETAILS
This structure defines the "schema" for the XML output.
struct Main.Target |
 |
var obj = new Main.Target;
obj.name = String ...
// target name
obj.keys.key = String ...
// target compatibility key used
obj.keys.packages = String[] ...
// all packages using target with this key
config Main.usage // module-wide |
 |
Usage message
Main.usage = String[] [
'[-[ax]] [-v] [-t target] [-e exclude_pattern] [-H header] [repository ...]'
];
Main.exec() // module-wide |
 |
xs script entry point
Main.exec(Any args) returns Any
DETAILS
This function is called from within other XDCscript scripts and
performs the same operations as
main() except that,
rather than output the return value of
inst.run(), this value
is simply returned to the caller of
exec().
Main.main() // module-wide |
 |
xs shell entry point
Main.main(Any args) returns Any
DETAILS
This function
- creates a no-arg instance, inst, of the module inheriting
this interface;
- parses command line arguments placing all options in the config
params of the inheriting module;
- creates a xdc.tools.Cmdr instance, cmdr;
- calls inst.run() with the cmdr and any command
line command line arguments not parsed as options; and
- outputs the return result from inst.run()
Instance Config Parameters |
 |
var params = new Main.Params;
// Instance config-params object
params.arrFlag = Bool false;
// Return an array of strings
params.exclude = String null;
// Exclude packages or targets from checks
params.header = String null;
// Prepend Header label to output
params.multipleFlag = Bool false;
// Allow checking multiple versions of the same package
params.target = String null;
// Target to check
params.verboseFlag = Bool false;
// Print informative messages during execution
params.xmlFlag = Bool false;
// Return a Results struct as XML
config Main.Params.arrFlag // instance |
 |
Return an array of strings
var params = new Main.Params;
...
params.arrFlag = Bool false;
config Main.Params.exclude // instance |
 |
Exclude packages or targets from checks
var params = new Main.Params;
...
params.exclude = String null;
DETAILS
Do not check compatibility of packages or targets whose names match
the regular expression exclude.
config Main.Params.header // instance |
 |
Prepend Header label to output
var params = new Main.Params;
...
params.header = String null;
config Main.Params.multipleFlag // instance |
 |
Allow checking multiple versions of the same package
var params = new Main.Params;
...
params.multipleFlag = Bool false;
DETAILS
By default, when a package appears in more than repository named on
the command line, this tool only checks the first occurance
of the package. Setting this option forces all versions of all
packages in the specified repositories to be included in the checks.
config Main.Params.target // instance |
 |
Target to check
var params = new Main.Params;
...
params.target = String null;
DETAILS
During the compatibility checks this tool ensures that for all
targets used by all packages are compatible with the latest target
referenced by any package. If this option is set, the check tool
will only validate compatibility for the specified target. In
addition, if the target string contains a target compatibility key,
all packages that reference the target will be checked for
compatibility with the specified key.
The format of this string is either
<target_name>:<target_key>
or
where <target_name> is the full name of a target and <target_key>
is an optional target-specific compatibility key. The optional
target compatibility key can be used to validate the set of packages
against a specific compiler tool chain.
config Main.Params.verboseFlag // instance |
 |
Print informative messages during execution
var params = new Main.Params;
...
params.verboseFlag = Bool false;
config Main.Params.xmlFlag // instance |
 |
Return a Results struct as XML
var params = new Main.Params;
...
params.xmlFlag = Bool false;
Main.run() // instance |
 |
Underlying implementation of the command
DETAILS
Since this method is used to support both command line tools and
other XDCscript scripts, it is important to avoid explicit
termination of the JVM via java.lang.System.exit(); doing so
precludes callers from handling failures.
Implementations should instead call