Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

rm: factory definition: Describe a list of variables #593

Merged
merged 1 commit into from
Sep 7, 2023
Merged

rm: factory definition: Describe a list of variables #593

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 32 additions & 0 deletions source/reference-manual/factory/factory-definition.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -169,11 +174,38 @@ lmp:

**Default:** ``mfgtool-files`` |br| (from `meta-lmp-base/recipes-support/mfgtool-files/mfgtool-files_0.1.bb <https://github.com/foundriesio/meta-lmp/blob/main/meta-lmp-base/recipes-support/mfgtool-files/mfgtool-files_0.1.bb>`_)

Variables
^^^^^^^^^

* **BUILD_SDK**:
With this variable set to ``1``, the SDK artifact will be part
of the build. Reference: :ref:`ref-building-sdk`.
* **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`.
* **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`.
* **DISTRO**:
Defines the distro being used. Reference: :ref:`ref-linux-distro`.
* **SSTATE_CACHE_MIRROR**:
Defaults to the directory mounted on the SDK build container.
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 (currently it points
to the public HTTP shared state cache).
* **TUF_TARGETS_EXPIRE**:
Is used to change the default target expiration date (default 1y).

.. _def-containers:

containers
----------

Defines the container's configuration, including some image configuration and target architecture.

.. sidebar:: ``containers:`` Section Example

.. code-block:: yaml
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@kprosise there is a "devel" in this code-block. I want to double check if it's intended. If it's not, I can remove it while on this PR

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You can if you want, or I can get to it when I do the cleanup of the reference manual.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I thought you had already cleaned those pages. I prefer to keep this for you, so. Thanks @kprosise

Expand Down
2 changes: 2 additions & 0 deletions source/reference-manual/linux/linux-oss-compliance.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
-------------------------------------------------

Expand Down