Skip to content

[Doc]: documentation alignment with schema files #215

@vovamarch

Description

@vovamarch

Following can be improved in the documenation of cmsis-toolbox .yml files, to make them better aligned with the json schema files:

  1. Organize the description of sub-nodes alphabetically. IntelliSense lists them in this way, and it is easier to maintain (e.g. nodes target-types, solution, build-types).

  2. Schema file contains extra elements for the following nodes. It needs to be decided whether documentation shall reflect that, or schema file to be updated
    a) solution:
    "processor": { "$ref": "#/definitions/ProcessorType" },
    "optimize": { "$ref": "#/definitions/OptimizeType" },
    "debug": { "$ref": "#/definitions/DebugType" },
    "warnings": { "$ref": "#/definitions/WarningsType" },
    "define": { "$ref": "#/definitions/DefinesType" },
    "define-asm": { "$ref": "#/definitions/DefinesType" },
    "undefine": { "$ref": "#/definitions/UndefinesType" },
    "add-path": { "$ref": "#/definitions/AddpathsType" },
    "add-path-asm": { "$ref": "#/definitions/AddpathsType" },
    "del-path": { "$ref": "#/definitions/DelpathsType" },
    "misc": { "$ref": "#/definitions/MiscTypes" },
    "variables": { "$ref": "#/definitions/VariablesType" }
    b) output-dirs:
    "cprjdir": { "type": "string" }
    c**) build-types**
    "processor": { "$ref": "#/definitions/ProcessorType" },
    c) misc:
    "MiscType": {
    "Lib": { "$ref": "#/definitions/ArrayOfStrings", "description": "List of Library Manager or Archiver flags" }

  3. generator in schema (GeneratorType) lists the following items as mandatory, but documentation has them as optional:
    "required": [ "generator", "path", "gpdsc", "command" ]

  4. Documentation has single description for the nodes, while schema has several different types. For example PacksType and BuildPacksType , ExecuteTypes and BuildExecutesType. If there's no difference in documentation, shouldn't there be also no difference in schema, and so just one node schema could be used?

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentation

Projects

Status

Backlog

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions