summaryrefslogtreecommitdiffstats
path: root/documentation/ref-manual/ref-variables.xml
diff options
context:
space:
mode:
authorScott Rifenbark <srifenbark@gmail.com>2017-02-13 18:51:11 -0800
committerRichard Purdie <richard.purdie@linuxfoundation.org>2017-03-24 23:44:02 +0000
commite6ed5a6804c22bf9b299b3e0ab6acb679942e717 (patch)
treee93cca2c931086dc55dd6f5479298fa67faeb696 /documentation/ref-manual/ref-variables.xml
parentcc970c23a75c7d807df6b593407d6d0d1e0eb02e (diff)
downloadpoky-e6ed5a6804c22bf9b299b3e0ab6acb679942e717.tar.gz
ref-manual: Added five "COPYLEFT*" variables to the glossary.
Fixes [YOCTO #11021] The "Maintaining Open Source License Compliance During Your Product's Lifecycle" section in the dev manual covers use of archiver.bbclass, but is missing mention of the filtering options (e.g COPYLEFT_LICENSE_INCLUDE, COPYLEFT_LICENSE_EXCLUDE and COPYLEFT_RECIPE_TYPES). I added descriptions for these three. During the write-up, Paul noticed a couple other variables missing: COPYLEFT_PN_INCLUDE and COPYLEFT_PN_EXCLUDE. I also added descriptions for these two variables. (From yocto-docs rev: 450311037ea3048d30057c0b9d294efd33db2d3c) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/ref-manual/ref-variables.xml')
-rw-r--r--documentation/ref-manual/ref-variables.xml155
1 files changed, 155 insertions, 0 deletions
diff --git a/documentation/ref-manual/ref-variables.xml b/documentation/ref-manual/ref-variables.xml
index f79cdd2b76..fb293d7556 100644
--- a/documentation/ref-manual/ref-variables.xml
+++ b/documentation/ref-manual/ref-variables.xml
@@ -2364,6 +2364,161 @@
2364 </glossdef> 2364 </glossdef>
2365 </glossentry> 2365 </glossentry>
2366 2366
2367 <glossentry id='var-COPYLEFT_LICENSE_EXCLUDE'><glossterm>COPYLEFT_LICENSE_EXCLUDE</glossterm>
2368 <info>
2369 COPYLEFT_LICENSE_EXCLUDE[doc] = "Licenses to exclude in the source archived by the archiver class."
2370 </info>
2371 <glossdef>
2372 <para role="glossdeffirst">
2373<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
2374 A space-separated list of licenses to exclude from the
2375 source archived by the
2376 <link linkend='ref-classes-archiver'><filename>archiver</filename></link>
2377 class.
2378 In other words, if a license in a recipe's
2379 <link linkend='var-LICENSE'><filename>LICENSE</filename></link>
2380 value is in the value of
2381 <filename>COPYLEFT_LICENSE_EXCLUDE</filename>, then its
2382 source is not archived by the class.
2383 <note>
2384 The <filename>COPYLEFT_LICENSE_EXCLUDE</filename>
2385 variable takes precedence over the
2386 <link linkend='var-COPYLEFT_LICENSE_INCLUDE'><filename>COPYLEFT_LICENSE_INCLUDE</filename></link>
2387 variable.
2388 </note>
2389 The default value, which is "CLOSED Proprietary", for
2390 <filename>COPYLEFT_LICENSE_EXCLUDE</filename> is set
2391 by the
2392 <link linkend='ref-classes-copyleft_filter'><filename>copyleft_filter</filename></link>
2393 class, which is inherited by the
2394 <filename>archiver</filename> class.
2395 </para>
2396 </glossdef>
2397 </glossentry>
2398
2399 <glossentry id='var-COPYLEFT_LICENSE_INCLUDE'><glossterm>COPYLEFT_LICENSE_INCLUDE</glossterm>
2400 <info>
2401 COPYLEFT_LICENSE_INCLUDE[doc] = "Licenses to include in the source archived by the archiver class."
2402 </info>
2403 <glossdef>
2404 <para role="glossdeffirst">
2405<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
2406 A space-separated list of licenses to include in the
2407 source archived by the
2408 <link linkend='ref-classes-archiver'><filename>archiver</filename></link>
2409 class.
2410 In other words, if a license in a recipe's
2411 <link linkend='var-LICENSE'><filename>LICENSE</filename></link>
2412 value is in the value of
2413 <filename>COPYLEFT_LICENSE_INCLUDE</filename>, then its
2414 source is archived by the class.
2415 </para>
2416
2417 <para>
2418 The default value, which is "GPL* LGPL*", for
2419 <filename>COPYLEFT_LICENSE_INCLUDE</filename> is set
2420 by the
2421 <link linkend='ref-classes-copyleft_filter'><filename>copyleft_filter</filename></link>
2422 class, which is inherited by the
2423 <filename>archiver</filename> class.
2424 </para>
2425 </glossdef>
2426 </glossentry>
2427
2428 <glossentry id='var-COPYLEFT_PN_EXCLUDE'><glossterm>COPYLEFT_PN_EXCLUDE</glossterm>
2429 <info>
2430 COPYLEFT_PN_EXCLUDE[doc] = "Recipes to exclude in the source archived by the archiver class."
2431 </info>
2432 <glossdef>
2433 <para role="glossdeffirst">
2434<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
2435 A list of recipes to exclude in the source archived
2436 by the
2437 <link linkend='ref-classes-archiver'><filename>archiver</filename></link>
2438 class.
2439 The <filename>COPYLEFT_PN_EXCLUDE</filename> variable
2440 overrides the license inclusion and exclusion caused
2441 through the
2442 <link linkend='var-COPYLEFT_LICENSE_INCLUDE'><filename>COPYLEFT_LICENSE_INCLUDE</filename></link>
2443 and
2444 <link linkend='var-COPYLEFT_LICENSE_EXCLUDE'><filename>COPYLEFT_LICENSE_EXCLUDE</filename></link>
2445 variables, respectively.
2446 </para>
2447
2448 <para>
2449 The default value, which is "" indicating to not explicitly
2450 exclude any recipes by name, for
2451 <filename>COPYLEFT_PN_EXCLUDE</filename> is set
2452 by the
2453 <link linkend='ref-classes-copyleft_filter'><filename>copyleft_filter</filename></link>
2454 class, which is inherited by the
2455 <filename>archiver</filename> class.
2456 </para>
2457 </glossdef>
2458 </glossentry>
2459
2460 <glossentry id='var-COPYLEFT_PN_INCLUDE'><glossterm>COPYLEFT_PN_INCLUDE</glossterm>
2461 <info>
2462 COPYLEFT_PN_INCLUDE[doc] = "Recipes to include in the source archived by the archiver class."
2463 </info>
2464 <glossdef>
2465 <para role="glossdeffirst">
2466<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
2467 A list of recipes to include in the source archived
2468 by the
2469 <link linkend='ref-classes-archiver'><filename>archiver</filename></link>
2470 class.
2471 The <filename>COPYLEFT_PN_INCLUDE</filename> variable
2472 overrides the license inclusion and exclusion caused
2473 through the
2474 <link linkend='var-COPYLEFT_LICENSE_INCLUDE'><filename>COPYLEFT_LICENSE_INCLUDE</filename></link>
2475 and
2476 <link linkend='var-COPYLEFT_LICENSE_EXCLUDE'><filename>COPYLEFT_LICENSE_EXCLUDE</filename></link>
2477 variables, respectively.
2478 </para>
2479
2480 <para>
2481 The default value, which is "" indicating to not explicitly
2482 include any recipes by name, for
2483 <filename>COPYLEFT_PN_INCLUDE</filename> is set
2484 by the
2485 <link linkend='ref-classes-copyleft_filter'><filename>copyleft_filter</filename></link>
2486 class, which is inherited by the
2487 <filename>archiver</filename> class.
2488 </para>
2489 </glossdef>
2490 </glossentry>
2491
2492 <glossentry id='var-COPYLEFT_RECIPE_TYPES'><glossterm>COPYLEFT_RECIPE_TYPES</glossterm>
2493 <info>
2494 COPYLEFT_RECIPE_TYPES[doc] = "Recipe types to include in the source archived by the archiver class."
2495 </info>
2496 <glossdef>
2497 <para role="glossdeffirst">
2498<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
2499 A space-separated list of recipe types to include
2500 in the source archived by the
2501 <link linkend='ref-classes-archiver'><filename>archiver</filename></link>
2502 class.
2503 Recipe types are <filename>target</filename>,
2504 <filename>native</filename>,
2505 <filename>nativesdk</filename>,
2506 <filename>cross</filename>,
2507 <filename>crosssdk</filename>, and
2508 <filename>cross-canadian</filename>.
2509 </para>
2510
2511 <para>
2512 The default value, which is "target*", for
2513 <filename>COPYLEFT_RECIPE_TYPES</filename> is set
2514 by the
2515 <link linkend='ref-classes-copyleft_filter'><filename>copyleft_filter</filename></link>
2516 class, which is inherited by the
2517 <filename>archiver</filename> class.
2518 </para>
2519 </glossdef>
2520 </glossentry>
2521
2367 <glossentry id='var-COPY_LIC_DIRS'><glossterm>COPY_LIC_DIRS</glossterm> 2522 <glossentry id='var-COPY_LIC_DIRS'><glossterm>COPY_LIC_DIRS</glossterm>
2368 <info> 2523 <info>
2369 COPY_LIC_DIRS[doc] = "If set to "1" along with the COPY_LIC_MANIFEST variable, the OpenEmbedded build system copies into the image the license files, which are located in /usr/share/common-licenses, for each package." 2524 COPY_LIC_DIRS[doc] = "If set to "1" along with the COPY_LIC_MANIFEST variable, the OpenEmbedded build system copies into the image the license files, which are located in /usr/share/common-licenses, for each package."