summaryrefslogtreecommitdiffstats
path: root/documentation/ref-manual/variables.rst
diff options
context:
space:
mode:
Diffstat (limited to 'documentation/ref-manual/variables.rst')
-rw-r--r--documentation/ref-manual/variables.rst17
1 files changed, 17 insertions, 0 deletions
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