From: Joshua Watt <jpewhacker@gmail.com>
To: docs@lists.yoctoproject.org
Cc: Joshua Watt <JPEWhacker@gmail.com>
Subject: [docs][PATCH] variables: Update variable documentation for SPDX license expressions
Date: Wed, 22 Jul 2026 12:48:53 -0600 [thread overview]
Message-ID: <20260722184853.188733-1-JPEWhacker@gmail.com> (raw)
Updates the documentation for the variables affected by the transition
to using SPDX license expressions
Signed-off-by: Joshua Watt <JPEWhacker@gmail.com>
---
documentation/ref-manual/variables.rst | 46 ++++++++++++++------------
1 file changed, 24 insertions(+), 22 deletions(-)
diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst
index 394797ca3..599ef6f2e 100644
--- a/documentation/ref-manual/variables.rst
+++ b/documentation/ref-manual/variables.rst
@@ -4806,6 +4806,12 @@ system and gives an overview of their function and contents.
- ``GPL-3.0*``: ``GPL-3.0-only``, ``GPL-3.0-or-later``
- ``LGPL-3.0*``: ``LGPL-3.0-only``, ``LGPL-3.0-or-later``
+ If a license in :term:`LICENSE` has an exception listed using the
+ ``WITH`` operator, the license will still match this variable and the
+ license will not be allowed. To explicitly allow an SPDX license
+ exception to a license, the exception must be listed in
+ :term:`INCOMPATIBLE_LICENSE_EXCEPTIONS`
+
.. note::
This functionality is only regularly tested using the following
@@ -4819,12 +4825,12 @@ system and gives an overview of their function and contents.
are required to produce a functional system image.
:term:`INCOMPATIBLE_LICENSE_EXCEPTIONS`
- Specifies a space-separated list of package and license pairs that
- are allowed to be used even if the license is specified in
- :term:`INCOMPATIBLE_LICENSE`. The package and license pairs are
- separated using a colon. Example::
+ Specifies a space-separated list of package and SPDX license or SPDX
+ license exception pairs that are allowed to be used even if the license
+ is specified in :term:`INCOMPATIBLE_LICENSE`. The package and license
+ pairs are separated using a colon. Example::
- INCOMPATIBLE_LICENSE_EXCEPTIONS = "gdbserver:GPL-3.0-only gdbserver:LGPL-3.0-only"
+ INCOMPATIBLE_LICENSE_EXCEPTIONS = "gdbserver:GPL-3.0-only gdbserver:LGPL-3.0-only gdbserver:GCC-exception-3.1"
:term:`INHERIT`
Causes the named class or classes to be inherited globally. Anonymous
@@ -5945,27 +5951,24 @@ system and gives an overview of their function and contents.
:term:`LICENSE`
This is a required field in an OpenEmbedded recipe file, and should
- contain a list of source licenses for the recipe. Follow these rules:
-
- - Do not use spaces within individual license names.
+ contain a :term:`SPDX License Expression` that describes the source
+ license(s) for the recipe. Keep in mind a few rules:
- - Separate license names using \| (pipe) when there is a choice
- between licenses.
+ - Separate license name using ``OR`` when there is a choice between
+ licenses
- - Separate license names using & (ampersand) when there are
- multiple licenses for different parts of the source.
+ - Separate license names using ``AND`` when multiple licenses apply to
+ different parts of the source code
- - You can use spaces between license names.
+ - All licenses must be valid SPDX License Identifiers
- - For standard licenses, use the names of the files in
- ``meta/files/common-licenses/`` or the
- :term:`SPDXLICENSEMAP` flag names defined in
- ``meta/conf/licenses.conf``.
+ - Any License that does not come from the SPDX License list
+ must be prefixed with ``LicenseRef-``.
Here are some examples::
- LICENSE = "LGPL-2.1-only | GPL-3.0-only"
- LICENSE = "MPL-1.0 & LGPL-2.1-only"
+ LICENSE = "LGPL-2.1-only OR GPL-3.0-only"
+ LICENSE = "MPL-1.0 AND LGPL-2.1-only"
LICENSE = "GPL-2.0-or-later"
The first example is from the
@@ -5981,15 +5984,14 @@ system and gives an overview of their function and contents.
but has accompanying documentation licensed under the GNU Free
Documentation License 1.2 could be specified as follows::
- LICENSE = "GFDL-1.2 & GPL-2.0-only"
+ LICENSE = "GFDL-1.2 AND GPL-2.0-only"
LICENSE:${PN} = "GPL-2.0.only"
LICENSE:${PN}-doc = "GFDL-1.2"
.. note::
A recipe's :term:`LICENSE` value must be accompanied by an associated
- :term:`LIC_FILES_CHKSUM` value, except in the special case where
- the :term:`LICENSE` value is set to "CLOSED".
+ :term:`LIC_FILES_CHKSUM` value.
:term:`LICENSE_CREATE_PACKAGE`
Setting :term:`LICENSE_CREATE_PACKAGE` to "1" causes the OpenEmbedded
--
2.54.0
next reply other threads:[~2026-07-22 18:49 UTC|newest]
Thread overview: 2+ messages / expand[flat|nested] mbox.gz Atom feed top
2026-07-22 18:48 Joshua Watt [this message]
2026-07-23 8:31 ` [docs][PATCH] variables: Update variable documentation for SPDX license expressions Antonin Godard
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20260722184853.188733-1-JPEWhacker@gmail.com \
--to=jpewhacker@gmail.com \
--cc=docs@lists.yoctoproject.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox