Skip to content

Commit 7c03250

Browse files
committed
docs: Improve description of overrides nodes
We no longer limit them to lock file usage, though care as to be taken when combining manually set ones with those. Furthermore add descriptions for the recently added URL property. Signed-off-by: Jan Kiszka <jan.kiszka@siemens.com>
1 parent 567950b commit 7c03250

2 files changed

Lines changed: 16 additions & 7 deletions

File tree

docs/userguide/project-configuration.rst

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -406,14 +406,19 @@ Configuration reference
406406
:kasschemadesc:`overrides`
407407

408408
``repos``: dict [optional]
409-
Maps to the top-level ``repos`` entry.
409+
:kasschemadesc:`overrides.properties.repos`
410410

411411
``<repo-id>``: dict [optional]
412-
Maps to the ``<repo-id>`` entry.
412+
:kasschemadesc:`overrides.properties.repos.additionalProperties.anyOf[0]`
413413

414-
``commit``: string [optional]
415-
Pinned commit ID which overrides the ``commit`` of the corresponding
416-
repo.
414+
``branch``: string [optional]
415+
:kasschemadesc:`overrides.properties.repos.additionalProperties.anyOf[0].properties.branch`
416+
417+
``commit``: string [optional]
418+
:kasschemadesc:`overrides.properties.repos.additionalProperties.anyOf[0].properties.commit`
419+
420+
``url``: string [optional]
421+
:kasschemadesc:`overrides.properties.repos.additionalProperties.anyOf[0].properties.url`
417422

418423
``bblayers_conf_header``: dict [optional]
419424
:kasschemadesc:`bblayers_conf_header`

kas/schema-kas.json

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -126,24 +126,28 @@
126126
}
127127
},
128128
"overrides": {
129-
"description": "Overrides for specific configuration nodes. By that, only items that already exist are overridden. Note, that all entries below this key are reserved for auto-generation using kas plugins. Do not manually add entries.",
129+
"description": "Overrides for specific configuration nodes. By that, only items that already exist are overridden. Note that the lock plugin uses overrides to manage pinning of commits. Manually added overrides can interfere with lock file generated by the plugin.",
130130
"type": "object",
131131
"additionalProperties": false,
132132
"properties": {
133133
"repos": {
134+
"description": "Maps to the top-level ``repos`` entry.",
134135
"type": "object",
135136
"additionalProperties": {
137+
"description",: "Maps to the ``<repo-id>`` entry.",
136138
"type": "object",
137139
"additionalProperties": false,
138140
"properties": {
139141
"branch": {
140-
"description": "Branch in which to find the overridden commit, can be Null",
142+
"description": "Branch in which to find the overridden commit. Can be Null.",
141143
"type": ["string", "null"]
142144
},
143145
"commit": {
146+
"description": "Pinned commit ID which overrides the ``commit`` of the corresponding repo. Can be Null.",
144147
"type": ["string", "null"]
145148
},
146149
"url": {
150+
"description": "Alternative URL for the corresponding repo.",
147151
"type": "string"
148152
}
149153
}

0 commit comments

Comments
 (0)