[PATCH] docs: Improve description of overrides nodes

[Jan Kiszka]

From: Jan Kiszka <jan.k...@siemens.com>

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.k...@siemens.com>
---
docs/userguide/project-configuration.rst | 15 ++++++++++-----
kas/schema-kas.json | 8 ++++++--
2 files changed, 16 insertions(+), 7 deletions(-)

diff --git a/docs/userguide/project-configuration.rst b/docs/userguide/project-configuration.rst
index 989f4a4..13cb0ef 100644
--- a/docs/userguide/project-configuration.rst
+++ b/docs/userguide/project-configuration.rst
@@ -406,14 +406,19 @@ Configuration reference
:kasschemadesc:`overrides`

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

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

- ``commit``: string [optional]
- Pinned commit ID which overrides the ``commit`` of the corresponding
- repo.
+ ``branch``: string [optional]
+ :kasschemadesc:`overrides.properties.repos.additionalProperties.properties.branch`
+
+ ``commit``: string [optional]
+ :kasschemadesc:`overrides.properties.repos.additionalProperties.properties.commit`
+
+ ``url``: string [optional]
+ :kasschemadesc:`overrides.properties.repos.additionalProperties.properties.url`

``bblayers_conf_header``: dict [optional]
:kasschemadesc:`bblayers_conf_header`
diff --git a/kas/schema-kas.json b/kas/schema-kas.json
index a35e83b..489650b 100644
--- a/kas/schema-kas.json
+++ b/kas/schema-kas.json
@@ -126,24 +126,28 @@
}
},
"overrides": {
- "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.",
+ "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.",
"type": "object",
"additionalProperties": false,
"properties": {
"repos": {
+ "description": "Maps to the top-level ``repos`` entry.",
"type": "object",
"additionalProperties": {
+ "description": "Maps to the ``<repo-id>`` entry.",
"type": "object",
"additionalProperties": false,
"properties": {
"branch": {
- "description": "Branch in which to find the overridden commit, can be Null",
+ "description": "Branch in which to find the overridden commit. Can be Null.",
"type": ["string", "null"]
},
"commit": {
+ "description": "Pinned commit ID which overrides the ``commit`` of the corresponding repo. Can be Null.",
"type": ["string", "null"]
},
"url": {
+ "description": "Alternative URL for the corresponding repo.",
"type": "string"
}
}
--
2.47.3