variables: Update variable documentation for SPDX license expressions
PATCH 1/1 variables: Update variable documentation for SPDX license expressions
Updates the documentation for the variables affected by the transition to using SPDX license expressions
--- documentation/ref-manual/variables.rst | 46 ++++++++++++++------------ 1 file changed, 24 insertions(+), 22 deletions(-)
documentation/ref-manual/variables.rst +24 -22
@@ -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
Signature · 1 line
2.54.0
Hi,
Quoted 30 lines · Joshua Watt via lists.yoctoproject.org
Updates the documentation for the variables affected by the transition to using SPDX license expressions
Signed-off-by Joshua Watt <[email protected]>--- documentation/ref-manual/variables.rst | 46 ++++++++++++++------------ 1 file changed, 24 insertions(+), 22 deletions(-)documentation/ref-manual/variables.rst +6
-1@@ -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
documentation/ref-manual/variables.rst system and gives an overview of their function and contents. · line 4833
Quoted 10 lines
documentation/ref-manual/variables.rst +5
-4- 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"
I guess you meant "gcc:GCC-exception-3.1"?
Quoted 15 lines
documentation/ref-manual/variables.rst +2
-5: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.
documentation/ref-manual/variables.rst system and gives an overview of their function and contents. · line 5963
Quoted 10 lines
documentation/ref-manual/variables.rst +5
-3+ - 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
Add a quick link here?
SPDX License Identifiers <https://spdx.org/licenses/>__
documentation/ref-manual/variables.rst system and gives an overview of their function and contents. · line 5965
Quoted 6 lines
documentation/ref-manual/variables.rst +1
-4- - 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
Same link:
SPDX License List <https://spdx.org/licenses/>__
Quoted 19 lines
documentation/ref-manual/variables.rst +4
-3+ 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"
documentation/ref-manual/variables.rst system and gives an overview of their function and contents. · line 5997
Quoted 10 lines
documentation/ref-manual/variables.rst +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
Thanks!
Antonin
Antonin Godard
AppliedApplied, thanks!
[1/1] variables: Update variable documentation for SPDX license expressions
commit: e7dbd06e942c18054e4530f5fa1f175853f07382