Skip to main content

The docsUrl definition

note

Work in progress.

Purpose​

Provide the location of online-documentation for a configuration object.

Syntax​

{
    "cdlOptions": {
        "<name>": {
            "docsUrl": "<string>",
            ...
        }
    }
}

The value of the docsUrl property is a string containing a properly formed URL.

Default value​

There is no default value, if missing, the configuration tool will not display any link.

Description​

When presented with a (graphical) user interface, users can only be expected to manipulate configuration options sensibly if they are given sufficient information about these options. There are three properties which serve to explain an object in plain text: the display property gives a textual alias for an object, which is usually more comprehensible than something like CYGPKG_LIBC_TIME_ZONES; the description property gives a longer description, typically a paragraph or so; the docsUrl property specifies the location of additional on-line documentation related to a configuration object.

The syntax is that of an absolute URL.

Example​

{
    "cdlPackages": {
        "kernel": {
            "display": "eCos kernel",
            "description": "This package contains the core functionality of the eCos kernel. It relies on functionality provided by various HAL packages and by the eCos infrastructure. In turn the eCos kernel provides support for other packages such as the device drivers and the uITRON compatibility layer.",
            "docsUrl": "https://ecos.sourceware.org/docs-latest/ref/kernel.html"
        }
    }
}

See also​

eCos reference​