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

Improve context help for csolution project yml files #1811

Open
ReinhardKeil opened this issue Oct 16, 2024 · 0 comments
Open

Improve context help for csolution project yml files #1811

ReinhardKeil opened this issue Oct 16, 2024 · 0 comments
Labels
enhancement New feature or request

Comments

@ReinhardKeil
Copy link
Collaborator

The Problem To Be Solved

Links to documentation help; review the description text and add titles with documentation links.

This is an example:

image

Suggest A Solution

This can be achieved by adding title to the schema file and newline.

   "ComponentID": {
      "type": "string",
      "pattern": "(^[A-Za-z0-9][a-zA-Z0-9_\\+()'\\/\\- \\.]+$)|(^([A-Za-z0-9][A-Za-z0-9 \\-]+::)?([A-Za-z0-9][a-zA-Z0-9_\\+()'\\/\\- \\.]+)(&[A-Za-z0-9][a-zA-Z0-9_\\+()'\\/\\- \\.]+)?(:[A-Za-z0-9][a-zA-Z0-9_\\+()'\\/\\- \\.]+)(:[A-Za-z0-9][a-zA-Z0-9_\\+():\\/\\- \\.]*)?(&[A-Za-z0-9][a-zA-Z0-9_\\+()'\\/\\- \\.]+)?(@(>=)?((0|[1-9][0-9]*)\\.([0-9]+)(\\.([0-9]+))?(\\-((0|[1-9][0-9]*|[0-9]*[a-zA-Z-][0-9a-zA-Z-]*)(\\.(0|[1-9][0-9]*|[0-9]*[a-zA-Z-][0-9a-zA-Z-]*))*))?))?$)",
      "description": "Name of the software component\nFormat:  [Cvendor::] Cclass [&Cbundle] :Cgroup [:Csub] [&Cvariant] [@[>=]Cversion]"
    },
     "ComponentsType": {
      "type": "array",
      "title": "Software components from packs\nDocumentation: https://github.com/Open-CMSIS-Pack/cmsis-toolbox/blob/main/docs/YML-Input-Format.md#components",
      "description": "List of software components that are added from packs. Can be applied in *.cproject.yml and *.clayer.yml files.",

Attached are my trial schema files.
schema.zip

@ReinhardKeil ReinhardKeil added the enhancement New feature or request label Oct 16, 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
None yet
Development

No branches or pull requests

1 participant