Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Doc]: documentation alignment with schema files #215

Open
vovamarch opened this issue Nov 25, 2024 · 0 comments
Open

[Doc]: documentation alignment with schema files #215

vovamarch opened this issue Nov 25, 2024 · 0 comments
Assignees
Labels
enhancement New feature or request

Comments

@vovamarch
Copy link

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?

@jkrech jkrech added the enhancement New feature or request label Nov 26, 2024
@jkrech jkrech moved this to Backlog in CMSIS-Toolbox 2.7.0 Nov 26, 2024
@jkrech jkrech moved this to Todo in CMSIS-Toolbox 2.8.0 Dec 5, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
Development

No branches or pull requests

3 participants