diff options
author | Scott Rifenbark <scott.m.rifenbark@intel.com> | 2014-06-16 11:45:19 +0300 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2014-06-18 10:30:49 +0100 |
commit | ac6bdb4d41bb8b2e1deb78d406ce0d2afb0b8505 (patch) | |
tree | fb1e3f677e0ca4621c1460377dd87baaa45252c7 /documentation | |
parent | cf0be8389c834a32c0a5246e3444573e4f5024ae (diff) | |
download | ast2050-yocto-poky-ac6bdb4d41bb8b2e1deb78d406ce0d2afb0b8505.zip ast2050-yocto-poky-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')
-rw-r--r-- | documentation/dev-manual/dev-manual-common-tasks.xml | 29 | ||||
-rw-r--r-- | documentation/dev-manual/dev-manual-model.xml | 10 | ||||
-rw-r--r-- | documentation/kernel-dev/kernel-dev-common.xml | 14 |
3 files changed, 39 insertions, 14 deletions
diff --git a/documentation/dev-manual/dev-manual-common-tasks.xml b/documentation/dev-manual/dev-manual-common-tasks.xml index 10c3711..a5cefe4 100644 --- a/documentation/dev-manual/dev-manual-common-tasks.xml +++ b/documentation/dev-manual/dev-manual-common-tasks.xml @@ -3920,17 +3920,30 @@ </literallayout> </para></listitem> <listitem><para><emphasis>Clean up</emphasis>: - Be sure to clean the shared state out by running the - <filename>cleansstate</filename> BitBake task as follows from your Build Directory: + Be sure to clean the shared state out by using BitBake + 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'> $ bitbake -c cleansstate linux-yocto </literallayout></para> - <para><note>Never remove any files by hand from the <filename>tmp/deploy</filename> - directory inside the - <link linkend='build-directory'>Build Directory</link>. - Always use the various BitBake clean tasks to clear out previous - build artifacts. - </note></para></listitem> + <para> + <note> + Never remove any files by hand from the + <filename>tmp/deploy</filename> + directory inside the + <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>: Next, build the kernel image using this command: <literallayout class='monospaced'> diff --git a/documentation/dev-manual/dev-manual-model.xml b/documentation/dev-manual/dev-manual-model.xml index 59e19a2..bd24905 100644 --- a/documentation/dev-manual/dev-manual-model.xml +++ b/documentation/dev-manual/dev-manual-model.xml @@ -1785,8 +1785,14 @@ If you find problems with your code, you can just keep editing and re-testing iteratively until things work as expected. <note>All the modifications you make to the temporary source code - disappear once you <filename>-c clean</filename> or - <filename>-c cleanall</filename> with BitBake for the package. + disappear once you run the + <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 <name_of_package></filename> + and + <filename>bitbake -c cleanall <name_of_package></filename>). Modifications will also disappear if you use the <filename>rm_work</filename> feature as described in the "<ulink url='&YOCTO_DOCS_QS_URL;#building-image'>Building an Image</ulink>" diff --git a/documentation/kernel-dev/kernel-dev-common.xml b/documentation/kernel-dev/kernel-dev-common.xml index 31ffa5c..3ab21e7 100644 --- a/documentation/kernel-dev/kernel-dev-common.xml +++ b/documentation/kernel-dev/kernel-dev-common.xml @@ -445,10 +445,16 @@ You can edit the sources as you would any other Linux source tree. However, keep in mind that you will lose changes if you - trigger the <filename>do_fetch</filename> task for the recipe. - You can avoid triggering this task by not issuing BitBake's - <filename>cleanall</filename>, <filename>cleansstate</filename>, - or forced <filename>fetch</filename> commands. + trigger the + <ulink url='&YOCTO_DOCS_REF_URL;#ref-tasks-fetch'><filename>do_fetch</filename></ulink> + task for the recipe. + 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 with temporary changes or BitBake might run the <filename>fetch</filename> command depending on the |