diff options
| -rw-r--r-- | documentation/dev-manual/dev-manual-common-tasks.xml | 25 | ||||
| -rw-r--r-- | documentation/ref-manual/ref-variables.xml | 34 |
2 files changed, 59 insertions, 0 deletions
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 @@ | |||
| 15072 | </para> | 15072 | </para> |
| 15073 | </section> | 15073 | </section> |
| 15074 | </section> | 15074 | </section> |
| 15075 | |||
| 15076 | <section id='copying-licenses-that-do-not-exist'> | ||
| 15077 | <title>Copying Licenses that Do Not Exist</title> | ||
| 15078 | |||
| 15079 | <para> | ||
| 15080 | Some packages, such as the linux-firmware package, have many | ||
| 15081 | licenses that are not in any way common. | ||
| 15082 | You can avoid adding a lot of these types of common license | ||
| 15083 | files, which are only applicable to a specific package, by using | ||
| 15084 | the | ||
| 15085 | <ulink url='&YOCTO_DOCS_REF_URL;#var-NO_GENERIC_LICENSE'><filename>NO_GENERIC_LICENSE</filename></ulink> | ||
| 15086 | variable. | ||
| 15087 | Using this variable also avoids QA errors when you use a | ||
| 15088 | non-common, non-CLOSED license in a recipe. | ||
| 15089 | </para> | ||
| 15090 | |||
| 15091 | <para> | ||
| 15092 | The following is an example that uses the | ||
| 15093 | <filename>LICENSE.Abilis.txt</filename> | ||
| 15094 | file as the license from the fetched source: | ||
| 15095 | <literallayout class='monospaced'> | ||
| 15096 | NO_GENERIC_LICENSE[Firmware-Abilis] = "LICENSE.Abilis.txt" | ||
| 15097 | </literallayout> | ||
| 15098 | </para> | ||
| 15099 | </section> | ||
| 15075 | </section> | 15100 | </section> |
| 15076 | 15101 | ||
| 15077 | <section id='using-the-error-reporting-tool'> | 15102 | <section id='using-the-error-reporting-tool'> |
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" | |||
| 9011 | </glossdef> | 9011 | </glossdef> |
| 9012 | </glossentry> | 9012 | </glossentry> |
| 9013 | 9013 | ||
| 9014 | <glossentry id='var-NO_GENERIC_LICENSE'><glossterm>NO_GENERIC_LICENSE</glossterm> | ||
| 9015 | <info> | ||
| 9016 | NO_GENERIC_LICENSE[doc] = "Used to allow copying a license that does not exist in common licenses." | ||
| 9017 | </info> | ||
| 9018 | <glossdef> | ||
| 9019 | <para role="glossdeffirst"> | ||
| 9020 | <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> | ||
| 9021 | Avoids QA errors when you use a non-common, non-CLOSED | ||
| 9022 | license in a recipe. | ||
| 9023 | Packages exist, such as the linux-firmware package, with | ||
| 9024 | many licenses that are not in any way common. | ||
| 9025 | Also, new licenses are added occasionally to avoid | ||
| 9026 | introducing a lot of common license files, which are only | ||
| 9027 | applicable to a specific package. | ||
| 9028 | <filename>NO_GENERIC_LICENSE</filename> is used to allow | ||
| 9029 | copying a license that does not exist in common licenses. | ||
| 9030 | </para> | ||
| 9031 | |||
| 9032 | <para> | ||
| 9033 | The following example shows how to add | ||
| 9034 | <filename>NO_GENERIC_LICENSE</filename> to a recipe: | ||
| 9035 | <literallayout class='monospaced'> | ||
| 9036 | NO_GENERIC_LICENSE[<replaceable>license_name</replaceable>] = "<replaceable>license_file_in_fetched_source</replaceable>" | ||
| 9037 | </literallayout> | ||
| 9038 | The following is an example that uses the | ||
| 9039 | <filename>LICENSE.Abilis.txt</filename> file as the license | ||
| 9040 | from the fetched source: | ||
| 9041 | <literallayout class='monospaced'> | ||
| 9042 | NO_GENERIC_LICENSE[Firmware-Abilis] = "LICENSE.Abilis.txt" | ||
| 9043 | </literallayout> | ||
| 9044 | </para> | ||
| 9045 | </glossdef> | ||
| 9046 | </glossentry> | ||
| 9047 | |||
| 9014 | <glossentry id='var-NO_RECOMMENDATIONS'><glossterm>NO_RECOMMENDATIONS</glossterm> | 9048 | <glossentry id='var-NO_RECOMMENDATIONS'><glossterm>NO_RECOMMENDATIONS</glossterm> |
| 9015 | <info> | 9049 | <info> |
| 9016 | 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." | 9050 | 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." |
