Skip to main content

headerFile property

note

Work in progress.

Purpose​

Specify the configuration header file that will be generated for a given object, typically a cdlPackage or a cdlComponents object.

Syntax​

{
  "cdlPackage": {
    "display": "...",
    ...
    "headerFile": "<file path>",
    ...
  }
}

The value of the headerFile property is a string containing a file path relative to the build folder.

Default value​

If missing, the definition from the parent node is used. If none, the default is generated/include/xcdl-defines.h.

Description​

When the configuration tools generate a build tree, one of the steps is to output each object's configuration data to a header file. For example, the kernel's configuration data is output to generated/include/kernel-config.h. This allows each package's source code to #include the appropriate header file and adapt to the choices made by the user.

The name specified in a headerFile property will always be interpreted as relative to the build folder.

Example​

{
  "cdlPackage": {
    "name": "hal.arm",
    "display": "Arm architecture",
    "headerFile": "include/os/hal/hal-arm-generated.h"
  }
}

eCos reference​