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>

diff --git a/documentation/ref-manual/ref-classes.xml b/documentation/ref-manual/ref-classes.xml
index e919bd7eb36356dead492e6148bec91c611f9897..c58c56755b14640a28e4f488c0ed2fad17564ade 100644 (file)
--- a/documentation/ref-manual/ref-classes.xml
+++ b/documentation/ref-manual/ref-classes.xml
@@ -194,7 +194,14 @@
         class or the
         <link linkend='ref-classes-package'><filename>package</filename></link>
         class.
+    </para>
+
+    <para>
         The class also contains some commonly used functions such as
+        <filename>oe_runmake</filename>, which runs
+        <filename>make</filename> with the arguments specified in
+        <link linkend='var-EXTRA_OEMAKE'><filename>EXTRA_OEMAKE</filename></link>
+        variable as well as the arguments passed directly to
         <filename>oe_runmake</filename>.
     </para>
 </section>

diff --git a/documentation/ref-manual/ref-tasks.xml b/documentation/ref-manual/ref-tasks.xml
index d2502362d76aa7db0d5af348b2293cae84867ed3..9b1e8e3a411c03208818ddea104cf685801e74e0 100644 (file)
--- a/documentation/ref-manual/ref-tasks.xml
+++ b/documentation/ref-manual/ref-tasks.xml
@@ -69,9 +69,19 @@
         <title><filename>do_compile</filename></title>
 
         <para>
-            Compiles the source in the compilation directory, which is pointed
-            to by the
-            <link linkend='var-B'><filename>B</filename></link> variable.
+            Compiles the source code.
+            This task runs with the current working directory set
+            to
+            <filename>${</filename><link linkend='var-B'><filename>B</filename></link><filename>}</filename>.
+        </para>
+
+        <para>
+            The default behavior of this task is to run the
+            <filename>oe_runmake</filename> task if a makefile
+            (<filename>Makefile</filename>, <filename>makefile</filename>,
+            or <filename>GNUmakefile</filename>) is found.
+            If no such file is found, the <filename>do_compile</filename>
+            task does nothing.
         </para>
     </section>
 

diff --git a/documentation/ref-manual/technical-details.xml b/documentation/ref-manual/technical-details.xml
index 193787d312ea756e8a97c7ef5b66f30c4d57432b..8535d2c6e82364a6e398f7f479fa302dca88f1ce 100644 (file)
--- a/documentation/ref-manual/technical-details.xml
+++ b/documentation/ref-manual/technical-details.xml
@@ -754,11 +754,13 @@
                     section in the BitBake User Manual.
                     </para></listitem>
                 <listitem><para>
-                    The
-                    <filename>do_deploy[dirs] = "${DEPLOYDIR} ${B}"</filename>
+                    The <filename>do_deploy[dirs] = "${DEPLOYDIR} ${B}"</filename>
                     line creates <filename>${DEPLOYDIR}</filename> and
                     <filename>${B}</filename> before the
-                    <filename>do_deploy</filename> task runs.
+                    <filename>do_deploy</filename> task runs, and also sets
+                    the current working directory of
+                    <filename>do_deploy</filename> to
+                    <filename>${B}</filename>.
                     For more information, see the
                     "<ulink url='&YOCTO_DOCS_BB_URL;#variable-flags'>Variable Flags</ulink>"
                     section in the BitBake User Manual.