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 · 2 comments
Open

[Doc]: documentation alignment with schema files #215

vovamarch opened this issue Nov 25, 2024 · 2 comments
Assignees
Labels
documentation Improvements or additions to documentation 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?

@soumeh01
Copy link
Collaborator

soumeh01 commented Feb 7, 2025

Point 1: The nodes are logically grouped rather than alphabetically arranged. There is no action required at this time.
Point 2 & 3. The differences between the documentation and the schema have been shared. The documentation needs to be updated accordingly. @ReinhardKeil took this action to update the documentation.
Point 4. Removing anything from the schema could introduce a breaking change and should therefore be addressed in version 3.0.0.

@soumeh01 soumeh01 added the documentation Improvements or additions to documentation label Feb 7, 2025
@soumeh01 soumeh01 assigned ReinhardKeil and unassigned soumeh01 Feb 7, 2025
@jkrech jkrech moved this to Backlog in CMSIS-Toolbox 2.9.0 Feb 26, 2025
@jkrech
Copy link
Member

jkrech commented Feb 26, 2025

Validate that the documentation has been aligned.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
Status: Backlog
Development

No branches or pull requests

4 participants