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>

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 @@
     <title><filename>copyleft_compliance.bbclass</filename></title>
 
     <para>
-        The Copyleft Compliance <filename>copyleft_compliance</filename> class
+        The Copyleft Compliance (<filename>copyleft_compliance</filename>) class
         preserves source code for the purposes of license compliance.
         This class is an alternative to the <filename>archive*</filename>
         classes and is still used by some users even though it has been
@@ -444,7 +444,7 @@
     <title><filename>core-image.bbclass</filename></title>
 
     <para>
-        The Core Image <filename>core-image</filename> class
+        The Core Image (<filename>core-image</filename>) class
         provides common definitions for the
         <filename>core-image-*</filename> image recipes, such as support for
         additional
@@ -456,7 +456,7 @@
     <title><filename>cross.bbclass</filename></title>
 
     <para>
-        The cross-compilation <filename>cross</filename> class
+        The cross-compilation (<filename>cross</filename>) class
         provides support for cross-compilation tools.
     </para>
 </section>
@@ -465,7 +465,7 @@
     <title><filename>cross-canadian.bbclass</filename></title>
 
     <para>
-        The Canadian Cross <filename>cross-canadian</filename> class
+        The Canadian Cross (<filename>cross-canadian</filename>) class
         provides support for Canadian Cross compilation tools for SDKs.
         See the
         "<link linkend='cross-development-toolchain-generation'>Cross-Development Toolchain Generation</link>"
@@ -477,7 +477,7 @@
     <title><filename>crosssdk.bbclass</filename></title>
 
     <para>
-        The Cross SDK <filename>crosssdk</filename> class
+        The Cross SDK (<filename>crosssdk</filename>) class
         provides support for cross-compilation tools used for building
         SDKs.
         See the
@@ -486,6 +486,26 @@
     </para>
 </section>
 
+<section id='ref-classes-deploy'>
+    <title><filename>deploy.bbclass</filename></title>
+
+    <para>
+        The Deploy (<filename>deploy</filename>) class handles deploying files
+        to the
+        <link linkend='var-DEPLOY_DIR_IMAGE'><filename>DEPLOY_DIR_IMAGE</filename></link>
+        directory.
+        The main function of this class is to allow the deploy step to be
+        accelerated by shared state.
+        Recipes that inherit this class should define their own
+        <filename>do_deploy</filename> function to copy the files to be
+        deployed to
+        <link linkend='var-DEPLOY_DIR'><filename>DEPLOYDIR</filename></link>,
+        and use <filename>addtask</filename> to add the task at the appropriate
+        place, which is usually after <filename>do_compile</filename> or
+        <filename>do_install</filename>.
+    </para>
+</section>
+
 <section id='ref-classes-debian'>
     <title>Debian Renaming - <filename>debian.bbclass</filename></title>