diff options
| -rw-r--r-- | documentation/dev-manual/dev-manual-common-tasks.xml | 28 | ||||
| -rw-r--r-- | documentation/ref-manual/ref-variables.xml | 40 |
2 files changed, 57 insertions, 11 deletions
diff --git a/documentation/dev-manual/dev-manual-common-tasks.xml b/documentation/dev-manual/dev-manual-common-tasks.xml index 0f006c790d..e0db037454 100644 --- a/documentation/dev-manual/dev-manual-common-tasks.xml +++ b/documentation/dev-manual/dev-manual-common-tasks.xml | |||
| @@ -9977,6 +9977,25 @@ | |||
| 9977 | Adding these statements to the configuration file ensures | 9977 | Adding these statements to the configuration file ensures |
| 9978 | that the licenses collected during package generation | 9978 | that the licenses collected during package generation |
| 9979 | are included on your image. | 9979 | are included on your image. |
| 9980 | <note> | ||
| 9981 | <para>Setting all three variables to "1" results in the | ||
| 9982 | image having two copies of the same license file. | ||
| 9983 | One copy resides in | ||
| 9984 | <filename>/usr/share/common-licenses</filename> and | ||
| 9985 | the other resides in | ||
| 9986 | <filename>/usr/share/license</filename>.</para> | ||
| 9987 | |||
| 9988 | <para>The reason for this behavior is because | ||
| 9989 | <ulink url='&YOCTO_DOCS_REF_URL;#var-COPY_LIC_DIRS'><filename>COPY_LIC_DIRS</filename></ulink> | ||
| 9990 | and | ||
| 9991 | <ulink url='&YOCTO_DOCS_REF_URL;#var-COPY_LIC_MANIFEST'><filename>COPY_LIC_MANIFEST</filename></ulink> | ||
| 9992 | add a copy of the license when the image is built but do not | ||
| 9993 | offer a path for adding licenses for newly installed packages | ||
| 9994 | to an image. | ||
| 9995 | <ulink url='&YOCTO_DOCS_REF_URL;#var-LICENSE_CREATE_PACKAGE'><filename>LICENSE_CREATE_PACKAGE</filename></ulink> | ||
| 9996 | adds a separate package and an upgrade path for adding | ||
| 9997 | licenses to an image.</para> | ||
| 9998 | </note> | ||
| 9980 | </para> | 9999 | </para> |
| 9981 | 10000 | ||
| 9982 | <para> | 10001 | <para> |
| @@ -9986,15 +10005,6 @@ | |||
| 9986 | of the license information with source as defined by the GPL | 10005 | of the license information with source as defined by the GPL |
| 9987 | and other open source licenses. | 10006 | and other open source licenses. |
| 9988 | </para> | 10007 | </para> |
| 9989 | |||
| 9990 | <para> | ||
| 9991 | See the | ||
| 9992 | <ulink url='&YOCTO_DOCS_REF_URL;#var-LICENSE_CREATE_PACKAGE'><filename>LICENSE_CREATE_PACKAGE</filename></ulink>, | ||
| 9993 | <ulink url='&YOCTO_DOCS_REF_URL;#var-COPY_LIC_DIRS'><filename>COPY_LIC_DIRS</filename></ulink>, | ||
| 9994 | and | ||
| 9995 | <ulink url='&YOCTO_DOCS_REF_URL;#var-COPY_LIC_MANIFEST'><filename>COPY_LIC_MANIFEST</filename></ulink> | ||
| 9996 | variable descriptions for more information. | ||
| 9997 | </para> | ||
| 9998 | </section> | 10008 | </section> |
| 9999 | 10009 | ||
| 10000 | <section id='providing-compilation-scripts-and-source-code-modifications'> | 10010 | <section id='providing-compilation-scripts-and-source-code-modifications'> |
diff --git a/documentation/ref-manual/ref-variables.xml b/documentation/ref-manual/ref-variables.xml index f752856b9d..53bc544b5b 100644 --- a/documentation/ref-manual/ref-variables.xml +++ b/documentation/ref-manual/ref-variables.xml | |||
| @@ -2348,7 +2348,20 @@ | |||
| 2348 | <filename>/usr/share/common-licenses</filename>, | 2348 | <filename>/usr/share/common-licenses</filename>, |
| 2349 | for each package. | 2349 | for each package. |
| 2350 | The license files are placed | 2350 | The license files are placed |
| 2351 | in directories within the image itself. | 2351 | in directories within the image itself during build time. |
| 2352 | <note> | ||
| 2353 | The <filename>COPY_LIC_DIRS</filename> does not | ||
| 2354 | offer a path for adding licenses for newly installed | ||
| 2355 | packages to an image, which might be most suitable | ||
| 2356 | for read-only filesystems that cannot be upgraded. | ||
| 2357 | See the | ||
| 2358 | <link linkend='var-LICENSE_CREATE_PACKAGE'><filename>LICENSE_CREATE_PACKAGE</filename></link> | ||
| 2359 | variable for additional information. | ||
| 2360 | You can also reference the | ||
| 2361 | "<ulink url='&YOCTO_DOCS_DEV_URL;#providing-license-text'>Providing License Text</ulink>" | ||
| 2362 | section in the Yocto Project Development Manual for | ||
| 2363 | information on providing license text. | ||
| 2364 | </note> | ||
| 2352 | </para> | 2365 | </para> |
| 2353 | </glossdef> | 2366 | </glossdef> |
| 2354 | </glossentry> | 2367 | </glossentry> |
| @@ -2363,7 +2376,20 @@ | |||
| 2363 | If set to "1", the OpenEmbedded build system copies | 2376 | If set to "1", the OpenEmbedded build system copies |
| 2364 | the license manifest for the image to | 2377 | the license manifest for the image to |
| 2365 | <filename>/usr/share/common-licenses/license.manifest</filename> | 2378 | <filename>/usr/share/common-licenses/license.manifest</filename> |
| 2366 | within the image itself. | 2379 | within the image itself during build time. |
| 2380 | <note> | ||
| 2381 | The <filename>COPY_LIC_MANIFEST</filename> does not | ||
| 2382 | offer a path for adding licenses for newly installed | ||
| 2383 | packages to an image, which might be most suitable | ||
| 2384 | for read-only filesystems that cannot be upgraded. | ||
| 2385 | See the | ||
| 2386 | <link linkend='var-LICENSE_CREATE_PACKAGE'><filename>LICENSE_CREATE_PACKAGE</filename></link> | ||
| 2387 | variable for additional information. | ||
| 2388 | You can also reference the | ||
| 2389 | "<ulink url='&YOCTO_DOCS_DEV_URL;#providing-license-text'>Providing License Text</ulink>" | ||
| 2390 | section in the Yocto Project Development Manual for | ||
| 2391 | information on providing license text. | ||
| 2392 | </note> | ||
| 2367 | </para> | 2393 | </para> |
| 2368 | </glossdef> | 2394 | </glossdef> |
| 2369 | </glossentry> | 2395 | </glossentry> |
| @@ -7159,6 +7185,16 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" | |||
| 7159 | <link linkend='var-LIC_FILES_CHKSUM'><filename>LIC_FILES_CHKSUM</filename></link> | 7185 | <link linkend='var-LIC_FILES_CHKSUM'><filename>LIC_FILES_CHKSUM</filename></link> |
| 7160 | as containing license text). | 7186 | as containing license text). |
| 7161 | </para> | 7187 | </para> |
| 7188 | |||
| 7189 | <para> | ||
| 7190 | For related information on providing license text, see the | ||
| 7191 | <link linkend='var-COPY_LIC_DIRS'><filename>COPY_LIC_DIRS</filename></link> | ||
| 7192 | variable, the | ||
| 7193 | <link linkend='var-COPY_LIC_MANIFEST'><filename>COPY_LIC_MANIFEST</filename></link> | ||
| 7194 | variable, and the | ||
| 7195 | "<ulink url='&YOCTO_DOCS_DEV_URL;#providing-license-text'>Providing License Text</ulink>" | ||
| 7196 | section in the Yocto Project Development Manual. | ||
| 7197 | </para> | ||
| 7162 | </glossdef> | 7198 | </glossdef> |
| 7163 | </glossentry> | 7199 | </glossentry> |
| 7164 | 7200 | ||
