You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Following can be improved in the documenation of cmsis-toolbox .yml files, to make them better aligned with the json schema files:
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).
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" }
generator in schema (GeneratorType) lists the following items as mandatory, but documentation has them as optional:
"required": [ "generator", "path", "gpdsc", "command" ]
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?
The text was updated successfully, but these errors were encountered:
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.
Following can be improved in the documenation of cmsis-toolbox .yml files, to make them better aligned with the json schema files:
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).
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" }
generator in schema (GeneratorType) lists the following items as mandatory, but documentation has them as optional:
"required": [ "generator", "path", "gpdsc", "command" ]
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?
The text was updated successfully, but these errors were encountered: