summaryrefslogtreecommitdiffstats
path: root/documentation/dev-manual
diff options
context:
space:
mode:
authorScott Rifenbark <scott.m.rifenbark@intel.com>2014-06-16 11:45:19 +0300
committerRichard Purdie <richard.purdie@linuxfoundation.org>2014-06-18 10:30:49 +0100
commitac6bdb4d41bb8b2e1deb78d406ce0d2afb0b8505 (patch)
treefb1e3f677e0ca4621c1460377dd87baaa45252c7 /documentation/dev-manual
parentcf0be8389c834a32c0a5246e3444573e4f5024ae (diff)
downloadpoky-ac6bdb4d41bb8b2e1deb78d406ce0d2afb0b8505.tar.gz
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>
Diffstat (limited to 'documentation/dev-manual')
-rw-r--r--documentation/dev-manual/dev-manual-common-tasks.xml29
-rw-r--r--documentation/dev-manual/dev-manual-model.xml10
2 files changed, 29 insertions, 10 deletions
diff --git a/documentation/dev-manual/dev-manual-common-tasks.xml b/documentation/dev-manual/dev-manual-common-tasks.xml
index 10c3711b9a..a5cefe499f 100644
--- a/documentation/dev-manual/dev-manual-common-tasks.xml
+++ b/documentation/dev-manual/dev-manual-common-tasks.xml
@@ -3920,17 +3920,30 @@
3920 </literallayout> 3920 </literallayout>
3921 </para></listitem> 3921 </para></listitem>
3922 <listitem><para><emphasis>Clean up</emphasis>: 3922 <listitem><para><emphasis>Clean up</emphasis>:
3923 Be sure to clean the shared state out by running the 3923 Be sure to clean the shared state out by using BitBake
3924 <filename>cleansstate</filename> BitBake task as follows from your Build Directory: 3924 to run from within the Build Directory the
3925 <ulink url='&YOCTO_DOCS_REF_URL;#ref-tasks-cleansstate'><filename>do_cleansstate</filename></ulink>
3926 task as follows:
3925 <literallayout class='monospaced'> 3927 <literallayout class='monospaced'>
3926 $ bitbake -c cleansstate linux-yocto 3928 $ bitbake -c cleansstate linux-yocto
3927 </literallayout></para> 3929 </literallayout></para>
3928 <para><note>Never remove any files by hand from the <filename>tmp/deploy</filename> 3930 <para>
3929 directory inside the 3931 <note>
3930 <link linkend='build-directory'>Build Directory</link>. 3932 Never remove any files by hand from the
3931 Always use the various BitBake clean tasks to clear out previous 3933 <filename>tmp/deploy</filename>
3932 build artifacts. 3934 directory inside the
3933 </note></para></listitem> 3935 <link linkend='build-directory'>Build Directory</link>.
3936 Always use the various BitBake clean tasks to
3937 clear out previous build artifacts.
3938 For information on the clean tasks, see the
3939 "<ulink url='&YOCTO_DOCS_REF_URL;#ref-tasks-clean'><filename>do_clean</filename></ulink>",
3940 "<ulink url='&YOCTO_DOCS_REF_URL;#ref-tasks-cleanall'><filename>do_cleanall</filename></ulink>",
3941 and
3942 "<ulink url='&YOCTO_DOCS_REF_URL;#ref-tasks-cleansstate'><filename>do_cleansstate</filename></ulink>"
3943 sections all in the Yocto Project Reference
3944 Manual.
3945 </note>
3946 </para></listitem>
3934 <listitem><para><emphasis>Build the image</emphasis>: 3947 <listitem><para><emphasis>Build the image</emphasis>:
3935 Next, build the kernel image using this command: 3948 Next, build the kernel image using this command:
3936 <literallayout class='monospaced'> 3949 <literallayout class='monospaced'>
diff --git a/documentation/dev-manual/dev-manual-model.xml b/documentation/dev-manual/dev-manual-model.xml
index 59e19a2bae..bd24905ad7 100644
--- a/documentation/dev-manual/dev-manual-model.xml
+++ b/documentation/dev-manual/dev-manual-model.xml
@@ -1785,8 +1785,14 @@
1785 If you find problems with your code, you can just keep editing and 1785 If you find problems with your code, you can just keep editing and
1786 re-testing iteratively until things work as expected. 1786 re-testing iteratively until things work as expected.
1787 <note>All the modifications you make to the temporary source code 1787 <note>All the modifications you make to the temporary source code
1788 disappear once you <filename>-c clean</filename> or 1788 disappear once you run the
1789 <filename>-c cleanall</filename> with BitBake for the package. 1789 <ulink url='&YOCTO_DOCS_REF_URL;#ref-tasks-clean'><filename>do_clean</filename></ulink>
1790 or
1791 <ulink url='&YOCTO_DOCS_REF_URL;#ref-tasks-cleanall'><filename>do_cleanall</filename></ulink>
1792 tasks using BitBake (i.e.
1793 <filename>bitbake -c clean &lt;name_of_package&gt;</filename>
1794 and
1795 <filename>bitbake -c cleanall &lt;name_of_package&gt;</filename>).
1790 Modifications will also disappear if you use the <filename>rm_work</filename> 1796 Modifications will also disappear if you use the <filename>rm_work</filename>
1791 feature as described in the 1797 feature as described in the
1792 "<ulink url='&YOCTO_DOCS_QS_URL;#building-image'>Building an Image</ulink>" 1798 "<ulink url='&YOCTO_DOCS_QS_URL;#building-image'>Building an Image</ulink>"