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 @@ Adding these statements to the configuration file ensures that the licenses collected during package generation are included on your image. + + Setting all three variables to "1" results in the + image having two copies of the same license file. + One copy resides in + /usr/share/common-licenses and + the other resides in + /usr/share/license. + + The reason for this behavior is because + COPY_LIC_DIRS + and + COPY_LIC_MANIFEST + add a copy of the license when the image is built but do not + offer a path for adding licenses for newly installed packages + to an image. + LICENSE_CREATE_PACKAGE + adds a separate package and an upgrade path for adding + licenses to an image. + @@ -9986,15 +10005,6 @@ of the license information with source as defined by the GPL and other open source licenses. - - - See the - LICENSE_CREATE_PACKAGE, - COPY_LIC_DIRS, - and - COPY_LIC_MANIFEST - variable descriptions for more information. -
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 @@ /usr/share/common-licenses, for each package. The license files are placed - in directories within the image itself. + in directories within the image itself during build time. + + The COPY_LIC_DIRS does not + offer a path for adding licenses for newly installed + packages to an image, which might be most suitable + for read-only filesystems that cannot be upgraded. + See the + LICENSE_CREATE_PACKAGE + variable for additional information. + You can also reference the + "Providing License Text" + section in the Yocto Project Development Manual for + information on providing license text. + @@ -2363,7 +2376,20 @@ If set to "1", the OpenEmbedded build system copies the license manifest for the image to /usr/share/common-licenses/license.manifest - within the image itself. + within the image itself during build time. + + The COPY_LIC_MANIFEST does not + offer a path for adding licenses for newly installed + packages to an image, which might be most suitable + for read-only filesystems that cannot be upgraded. + See the + LICENSE_CREATE_PACKAGE + variable for additional information. + You can also reference the + "Providing License Text" + section in the Yocto Project Development Manual for + information on providing license text. + @@ -7159,6 +7185,16 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" LIC_FILES_CHKSUM as containing license text). + + + For related information on providing license text, see the + COPY_LIC_DIRS + variable, the + COPY_LIC_MANIFEST + variable, and the + "Providing License Text" + section in the Yocto Project Development Manual. +