sysmo-bts
/
generic-poky
9
0
Fork 0
Code Pull Requests Releases Activity

dev-manual, kernel-dev: Provides some cross-reference to "clean" stuff. 

I scrubbed the manual set for appropriate places to reference into the
do_clean* type tasks.  Found and added several occurrences.

(From yocto-docs rev: 01594823b1d556bc70e928af1838039cc15a816d)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This commit is contained in:
Scott Rifenbark 2014-06-16 11:45:19 +03:00 committed by Richard Purdie
parent cf0be8389c
commit ac6bdb4d41
3 changed files with 39 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
documentation/dev-manual/dev-manual-common-tasks.xml
View File

@ -3920,17 +3920,30 @@
</literallayout> </literallayout>
</para></listitem> </para></listitem>
<listitem><para><emphasis>Clean up</emphasis>: <listitem><para><emphasis>Clean up</emphasis>:
Be sure to clean the shared state out by running the Be sure to clean the shared state out by using BitBake
<filename>cleansstate</filename> BitBake task as follows from your Build Directory: to run from within the Build Directory the
<ulink url='&YOCTO_DOCS_REF_URL;#ref-tasks-cleansstate'><filename>do_cleansstate</filename></ulink>
task as follows:
<literallayout class='monospaced'> <literallayout class='monospaced'>
$ bitbake -c cleansstate linux-yocto $ bitbake -c cleansstate linux-yocto
</literallayout></para> </literallayout></para>
<para><note>Never remove any files by hand from the <filename>tmp/deploy</filename> <para>
directory inside the <note>
<link linkend='build-directory'>Build Directory</link>. Never remove any files by hand from the
Always use the various BitBake clean tasks to clear out previous <filename>tmp/deploy</filename>
build artifacts. directory inside the
</note></para></listitem> <link linkend='build-directory'>Build Directory</link>.
Always use the various BitBake clean tasks to
clear out previous build artifacts.
For information on the clean tasks, see the
"<ulink url='&YOCTO_DOCS_REF_URL;#ref-tasks-clean'><filename>do_clean</filename></ulink>",
"<ulink url='&YOCTO_DOCS_REF_URL;#ref-tasks-cleanall'><filename>do_cleanall</filename></ulink>",
and
"<ulink url='&YOCTO_DOCS_REF_URL;#ref-tasks-cleansstate'><filename>do_cleansstate</filename></ulink>"
sections all in the Yocto Project Reference
Manual.
</note>
</para></listitem>
<listitem><para><emphasis>Build the image</emphasis>: <listitem><para><emphasis>Build the image</emphasis>:
Next, build the kernel image using this command: Next, build the kernel image using this command:
<literallayout class='monospaced'> <literallayout class='monospaced'>

10
documentation/dev-manual/dev-manual-model.xml
View File

@ -1785,8 +1785,14 @@
If you find problems with your code, you can just keep editing and If you find problems with your code, you can just keep editing and
re-testing iteratively until things work as expected. re-testing iteratively until things work as expected.
<note>All the modifications you make to the temporary source code <note>All the modifications you make to the temporary source code
disappear once you <filename>-c clean</filename> or disappear once you run the
<filename>-c cleanall</filename> with BitBake for the package. <ulink url='&YOCTO_DOCS_REF_URL;#ref-tasks-clean'><filename>do_clean</filename></ulink>
or
<ulink url='&YOCTO_DOCS_REF_URL;#ref-tasks-cleanall'><filename>do_cleanall</filename></ulink>
tasks using BitBake (i.e.
<filename>bitbake -c clean &lt;name_of_package&gt;</filename>
and
<filename>bitbake -c cleanall &lt;name_of_package&gt;</filename>).
Modifications will also disappear if you use the <filename>rm_work</filename> Modifications will also disappear if you use the <filename>rm_work</filename>
feature as described in the feature as described in the
"<ulink url='&YOCTO_DOCS_QS_URL;#building-image'>Building an Image</ulink>" "<ulink url='&YOCTO_DOCS_QS_URL;#building-image'>Building an Image</ulink>"

14
documentation/kernel-dev/kernel-dev-common.xml
View File

@ -445,10 +445,16 @@
You can edit the sources as you would any other Linux source You can edit the sources as you would any other Linux source
tree. tree.
However, keep in mind that you will lose changes if you However, keep in mind that you will lose changes if you
trigger the <filename>do_fetch</filename> task for the recipe. trigger the
You can avoid triggering this task by not issuing BitBake's <ulink url='&YOCTO_DOCS_REF_URL;#ref-tasks-fetch'><filename>do_fetch</filename></ulink>
<filename>cleanall</filename>, <filename>cleansstate</filename>, task for the recipe.
or forced <filename>fetch</filename> commands. You can avoid triggering this task by not using BitBake to
run the
<ulink url='&YOCTO_DOCS_REF_URL;#ref-tasks-cleanall'><filename>cleanall</filename></ulink>,
<ulink url='&YOCTO_DOCS_REF_URL;#ref-tasks-cleansstate'><filename>cleansstate</filename></ulink>,
or forced
<ulink url='&YOCTO_DOCS_REF_URL;#ref-tasks-fetch'><filename>fetch</filename></ulink>
commands.
Also, do not modify the recipe itself while working Also, do not modify the recipe itself while working
with temporary changes or BitBake might run the with temporary changes or BitBake might run the
<filename>fetch</filename> command depending on the <filename>fetch</filename> command depending on the