summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorScott Rifenbark <scott.m.rifenbark@intel.com>2013-11-27 08:07:00 -0800
committerRichard Purdie <richard.purdie@linuxfoundation.org>2013-12-03 12:53:29 +0000
commit0423bb60ba0476ecf6beb8f5efd36115476a1640 (patch)
treed46f3e98562dca9a627eb6bfc6dd8f7d3307cad8
parentb1c1016b2b925214e6373f399a8f2485a5d27ebd (diff)
downloadpoky-0423bb60ba0476ecf6beb8f5efd36115476a1640.tar.gz
ref-manual: Added deploy class.
(From yocto-docs rev: b05adab72d41f97b1bb5fbc0e5ae90b39b3890ca) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
-rw-r--r--documentation/ref-manual/ref-classes.xml30
1 files changed, 25 insertions, 5 deletions
diff --git a/documentation/ref-manual/ref-classes.xml b/documentation/ref-manual/ref-classes.xml
index 0945691b34..6306194aa0 100644
--- a/documentation/ref-manual/ref-classes.xml
+++ b/documentation/ref-manual/ref-classes.xml
@@ -430,7 +430,7 @@
430 <title><filename>copyleft_compliance.bbclass</filename></title> 430 <title><filename>copyleft_compliance.bbclass</filename></title>
431 431
432 <para> 432 <para>
433 The Copyleft Compliance <filename>copyleft_compliance</filename> class 433 The Copyleft Compliance (<filename>copyleft_compliance</filename>) class
434 preserves source code for the purposes of license compliance. 434 preserves source code for the purposes of license compliance.
435 This class is an alternative to the <filename>archive*</filename> 435 This class is an alternative to the <filename>archive*</filename>
436 classes and is still used by some users even though it has been 436 classes and is still used by some users even though it has been
@@ -444,7 +444,7 @@
444 <title><filename>core-image.bbclass</filename></title> 444 <title><filename>core-image.bbclass</filename></title>
445 445
446 <para> 446 <para>
447 The Core Image <filename>core-image</filename> class 447 The Core Image (<filename>core-image</filename>) class
448 provides common definitions for the 448 provides common definitions for the
449 <filename>core-image-*</filename> image recipes, such as support for 449 <filename>core-image-*</filename> image recipes, such as support for
450 additional 450 additional
@@ -456,7 +456,7 @@
456 <title><filename>cross.bbclass</filename></title> 456 <title><filename>cross.bbclass</filename></title>
457 457
458 <para> 458 <para>
459 The cross-compilation <filename>cross</filename> class 459 The cross-compilation (<filename>cross</filename>) class
460 provides support for cross-compilation tools. 460 provides support for cross-compilation tools.
461 </para> 461 </para>
462</section> 462</section>
@@ -465,7 +465,7 @@
465 <title><filename>cross-canadian.bbclass</filename></title> 465 <title><filename>cross-canadian.bbclass</filename></title>
466 466
467 <para> 467 <para>
468 The Canadian Cross <filename>cross-canadian</filename> class 468 The Canadian Cross (<filename>cross-canadian</filename>) class
469 provides support for Canadian Cross compilation tools for SDKs. 469 provides support for Canadian Cross compilation tools for SDKs.
470 See the 470 See the
471 "<link linkend='cross-development-toolchain-generation'>Cross-Development Toolchain Generation</link>" 471 "<link linkend='cross-development-toolchain-generation'>Cross-Development Toolchain Generation</link>"
@@ -477,7 +477,7 @@
477 <title><filename>crosssdk.bbclass</filename></title> 477 <title><filename>crosssdk.bbclass</filename></title>
478 478
479 <para> 479 <para>
480 The Cross SDK <filename>crosssdk</filename> class 480 The Cross SDK (<filename>crosssdk</filename>) class
481 provides support for cross-compilation tools used for building 481 provides support for cross-compilation tools used for building
482 SDKs. 482 SDKs.
483 See the 483 See the
@@ -486,6 +486,26 @@
486 </para> 486 </para>
487</section> 487</section>
488 488
489<section id='ref-classes-deploy'>
490 <title><filename>deploy.bbclass</filename></title>
491
492 <para>
493 The Deploy (<filename>deploy</filename>) class handles deploying files
494 to the
495 <link linkend='var-DEPLOY_DIR_IMAGE'><filename>DEPLOY_DIR_IMAGE</filename></link>
496 directory.
497 The main function of this class is to allow the deploy step to be
498 accelerated by shared state.
499 Recipes that inherit this class should define their own
500 <filename>do_deploy</filename> function to copy the files to be
501 deployed to
502 <link linkend='var-DEPLOY_DIR'><filename>DEPLOYDIR</filename></link>,
503 and use <filename>addtask</filename> to add the task at the appropriate
504 place, which is usually after <filename>do_compile</filename> or
505 <filename>do_install</filename>.
506 </para>
507</section>
508
489<section id='ref-classes-debian'> 509<section id='ref-classes-debian'>
490 <title>Debian Renaming - <filename>debian.bbclass</filename></title> 510 <title>Debian Renaming - <filename>debian.bbclass</filename></title>
491 511