summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorScott Rifenbark <srifenbark@gmail.com>2016-07-18 13:06:59 -0700
committerRichard Purdie <richard.purdie@linuxfoundation.org>2016-08-01 12:14:59 +0100
commit30929cf03738d5a871e410678e332ee3bdc51771 (patch)
tree04a3477997311098cc44c62aa745e58ab47f94c0
parentbc14368d39ebb3ae31e646b1c11c61d18126bfc7 (diff)
downloadpoky-30929cf03738d5a871e410678e332ee3bdc51771.tar.gz
ref-manual: Updated the do_deploy task reference section.
Fixes [YOCTO #9970] Added more detail to the do_deploy task. (From yocto-docs rev: 1b2daf814011dbc3c5987313442e95e18e83e180) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
-rw-r--r--documentation/ref-manual/ref-tasks.xml55
1 files changed, 46 insertions, 9 deletions
diff --git a/documentation/ref-manual/ref-tasks.xml b/documentation/ref-manual/ref-tasks.xml
index 15043c4ea7..34d0bdb7e7 100644
--- a/documentation/ref-manual/ref-tasks.xml
+++ b/documentation/ref-manual/ref-tasks.xml
@@ -130,18 +130,55 @@
130 <title><filename>do_deploy</filename></title> 130 <title><filename>do_deploy</filename></title>
131 131
132 <para> 132 <para>
133 Writes output files that are to be deployed to the deploy 133 Writes output files that are to be deployed to
134 directory, which is defined by the 134 <filename>${</filename><link linkend='var-DEPLOY_DIR_IMAGE'><filename>DEPLOY_DIR_IMAGE</filename></link><filename>}</filename>.
135 <link linkend='var-DEPLOYDIR'><filename>DEPLOYDIR</filename></link> 135 The task runs with the current working directory set to
136 variable. 136 <filename>${</filename><link linkend='var-B'><filename>B</filename></link><filename>}</filename>.
137 </para> 137 </para>
138 138
139 <para> 139 <para>
140 The <filename>do_deploy</filename> task is a 140 Recipes implementing this task should inherit the
141 shared state (sstate) task, which means that the task can 141 <link linkend='ref-classes-deploy'><filename>deploy</filename></link>
142 be accelerated through sstate use. 142 class and should write the output to
143 Realize also that if the task is re-executed, any previous output 143 <filename>${</filename><link linkend='var-DEPLOYDIR'><filename>DEPLOYDIR</filename></link><filename>}</filename>,
144 is removed (i.e. "cleaned"). 144 which is not to be confused with
145 <filename>${</filename><link linkend='var-DEPLOY_DIR'><filename>DEPLOY_DIR</filename></link><filename>}</filename>.
146 The <filename>deploy</filename> class sets up
147 <filename>do_deploy</filename> as a shared state (sstate) task that
148 can be accelerated through sstate use.
149 The sstate mechanism takes care of copying the output from
150 <filename>${DEPLOYDIR}</filename> to
151 <filename>${DEPLOY_DIR_IMAGE}</filename>.
152 <note>
153 <title>Caution</title>
154 Do not write the output directly to
155 <filename>${DEPLOY_DIR_IMAGE}</filename>, as this causes
156 the sstate mechanism to malfunction.
157 </note>
158 </para>
159
160 <para>
161 The <filename>do_deploy</filename> task is not added as a task by
162 default and needs to be added manually.
163 You can add this task using the following:
164 <literallayout class='monospaced'>
165 addtask deploy after do_compile
166 </literallayout>
167 If the <filename>do_deploy</filename> should run some time after
168 the <filename>do_compile</filename>, the
169 <filename>base.bbclass</filename> has the following to ensure that
170 all <filename>do_deploy</filename> tasks run by default.
171 See the
172 "<ulink url='&YOCTO_DOCS_BB_URL;#dependencies'>Dependencies</ulink>"
173 section in the BitBake User Manual for more information.
174 <literallayout class='monospaced'>
175 do_build[recrdeptask] += "do_deploy"
176 </literallayout>
177 </para>
178
179 <para>
180 If the <filename>do_deploy</filename> task re-executes, any
181 previous output is removed (i.e. "cleaned").
145 </para> 182 </para>
146 </section> 183 </section>
147 184