diff options
Diffstat (limited to 'documentation')
-rw-r--r-- | documentation/dev-manual/dev-manual-common-tasks.xml | 22 | ||||
-rw-r--r-- | documentation/ref-manual/ref-variables.xml | 73 |
2 files changed, 93 insertions, 2 deletions
diff --git a/documentation/dev-manual/dev-manual-common-tasks.xml b/documentation/dev-manual/dev-manual-common-tasks.xml index f0836e8b1d..eaf840d4d1 100644 --- a/documentation/dev-manual/dev-manual-common-tasks.xml +++ b/documentation/dev-manual/dev-manual-common-tasks.xml | |||
@@ -9941,6 +9941,28 @@ | |||
9941 | Adding these statements to the configuration file ensures | 9941 | Adding these statements to the configuration file ensures |
9942 | that the licenses collected during package generation | 9942 | that the licenses collected during package generation |
9943 | are included on your image. | 9943 | are included on your image. |
9944 | <note> | ||
9945 | <para>Setting all three variables to "1" results in the | ||
9946 | image having two copies of the same license file. | ||
9947 | One copy resides in | ||
9948 | <filename>/usr/share/common-licenses</filename> and | ||
9949 | the other resides in | ||
9950 | <filename>/usr/share/license</filename>.</para> | ||
9951 | |||
9952 | <para>The reason for this behavior is because | ||
9953 | <ulink url='&YOCTO_DOCS_REF_URL;#var-COPY_LIC_DIRS'><filename>COPY_LIC_DIRS</filename></ulink> | ||
9954 | and | ||
9955 | <ulink url='&YOCTO_DOCS_REF_URL;#var-COPY_LIC_MANIFEST'><filename>COPY_LIC_MANIFEST</filename></ulink> | ||
9956 | add a copy of the license when the image is built but do not | ||
9957 | offer a path for adding licenses for newly installed packages | ||
9958 | to an image. | ||
9959 | <ulink url='&YOCTO_DOCS_REF_URL;#var-LICENSE_CREATE_PACKAGE'><filename>LICENSE_CREATE_PACKAGE</filename></ulink> | ||
9960 | adds a separate package and an upgrade path for adding | ||
9961 | licenses to an image.</para> | ||
9962 | </note> | ||
9963 | </para> | ||
9964 | |||
9965 | <para> | ||
9944 | As the source archiver has already archived the original | 9966 | As the source archiver has already archived the original |
9945 | unmodified source that contains the license files, | 9967 | unmodified source that contains the license files, |
9946 | you would have already met the requirements for inclusion | 9968 | you would have already met the requirements for inclusion |
diff --git a/documentation/ref-manual/ref-variables.xml b/documentation/ref-manual/ref-variables.xml index 0b2c426b68..3d68dd6ac2 100644 --- a/documentation/ref-manual/ref-variables.xml +++ b/documentation/ref-manual/ref-variables.xml | |||
@@ -2354,7 +2354,20 @@ | |||
2354 | <filename>/usr/share/common-licenses</filename>, | 2354 | <filename>/usr/share/common-licenses</filename>, |
2355 | for each package. | 2355 | for each package. |
2356 | The license files are placed | 2356 | The license files are placed |
2357 | in directories within the image itself. | 2357 | in directories within the image itself during build time. |
2358 | <note> | ||
2359 | The <filename>COPY_LIC_DIRS</filename> does not | ||
2360 | offer a path for adding licenses for newly installed | ||
2361 | packages to an image, which might be most suitable | ||
2362 | for read-only filesystems that cannot be upgraded. | ||
2363 | See the | ||
2364 | <link linkend='var-LICENSE_CREATE_PACKAGE'><filename>LICENSE_CREATE_PACKAGE</filename></link> | ||
2365 | variable for additional information. | ||
2366 | You can also reference the | ||
2367 | "<ulink url='&YOCTO_DOCS_DEV_URL;#providing-license-text'>Providing License Text</ulink>" | ||
2368 | section in the Yocto Project Development Manual for | ||
2369 | information on providing license text. | ||
2370 | </note> | ||
2358 | </para> | 2371 | </para> |
2359 | </glossdef> | 2372 | </glossdef> |
2360 | </glossentry> | 2373 | </glossentry> |
@@ -2369,7 +2382,20 @@ | |||
2369 | If set to "1", the OpenEmbedded build system copies | 2382 | If set to "1", the OpenEmbedded build system copies |
2370 | the license manifest for the image to | 2383 | the license manifest for the image to |
2371 | <filename>/usr/share/common-licenses/license.manifest</filename> | 2384 | <filename>/usr/share/common-licenses/license.manifest</filename> |
2372 | within the image itself. | 2385 | within the image itself during build time. |
2386 | <note> | ||
2387 | The <filename>COPY_LIC_MANIFEST</filename> does not | ||
2388 | offer a path for adding licenses for newly installed | ||
2389 | packages to an image, which might be most suitable | ||
2390 | for read-only filesystems that cannot be upgraded. | ||
2391 | See the | ||
2392 | <link linkend='var-LICENSE_CREATE_PACKAGE'><filename>LICENSE_CREATE_PACKAGE</filename></link> | ||
2393 | variable for additional information. | ||
2394 | You can also reference the | ||
2395 | "<ulink url='&YOCTO_DOCS_DEV_URL;#providing-license-text'>Providing License Text</ulink>" | ||
2396 | section in the Yocto Project Development Manual for | ||
2397 | information on providing license text. | ||
2398 | </note> | ||
2373 | </para> | 2399 | </para> |
2374 | </glossdef> | 2400 | </glossdef> |
2375 | </glossentry> | 2401 | </glossentry> |
@@ -7179,6 +7205,49 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" | |||
7179 | </glossdef> | 7205 | </glossdef> |
7180 | </glossentry> | 7206 | </glossentry> |
7181 | 7207 | ||
7208 | <glossentry id='var-LICENSE_CREATE_PACKAGE'><glossterm>LICENSE_CREATE_PACKAGE</glossterm> | ||
7209 | <info> | ||
7210 | LICENSE_CREATE_PACKAGE[doc] = "Creates an extra package (i.e. ${PN}-lic) for each recipe and adds that package to the RRECOMMENDS+${PN}." | ||
7211 | </info> | ||
7212 | <glossdef> | ||
7213 | <para role="glossdeffirst"> | ||
7214 | <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> | ||
7215 | Setting <filename>LICENSE_CREATE_PACKAGE</filename> | ||
7216 | to "1" causes the OpenEmbedded build system to create | ||
7217 | an extra package (i.e. | ||
7218 | <filename>${</filename><link linkend='var-PN'><filename>PN</filename></link><filename>}-lic</filename>) | ||
7219 | for each recipe and to add those packages to the | ||
7220 | <link linkend='var-RRECOMMENDS'><filename>RRECOMMENDS</filename></link><filename>_${PN}</filename>. | ||
7221 | </para> | ||
7222 | |||
7223 | <para> | ||
7224 | The <filename>${PN}-lic</filename> package installs a | ||
7225 | directory in <filename>/usr/share/licenses</filename> | ||
7226 | named <filename>${PN}</filename>, which is the recipe's | ||
7227 | base name, and installs files in that directory that | ||
7228 | contain license and copyright information (i.e. copies of | ||
7229 | the appropriate license files from | ||
7230 | <filename>meta/common-licenses</filename> that match the | ||
7231 | licenses specified in the | ||
7232 | <link linkend='var-LICENSE'><filename>LICENSE</filename></link> | ||
7233 | variable of the recipe metadata and copies of files marked | ||
7234 | in | ||
7235 | <link linkend='var-LIC_FILES_CHKSUM'><filename>LIC_FILES_CHKSUM</filename></link> | ||
7236 | as containing license text). | ||
7237 | </para> | ||
7238 | |||
7239 | <para> | ||
7240 | For related information on providing license text, see the | ||
7241 | <link linkend='var-COPY_LIC_DIRS'><filename>COPY_LIC_DIRS</filename></link> | ||
7242 | variable, the | ||
7243 | <link linkend='var-COPY_LIC_MANIFEST'><filename>COPY_LIC_MANIFEST</filename></link> | ||
7244 | variable, and the | ||
7245 | "<ulink url='&YOCTO_DOCS_DEV_URL;#providing-license-text'>Providing License Text</ulink>" | ||
7246 | section in the Yocto Project Development Manual. | ||
7247 | </para> | ||
7248 | </glossdef> | ||
7249 | </glossentry> | ||
7250 | |||
7182 | <glossentry id='var-LICENSE_FLAGS'><glossterm>LICENSE_FLAGS</glossterm> | 7251 | <glossentry id='var-LICENSE_FLAGS'><glossterm>LICENSE_FLAGS</glossterm> |
7183 | <info> | 7252 | <info> |
7184 | LICENSE_FLAGS[doc] = "Specifies additional flags for a recipe you must whitelist through LICENSE_FLAGS_WHITELIST in order to allow the recipe to be built." | 7253 | LICENSE_FLAGS[doc] = "Specifies additional flags for a recipe you must whitelist through LICENSE_FLAGS_WHITELIST in order to allow the recipe to be built." |