Skip to main content

The minimumXcdlRequired definition

note

Work in progress.

Purpose​

Identify the minimum required xcdl version.

Syntax​

{
    "minimumXcdlRequired": "<semver>",
}

The value of the minimumXcdlRequired property is a string with a version in SemVer format.

Default value​

If missing, no checks are performed on the xcdl version.

Description​

This definition is a mechanism to identify the minimum required xcdl version necessary for correctly interpreting the current definitions in xcdl.json, thereby ensuring compatibility with future (potentially incompatible) xcdl versions.

The minimumXcdlRequired property has two primary purposes:

  • it prevents the use of an outdated xcdl with a newer xcdl.json
  • it allows a newer xcdl to revert some functionality to match the older minimum required xcdl.

The mechanism is similar to that used by CMake; the policies are documented on the separate Policies pages.

Example​

{
    "minimumXcdlRequired": "2.0.0",
    ...
}