ref-manual: Add documentation for INCOMPATIBLE_LICENSE_EXCEPTIONS

Message ID 20220625161346.31894-1-pkj@axis.com
State New
Headers show
Series ref-manual: Add documentation for INCOMPATIBLE_LICENSE_EXCEPTIONS | expand

Commit Message

Peter Kjellerstedt June 25, 2022, 4:13 p.m. UTC
Signed-off-by: Peter Kjellerstedt <peter.kjellerstedt@axis.com>
---
 documentation/migration-guides/migration-4.0.rst | 2 +-
 documentation/ref-manual/variables.rst           | 8 ++++++++
 2 files changed, 9 insertions(+), 1 deletion(-)

Comments

Michael Opdenacker June 27, 2022, 10:16 a.m. UTC | #1
Hi Peter,

On 6/25/22 18:13, Peter Kjellerstedt wrote:
> Signed-off-by: Peter Kjellerstedt <peter.kjellerstedt@axis.com>
> ---
>   documentation/migration-guides/migration-4.0.rst | 2 +-
>   documentation/ref-manual/variables.rst           | 8 ++++++++
>   2 files changed, 9 insertions(+), 1 deletion(-)
>
> diff --git a/documentation/migration-guides/migration-4.0.rst b/documentation/migration-guides/migration-4.0.rst
> index a8e6b4c331..79e53f89ac 100644
> --- a/documentation/migration-guides/migration-4.0.rst
> +++ b/documentation/migration-guides/migration-4.0.rst
> @@ -45,7 +45,7 @@ The following variables have changed their names:
>   - ``SSTATE_DUPWHITELIST`` became ``SSTATE_ALLOW_OVERLAP_FILES``
>   - ``SYSROOT_DIRS_BLACKLIST`` became :term:`SYSROOT_DIRS_IGNORE`
>   - ``UNKNOWN_CONFIGURE_WHITELIST`` became :term:`UNKNOWN_CONFIGURE_OPT_IGNORE`
> -- ``WHITELIST_<license>`` became ``INCOMPATIBLE_LICENSE_EXCEPTIONS``
> +- ``WHITELIST_<license>`` became :term:`INCOMPATIBLE_LICENSE_EXCEPTIONS`
>   
>   In addition, ``BB_STAMP_WHITELIST``, ``BB_STAMP_POLICY``, ``INHERIT_BLACKLIST``,
>   ``TUNEABI``, ``TUNEABI_WHITELIST``, and ``TUNEABI_OVERRIDE`` have been removed.
> diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst
> index 28267101d8..e471d4fe12 100644
> --- a/documentation/ref-manual/variables.rst
> +++ b/documentation/ref-manual/variables.rst
> @@ -3544,6 +3544,14 @@ system and gives an overview of their function and contents.
>            remove dependencies on or provide alternatives to components that
>            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::
> +
> +         INCOMPATIBLE_LICENSE_EXCEPTIONS = "gdbserver:GPL-3.0-only gdbserver:LGPL-3.0-only"
> +
>      :term:`INHERIT`
>         Causes the named class or classes to be inherited globally. Anonymous
>         functions in the class or classes are not executed for the base


Many thanks for the patch. Good catch!
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
... and merged into master-next for inclusion in master soon.

Thanks again!
Michael.

Patch

diff --git a/documentation/migration-guides/migration-4.0.rst b/documentation/migration-guides/migration-4.0.rst
index a8e6b4c331..79e53f89ac 100644
--- a/documentation/migration-guides/migration-4.0.rst
+++ b/documentation/migration-guides/migration-4.0.rst
@@ -45,7 +45,7 @@  The following variables have changed their names:
 - ``SSTATE_DUPWHITELIST`` became ``SSTATE_ALLOW_OVERLAP_FILES``
 - ``SYSROOT_DIRS_BLACKLIST`` became :term:`SYSROOT_DIRS_IGNORE`
 - ``UNKNOWN_CONFIGURE_WHITELIST`` became :term:`UNKNOWN_CONFIGURE_OPT_IGNORE`
-- ``WHITELIST_<license>`` became ``INCOMPATIBLE_LICENSE_EXCEPTIONS``
+- ``WHITELIST_<license>`` became :term:`INCOMPATIBLE_LICENSE_EXCEPTIONS`
 
 In addition, ``BB_STAMP_WHITELIST``, ``BB_STAMP_POLICY``, ``INHERIT_BLACKLIST``,
 ``TUNEABI``, ``TUNEABI_WHITELIST``, and ``TUNEABI_OVERRIDE`` have been removed.
diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst
index 28267101d8..e471d4fe12 100644
--- a/documentation/ref-manual/variables.rst
+++ b/documentation/ref-manual/variables.rst
@@ -3544,6 +3544,14 @@  system and gives an overview of their function and contents.
          remove dependencies on or provide alternatives to components that
          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::
+
+         INCOMPATIBLE_LICENSE_EXCEPTIONS = "gdbserver:GPL-3.0-only gdbserver:LGPL-3.0-only"
+
    :term:`INHERIT`
       Causes the named class or classes to be inherited globally. Anonymous
       functions in the class or classes are not executed for the base