Skip to main content

The generatedFile definition

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": {
        ...
        "generatedFile": "<file path>",
        ...
    }
}

The value of the generatedFile 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, first the childrenGeneratedFile, then the generatedFile.

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.

If multiple nodes use the same file, it is recommended to define the file only once, in the parent node, using childrenGeneratedFile.

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

Example​

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

eCos reference​