From 0109686c8fca50bd94b5f46bc342c2e2d2e58c2d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marcus=20Sch=C3=A4fer?= Date: Fri, 20 Dec 2024 12:57:29 +0100 Subject: [PATCH] Fix documentation for repo, package gpg settings In contrast to the documentation, kiwi sets default values for any gpg setting if not explicitly specified differently. We want to avoid to inherit a behavior from how the distribution packages the package manager. This commit fixes the documentation to be in line with the implementation --- .../concept_and_workflow/repository_setup.rst | 12 +++++------ doc/source/image_description/elements.rst | 20 ++++++++++++------- kiwi/schema/kiwi.rnc | 13 ++++++------ kiwi/schema/kiwi.rng | 13 ++++++------ 4 files changed, 33 insertions(+), 25 deletions(-) diff --git a/doc/source/concept_and_workflow/repository_setup.rst b/doc/source/concept_and_workflow/repository_setup.rst index 4f6e61ce..88db2f10 100644 --- a/doc/source/concept_and_workflow/repository_setup.rst +++ b/doc/source/concept_and_workflow/repository_setup.rst @@ -58,13 +58,13 @@ following optional attributes: not specified, {kiwi} generates an alias name using hex representation from uuid4. -- `repository_gpgcheck`: Specifies whether the repository is - configured to perform repository signature validation. If not set, the - package manager's default is used. +- `repository_gpgcheck`: Specify whether or not this specific repository + values the result of the repository signature validation. + The default value is `false`. -- `package_gpgcheck`: Boolean value that specifies whether each package's - GPG signature is verified. If omitted, the package manager's default - is used. +- `package_gpgcheck`: Specify whether or not this specific repository + values the result of the package signature validation for each + package taken from this repository. The default value is `false`. - `components`: Distribution components used for `deb` repositories. Default is `main`. diff --git a/doc/source/image_description/elements.rst b/doc/source/image_description/elements.rst index 6f9fbe77..c41f7712 100644 --- a/doc/source/image_description/elements.rst +++ b/doc/source/image_description/elements.rst @@ -1413,13 +1413,19 @@ imageonly="true|false" the value is set to false repository_gpgcheck="true|false" - Specifies whether or not this specific repository is configured to - to run repository signature validation. If not set, no value is - appended into the repository configuration file. If set the - relevant key information needs to be provided on the {kiwi} - commandline using the `--signing-key` option or via the `` - element as part of the `` setting in the - image description. + Specifies whether or not this specific repository values the result + of the repository signature validation. If not set, the default is + `false`. If set the relevant key information needs to be provided + on the {kiwi} commandline using the `--signing-key` option or via + the `` element as part of the `` + setting in the image description. + +package_gpgcheck="true|false" + Specify whether or not this specific repository values the result + of the package signature validation for each package taken from + this repository. If not set, the default value is false. + If set, the same key information requirements as for the + `repository_gpgcheck` attribute applies. customize="/path/to/custom_script" Custom script hook which is invoked with the repo file as parameter diff --git a/kiwi/schema/kiwi.rnc b/kiwi/schema/kiwi.rnc index 9fcf4995..cfcb24df 100644 --- a/kiwi/schema/kiwi.rnc +++ b/kiwi/schema/kiwi.rnc @@ -1152,14 +1152,15 @@ div { ## or false, the default is false. attribute imageonly { xsd:boolean } k.repository.repository_gpgcheck.attribute = - ## Specify whether or not this specific repository is configured to - ## to run repository signature validation. If not set, no value is - ## appended into the repository configuration file. + ## Specify whether or not this specific repository values + ## the result of the repository signature validation. + ## The default value is false. attribute repository_gpgcheck { xsd:boolean } k.repository.package_gpgcheck.attribute = - ## Specify whether or not this specific repository is configured - ## to run package signature validation. If not set, no value is - ## appended into the repository configuration file. + ## Specify whether or not this specific repository + ## values the result of the package signature validation + ## for each package taken from this repository. The default + ## value is false. attribute package_gpgcheck { xsd:boolean } k.repository.customize.attribute = ## Specify the path to a customization script. diff --git a/kiwi/schema/kiwi.rng b/kiwi/schema/kiwi.rng index 60618cca..50202d58 100644 --- a/kiwi/schema/kiwi.rng +++ b/kiwi/schema/kiwi.rng @@ -1775,17 +1775,18 @@ or false, the default is false. - Specify whether or not this specific repository is configured to -to run repository signature validation. If not set, no value is -appended into the repository configuration file. + Specify whether or not this specific repository values +the result of the repository signature validation. +The default value is false. - Specify whether or not this specific repository is configured -to run package signature validation. If not set, no value is -appended into the repository configuration file. + Specify whether or not this specific repository +values the result of the package signature validation +for each package taken from this repository. The default +value is false.