summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorScott Rifenbark <srifenbark@gmail.com>2016-07-18 11:44:56 -0700
committerRichard Purdie <richard.purdie@linuxfoundation.org>2016-08-01 12:14:59 +0100
commit8f2d8c2061d3dd0dc08ba7b70a10b417e94e62e7 (patch)
treec4255e45c7cdab4555f697d9a4284dd9e7fb6a9f
parent04c611290c1574ea97c960363b15823c382b2b1f (diff)
downloadpoky-8f2d8c2061d3dd0dc08ba7b70a10b417e94e62e7.tar.gz
ref-manual: Fleshed out the do_compile task.
Fixes [YOCTO #9964] Added more detailed information to the do_compile task. Also, provided some information about oe_runmake in the base.bbclass refrence. Finally, put some detail in the "Shared State" section concerning do_deploy[dirs]. (From yocto-docs rev: 5d0612a57cc8e035a2194ada21e65055ef2b8a2e) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
-rw-r--r--documentation/ref-manual/ref-classes.xml7
-rw-r--r--documentation/ref-manual/ref-tasks.xml16
-rw-r--r--documentation/ref-manual/technical-details.xml8
3 files changed, 25 insertions, 6 deletions
diff --git a/documentation/ref-manual/ref-classes.xml b/documentation/ref-manual/ref-classes.xml
index e919bd7eb3..c58c56755b 100644
--- a/documentation/ref-manual/ref-classes.xml
+++ b/documentation/ref-manual/ref-classes.xml
@@ -194,7 +194,14 @@
194 class or the 194 class or the
195 <link linkend='ref-classes-package'><filename>package</filename></link> 195 <link linkend='ref-classes-package'><filename>package</filename></link>
196 class. 196 class.
197 </para>
198
199 <para>
197 The class also contains some commonly used functions such as 200 The class also contains some commonly used functions such as
201 <filename>oe_runmake</filename>, which runs
202 <filename>make</filename> with the arguments specified in
203 <link linkend='var-EXTRA_OEMAKE'><filename>EXTRA_OEMAKE</filename></link>
204 variable as well as the arguments passed directly to
198 <filename>oe_runmake</filename>. 205 <filename>oe_runmake</filename>.
199 </para> 206 </para>
200</section> 207</section>
diff --git a/documentation/ref-manual/ref-tasks.xml b/documentation/ref-manual/ref-tasks.xml
index d2502362d7..9b1e8e3a41 100644
--- a/documentation/ref-manual/ref-tasks.xml
+++ b/documentation/ref-manual/ref-tasks.xml
@@ -69,9 +69,19 @@
69 <title><filename>do_compile</filename></title> 69 <title><filename>do_compile</filename></title>
70 70
71 <para> 71 <para>
72 Compiles the source in the compilation directory, which is pointed 72 Compiles the source code.
73 to by the 73 This task runs with the current working directory set
74 <link linkend='var-B'><filename>B</filename></link> variable. 74 to
75 <filename>${</filename><link linkend='var-B'><filename>B</filename></link><filename>}</filename>.
76 </para>
77
78 <para>
79 The default behavior of this task is to run the
80 <filename>oe_runmake</filename> task if a makefile
81 (<filename>Makefile</filename>, <filename>makefile</filename>,
82 or <filename>GNUmakefile</filename>) is found.
83 If no such file is found, the <filename>do_compile</filename>
84 task does nothing.
75 </para> 85 </para>
76 </section> 86 </section>
77 87
diff --git a/documentation/ref-manual/technical-details.xml b/documentation/ref-manual/technical-details.xml
index 193787d312..8535d2c6e8 100644
--- a/documentation/ref-manual/technical-details.xml
+++ b/documentation/ref-manual/technical-details.xml
@@ -754,11 +754,13 @@
754 section in the BitBake User Manual. 754 section in the BitBake User Manual.
755 </para></listitem> 755 </para></listitem>
756 <listitem><para> 756 <listitem><para>
757 The 757 The <filename>do_deploy[dirs] = "${DEPLOYDIR} ${B}"</filename>
758 <filename>do_deploy[dirs] = "${DEPLOYDIR} ${B}"</filename>
759 line creates <filename>${DEPLOYDIR}</filename> and 758 line creates <filename>${DEPLOYDIR}</filename> and
760 <filename>${B}</filename> before the 759 <filename>${B}</filename> before the
761 <filename>do_deploy</filename> task runs. 760 <filename>do_deploy</filename> task runs, and also sets
761 the current working directory of
762 <filename>do_deploy</filename> to
763 <filename>${B}</filename>.
762 For more information, see the 764 For more information, see the
763 "<ulink url='&YOCTO_DOCS_BB_URL;#variable-flags'>Variable Flags</ulink>" 765 "<ulink url='&YOCTO_DOCS_BB_URL;#variable-flags'>Variable Flags</ulink>"
764 section in the BitBake User Manual. 766 section in the BitBake User Manual.