module xdc.tools.check.Main

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.

This tool performs the following checks:

the latest version of each target used by any package is compatible with all other versions used; and
the "built-with" versions of all packages are compatible with the versions of the packages contained in the specified repositories

If no repositories are specified, the repositories named in the current package path are checked.

struct Main.Results

index URL

XML output format

XDCscript usage meta-domain

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

obj.targets = Main.Target[] ...

DETAILS

This structure defines the "schema" for the XML output.

struct Main.Target

index URL

XDCscript usage meta-domain

var obj = new Main.Target;

obj.name = String ...

// target name

obj.keys = Main.__struct__1[] ...

obj.keys.key = String ...

// target compatibility key used

obj.keys.packages = String[] ...

// all packages using target with this key

config Main.usage // module-wide

index URL

Usage message

XDCscript usage meta-domain

Main.usage = String[] [

'[-[ax]] [-v] [-t target] [-e exclude_pattern] [-H header] [repository ...]'

];

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.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.arrFlag // instance

index URL

Return an array of strings

XDCscript usage meta-domain

var params = new Main.Params;

...

params.arrFlag = Bool false;

config Main.exclude // instance

index URL

Exclude packages or targets from checks

XDCscript usage meta-domain

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.header // instance

index URL

Prepend Header label to output

XDCscript usage meta-domain

var params = new Main.Params;

...

params.header = String null;

config Main.multipleFlag // instance

index URL

Allow checking multiple versions of the same package

XDCscript usage meta-domain

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.target // instance

index URL

Target to check

XDCscript usage meta-domain

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>

      <target_name>

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.verboseFlag // instance

index URL

Print informative messages during execution

XDCscript usage meta-domain

var params = new Main.Params;

...

params.verboseFlag = Bool false;

config Main.xmlFlag // instance

index URL

Return a Results struct as XML

XDCscript usage meta-domain

var params = new Main.Params;