From 50b217145c9cb5d480dd29ae72ffb73f81a8f993 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lubom=C3=ADr=20Sedl=C3=A1=C5=99?= Date: Wed, 13 Mar 2024 12:39:08 +0100 Subject: [PATCH] Update docs with kiwibuild options MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Lubomír Sedlář (cherry picked from commit 04d4e1d5850ebff1880bfa01078813d265785174) --- doc/configuration.rst | 15 +++++++++++++-- 1 file changed, 13 insertions(+), 2 deletions(-) diff --git a/doc/configuration.rst b/doc/configuration.rst index fba4ab2e..7325e8c9 100644 --- a/doc/configuration.rst +++ b/doc/configuration.rst @@ -1616,12 +1616,17 @@ KiwiBuild Settings Required keys in the configuration dict: - * ``description_scm`` -- (*str*) scm URL of description kiwi description. - * ``description_path`` -- (*str*) path to kiwi description inside the scm repo * ``kiwi_profile`` -- (*str*) select profile from description file. + Description scm, description path and target have to be provided too, but + instead of specifying them for each image separately, you can use the + ``kiwibuild_*`` options or ``global_target``. + Optional keys: + * ``description_scm`` -- (*str*) scm URL of description kiwi description. + * ``description_path`` -- (*str*) path to kiwi description inside the scm + repo. * ``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. @@ -1634,6 +1639,12 @@ KiwiBuild Settings * ``failable`` -- (*[str]*) List of architectures for which this deliverable is not release blocking. +**kiwibuild_description_scm** + (*str*) -- URL for scm containing the description files + +**kiwibuild_description_path** + (*str*) -- path to a description file within the description scm + OSBuild Composer for building images ====================================