summaryrefslogtreecommitdiffstats
path: root/documentation
diff options
context:
space:
mode:
Diffstat (limited to 'documentation')
-rw-r--r--documentation/dev-manual/licenses.rst7
-rw-r--r--documentation/migration-guides/release-notes-4.3.rst5
-rw-r--r--documentation/ref-manual/variables.rst17
3 files changed, 28 insertions, 1 deletions
diff --git a/documentation/dev-manual/licenses.rst b/documentation/dev-manual/licenses.rst
index 9629dc5329..e3f0aa9dc1 100644
--- a/documentation/dev-manual/licenses.rst
+++ b/documentation/dev-manual/licenses.rst
@@ -123,6 +123,13 @@ name and version (after variable expansion)::
123 123
124 LICENSE_FLAGS = "license_${PN}_${PV}" 124 LICENSE_FLAGS = "license_${PN}_${PV}"
125 125
126It is possible to give more details about a specific license
127using flags on the :term:`LICENSE_FLAGS_DETAILS` variable::
128
129 LICENSE_FLAGS_DETAILS[my-eula-license] = "For further details, see https://example.com/eula."
130
131If set, this will be displayed to the user if the license hasn't been accepted.
132
126In order for a component restricted by a 133In order for a component restricted by a
127:term:`LICENSE_FLAGS` definition to be enabled and included in an image, it 134:term:`LICENSE_FLAGS` definition to be enabled and included in an image, it
128needs to have a matching entry in the global 135needs to have a matching entry in the global
diff --git a/documentation/migration-guides/release-notes-4.3.rst b/documentation/migration-guides/release-notes-4.3.rst
index c19cf6e4f9..87cd622743 100644
--- a/documentation/migration-guides/release-notes-4.3.rst
+++ b/documentation/migration-guides/release-notes-4.3.rst
@@ -10,6 +10,8 @@ New Features / Enhancements in 4.3
10 10
11- New variables: 11- New variables:
12 12
13 - :term:`FILE_LAYERNAME`: bitbake now sets this to the name of the layer containing the recipe
14
13 - :term:`FIT_ADDRESS_CELLS` and :term:`UBOOT_FIT_ADDRESS_CELLS`. 15 - :term:`FIT_ADDRESS_CELLS` and :term:`UBOOT_FIT_ADDRESS_CELLS`.
14 See details below. 16 See details below.
15 17
@@ -17,7 +19,8 @@ New Features / Enhancements in 4.3
17 19
18 - :term:`KERNEL_DTBVENDORED`: whether to keep vendor subdirectories. 20 - :term:`KERNEL_DTBVENDORED`: whether to keep vendor subdirectories.
19 21
20 - :term:`FILE_LAYERNAME`: bitbake now sets this to the name of the layer containing the recipe 22 - :term:`LICENSE_FLAGS_DETAILS`: add extra details about a recipe license
23 in case it is not allowed by :term:`LICENSE_FLAGS_ACCEPTED`.
21 24
22- Layername functionality available through overrides 25- Layername functionality available through overrides
23 26
diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst
index 7a71abc0ae..11523bb9e7 100644
--- a/documentation/ref-manual/variables.rst
+++ b/documentation/ref-manual/variables.rst
@@ -4968,6 +4968,23 @@ system and gives an overview of their function and contents.
4968 ":ref:`dev-manual/licenses:enabling commercially licensed recipes`" 4968 ":ref:`dev-manual/licenses:enabling commercially licensed recipes`"
4969 section in the Yocto Project Development Tasks Manual. 4969 section in the Yocto Project Development Tasks Manual.
4970 4970
4971 :term:`LICENSE_FLAGS_DETAILS`
4972 Adds details about a flag in :term:`LICENSE_FLAGS`. This way,
4973 if such a flag is not accepted through :term:`LICENSE_FLAGS_ACCEPTED`,
4974 the error message will be more informative, containing the specified
4975 extra details.
4976
4977 For example, a recipe with an EULA may set::
4978
4979 LICENSE_FLAGS = "FooBar-EULA"
4980 LICENSE_FLAGS_DETAILS[FooBar-EULA] = "For further details, see https://example.com/eula."
4981
4982 If ``Foobar-EULA`` isn't in :term:`LICENSE_FLAGS_ACCEPTED`, the
4983 error message is more useful::
4984
4985 Has a restricted license 'FooBar-EULA' which is not listed in your LICENSE_FLAGS_ACCEPTED.
4986 For further details, see https://example.com/eula.
4987
4971 :term:`LICENSE_PATH` 4988 :term:`LICENSE_PATH`
4972 Path to additional licenses used during the build. By default, the 4989 Path to additional licenses used during the build. By default, the
4973 OpenEmbedded build system uses :term:`COMMON_LICENSE_DIR` to define the 4990 OpenEmbedded build system uses :term:`COMMON_LICENSE_DIR` to define the