From 1f819ee08a8596fe8e7063f2aa20800718be3f1a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lubom=C3=ADr=20Sedl=C3=A1=C5=99?= Date: Fri, 1 Mar 2024 14:45:23 +0100 Subject: [PATCH] kiwibuild: Update documentation with more details MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Lubomír Sedlář --- doc/configuration.rst | 21 ++++++++++++--------- 1 file changed, 12 insertions(+), 9 deletions(-) diff --git a/doc/configuration.rst b/doc/configuration.rst index 2a23453b..54708c80 100644 --- a/doc/configuration.rst +++ b/doc/configuration.rst @@ -1616,20 +1616,23 @@ KiwiBuild Settings Required keys in the configuration dict: - * ``target`` -- (*str*) which build target to use for the task. * ``description_scm`` -- (*str*) scm URL of description kiwi description. - * ``description_path`` -- (*str*) path to kiwi description + * ``description_path`` -- (*str*) path to kiwi description inside the scm repo * ``kiwi_profile`` -- (*str*) select profile from description file. - * ``release`` -- (*str*) release of the output image. - * ``arches`` -- (*[str]*) List of architectures. - * ``repos`` -- a list of repositories from which to consume packages for - building the image. By default only the variant repository is used. - * ``failable`` -- (*[str]*) List of architectures for which this - deliverable is not release blocking. Optional keys: - * ``repos`` -- the repos used to install RPMs in the image. + * ``repos`` -- additional repos used to install RPMs in the image. The + compose repository for the enclosing variant is added automatically. + Either variant name or a URL is supported. + * ``target`` -- (*str*) which build target to use for the task. If not + provided, then either ``kiwibuild_target`` or ``global_target`` is + needed. + * ``release`` -- (*str*) release of the output image. + * ``arches`` -- (*[str]*) List of architectures to build for. If not + provided, all variant architectures will be built. + * ``failable`` -- (*[str]*) List of architectures for which this + deliverable is not release blocking. OSBuild Composer for building images