Skip to main content

cdlPackage object

note

DEPRECATED!

Purpose​

Define a package (a specialized project that can be distributed independently).

Syntax​

{
  "cdlPackage": {
    "display": "<short name>",
    "description": "<long text>",

    ... package members ...
  }
}

Description​

The cdlPackage object is the unit of software distribution. It is a container of a hierarchy of components and options.

The project top-level xCDL file must begin with a cdlPackage object.

Containers​

The cdlPackage is inherently a container, so it may include cdlComponents, cdlOptions, and cdlInterfaces objects.

The cdlPackage object itself does not have a name and does not contribute to the configuration hierarchy.

Properties​

  • description - provides a reasonably long paragraph with a textual description for the package
  • display - provides a node name for the package when rendered in the configuration hierarchy

Example​

{
  "cdlPackage": {
    "display": "µOS++ Utils Lists",
    "cdlComponents": [
      {
        "name": "micro-os-plus.utils-lists",
        "description": "µOS++ C++ Intrusive Lists.",
        "publicIncludeFolders": [
          "include"
        ],
        "sourceFiles": [
          "src/doubly-list-links.cpp"
        ],
        "dependencies": [
          "micro-os-plus.diag.trace"
        ],
        "customDefine": "MICRO_OS_PLUS_INCLUDES_UTILS_LISTS",
        ...
      }
    ]
  }
}

See also​

eCos reference​