diff --git a/documentation/dev-manual/dev-manual-common-tasks.xml b/documentation/dev-manual/dev-manual-common-tasks.xml index fe1bfba6cf..0cb967f053 100644 --- a/documentation/dev-manual/dev-manual-common-tasks.xml +++ b/documentation/dev-manual/dev-manual-common-tasks.xml @@ -15072,6 +15072,31 @@ + +
+ Copying Licenses that Do Not Exist + + + Some packages, such as the linux-firmware package, have many + licenses that are not in any way common. + You can avoid adding a lot of these types of common license + files, which are only applicable to a specific package, by using + the + NO_GENERIC_LICENSE + variable. + Using this variable also avoids QA errors when you use a + non-common, non-CLOSED license in a recipe. + + + + The following is an example that uses the + LICENSE.Abilis.txt + file as the license from the fetched source: + + NO_GENERIC_LICENSE[Firmware-Abilis] = "LICENSE.Abilis.txt" + + +
diff --git a/documentation/ref-manual/ref-variables.xml b/documentation/ref-manual/ref-variables.xml index 1c55a92d15..2465553010 100644 --- a/documentation/ref-manual/ref-variables.xml +++ b/documentation/ref-manual/ref-variables.xml @@ -9011,6 +9011,40 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" + NO_GENERIC_LICENSE + + NO_GENERIC_LICENSE[doc] = "Used to allow copying a license that does not exist in common licenses." + + + + + Avoids QA errors when you use a non-common, non-CLOSED + license in a recipe. + Packages exist, such as the linux-firmware package, with + many licenses that are not in any way common. + Also, new licenses are added occasionally to avoid + introducing a lot of common license files, which are only + applicable to a specific package. + NO_GENERIC_LICENSE is used to allow + copying a license that does not exist in common licenses. + + + + The following example shows how to add + NO_GENERIC_LICENSE to a recipe: + + NO_GENERIC_LICENSE[license_name] = "license_file_in_fetched_source" + + The following is an example that uses the + LICENSE.Abilis.txt file as the license + from the fetched source: + + NO_GENERIC_LICENSE[Firmware-Abilis] = "LICENSE.Abilis.txt" + + + + + NO_RECOMMENDATIONS NO_RECOMMENDATIONS[doc] = "When set to '1', no recommended packages will be installed. Some recommended packages might be required for certain system functionality, such as kernel-modules. It is up to the user to add packages to IMAGE_INSTALL as needed."