From 6a9aeee08e2f3123383c10850052806031667afb Mon Sep 17 00:00:00 2001 From: Daiane Angolini Date: Thu, 31 Aug 2023 18:00:37 -0300 Subject: [PATCH] rm: factory definition: Describe a list of variables Signed-off-by: Daiane Angolini --- .../factory/factory-definition.rst | 36 +++++++++++++++++++ .../linux/linux-oss-compliance.rst | 2 ++ 2 files changed, 38 insertions(+) diff --git a/source/reference-manual/factory/factory-definition.rst b/source/reference-manual/factory/factory-definition.rst index 91d299a09..0d0182638 100644 --- a/source/reference-manual/factory/factory-definition.rst +++ b/source/reference-manual/factory/factory-definition.rst @@ -12,6 +12,8 @@ repository in the **factory-config.yml** file. notify ------ +Configures the users who receive an email with the build notification. + .. sidebar:: ``notify:`` Section Example .. code-block:: yaml @@ -50,6 +52,9 @@ notify: lmp --- +Configures the LmP aspects to this factory, including images, distro and machine names. +Variables to be used with the metadata and artifacts. + .. sidebar:: ``lmp:`` Section Example .. code-block:: yaml @@ -169,11 +174,42 @@ lmp: **Default:** ``mfgtool-files`` |br| (from `meta-lmp-base/recipes-support/mfgtool-files/mfgtool-files_0.1.bb `_) +Variables +^^^^^^^^^ + +* **DEV_MODE**: + This is a flexible variable used to configure the source code + into development mode. The development mode should be defined + by the user. Reference: :ref:`ref-dev-mode`. +* **BUILD_SDK**: + With this variable set to ``1`` the SDK artifact will be part + of the build. Reference: :ref:`ref-building-sdk`. +* **DISABLE_GPLV3**: + When set to ``1``, this variable configures the source code + to avoid the LmP default packages under GPLv3. + Reference: :ref:`ref-remove-gplv3`. +* **ENABLE_PTEST**: + When set to ``1`` this variable creates an artifact based on the + image being built with the pattern ``
-ptest``. This + image includes the available Ptest for each installed package. +* **DISTRO**: + Define the distro being used. Reference :ref:`ref-linux-distro`. +* **TUF_TARGETS_EXPIRE**: + Is used to change the default target expiration date (default 1y). +* **SSTATE_CACHE_MIRROR**: + It defaults to the directory mounted on the SDK build container + and if this directory exists it is used as the source for the + shared state cache (sstate-cache) mirror. When the directory does + not exist the ``lmp-manifest`` value is used and should point to + the public HTTP shared state cache. + .. _def-containers: containers ---------- +Define the container's configuration, including some image configuration and target architecture. + .. sidebar:: ``containers:`` Section Example .. code-block:: yaml diff --git a/source/reference-manual/linux/linux-oss-compliance.rst b/source/reference-manual/linux/linux-oss-compliance.rst index 7b975de5d..215d57602 100644 --- a/source/reference-manual/linux/linux-oss-compliance.rst +++ b/source/reference-manual/linux/linux-oss-compliance.rst @@ -144,6 +144,8 @@ This error means, for image `lmp-factory-image`, a long list of packages under GPLv3 are being installed, for example ``bash``. The goal now to clear the image from those dependencies. +.. _ref-remove-gplv3: + How to remove packages under GPLv3 family license -------------------------------------------------