Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion source/reference-manual/linux/linux-lmp-fs.rst
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ Important Files and Folders

``/var/sota/sota.toml``: Stores relevant OTA information, like Tag, Apps, custom configurations, certificates location and server address.

``/var/sota/reset-apps``: Holds preloaded apps if :ref:`ug-restorable-apps` are used (default since LmP **v85**).
``/var/sota/reset-apps``: Holds preloaded apps if :ref:`ug-restorable-apps` are used (default).

``/var/sota/compose-apps``: Apps are extracted to this location during app loading.
It holds preloaded apps if Compose Apps are used.
Expand Down
21 changes: 6 additions & 15 deletions source/reference-manual/linux/linux-oss-compliance.rst
Original file line number Diff line number Diff line change
Expand Up @@ -48,17 +48,17 @@

.. warning:: There are other examples of why a license should be avoided or chosen. Advice from a lawyer is recommended.

.. note:: Another option to meet the GPLv3 requirement when using hardware configured with secure boot,
.. note::
Another option to meet the GPLv3 requirement when using hardware configured with secure boot,

Check warning on line 52 in source/reference-manual/linux/linux-oss-compliance.rst

View workflow job for this annotation

GitHub Actions / runner / vale

[vale] reported by reviewdog 🐶 [Fio-docs.sentence-length] Aim for sentences no longer than 25 words Raw Output: {"message": "[Fio-docs.sentence-length] Aim for sentences no longer than 25 words", "location": {"path": "source/reference-manual/linux/linux-oss-compliance.rst", "range": {"start": {"line": 52, "column": 4}}}, "severity": "INFO"}
is providing either a way of disabling secure boot or the keys when requested.

When using LmP there are two variables that can be used for blocking licenses, ``INCOMPATIBLE_LICENSE`` and ``IMAGE_LICENSE_CHECKER_ROOTFS_DENYLIST`` [1]_.
When using LmP there are two variables that can be used for blocking licenses, ``INCOMPATIBLE_LICENSE`` and ``IMAGE_LICENSE_CHECKER_ROOTFS_DENYLIST``
Both of these variables list the licenses by SPDX identifier.

INCOMPATIBLE_LICENSE
""""""""""""""""""""

Add to the ``build/conf/local.conf`` or to the distro the following line [2]_:

Add to the ``build/conf/local.conf`` or to the distro the following line:
.. code-block:: none

INCOMPATIBLE_LICENSE = "GPL-3.0* LGPL-3.0* AGPL-3.0*"
Expand Down Expand Up @@ -90,8 +90,7 @@

This class can be reviewed at `image-license-checker`_.

Add to the LmP Factory customization file ``meta-subscriber-overrides/conf/machine/include/lmp-factory-custom.inc`` the lines from `ci-scripts` [3]_.

Add to the LmP Factory customization file ``meta-subscriber-overrides/conf/machine/include/lmp-factory-custom.inc`` the lines from ``ci-scripts`` [1]_..
Using this configuration to build ``lmp-factory-image`` results in the following error:

.. code-block:: console
Expand Down Expand Up @@ -142,15 +141,7 @@

.. _image-license-checker: https://github.com/foundriesio/meta-lmp/blob/main/meta-lmp-base/classes/image-license-checker.bbclass


.. rubric:: Footnotes

.. [1] Since **v87**,
the variable ``IMAGE_LICENSE_CHECKER_ROOTFS_DENYLIST``
replaces
``IMAGE_LICENSE_CHECKER_ROOTFS_BLACKLIST``.
.. [2] Since **v87**,
the contents of ``INCOMPATIBLE_LICENSE`` has changed,
as a consequence of the Kirkstone SPDX tags change.
.. [3] The list of license strings follows the SPDX standard and may vary.
.. [1] The list of license strings follows the SPDX standard and may vary.
Consult the up-to-date code https://github.com/foundriesio/ci-scripts/blob/master/lmp/bb-config.sh#L189-L192.
2 changes: 1 addition & 1 deletion source/reference-manual/linux/toolchain.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Toolchain

The default toolchain used in ``openembedded-core`` is ``gcc``, but this is configurable.
The ``clang`` toolchain is provided by ``meta-clang``, and can be set globally or per recipe.
Since version **v89**, the LmP uses ``clang`` as the default compiler, and ``llvm`` as the default runtime.
The LmP uses ``clang`` as the default compiler, and ``llvm`` as the default runtime.

.. code-block::

Expand Down
2 changes: 0 additions & 2 deletions source/reference-manual/security/ff-security-summary.rst
Original file line number Diff line number Diff line change
Expand Up @@ -120,5 +120,3 @@ Additional information can be found in :ref:`ref-ota-security`.

.. note::
**(*)** Can be selected at Factory creation or changed later.

Factories created before **v89** use ``RSA 4096`` by default and can switch to use ``Ed25519``.
Original file line number Diff line number Diff line change
Expand Up @@ -54,10 +54,7 @@ making sure to set the appropriate values for ``app_type`` and ``oe_builtin`` (s
- ``shortlist``- Defines the list of apps to preload.
All the Target's apps are preloaded if not specified or empty.
Here, it is set to preload the ``shellhttpd`` app.
- ``app_type`` - Defines the type of Apps to preload.
If not defined, or set to an empty value, the ``app_type`` preload will depend on the LmP version.
If the LmP version is **v85** or newer, then `restorable` type is preloaded, otherwise `compose` type is used.
See :ref:`ug-restorable-apps`.
- ``app_type`` - Defines the type of Apps to preload: restorable (default) x compose
- ``oe_builtin`` - *Optional*: Preload Apps during an OE build CI run. Should be left disabled/undefined for most machines.

.. note::
Expand Down Expand Up @@ -108,7 +105,7 @@ Checking the Preloaded Image
Restorable Type
~~~~~~~~~~~~~~~

Restorable apps are enabled by default on LmP v85+.
Restorable apps are enabled by default.

On your device, switch to root and list the files in the folder ``/var/sota/reset-apps``.

Expand Down Expand Up @@ -141,7 +138,7 @@ Try to start the preloaded Restorable Apps manually using `aklite-apps`:
# aklite-apps run [--apps <a comma separated list of Apps>]

.. note::
``app_type`` is set to ``restorable`` by default since LmP **v85**.
``app_type`` is set to ``restorable`` by default.
If ``compose`` app type is set, then the preloaded apps are located under ``/var/sota/compose-apps/<app>``.
Here is an example using ``shellhttpd`` preloaded app:

Expand Down