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>
This commit is contained in:
Scott Rifenbark 2016-07-18 11:44:56 -07:00 committed by Richard Purdie
parent 04c611290c
commit 8f2d8c2061
3 changed files with 25 additions and 6 deletions

View File

@ -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>

View File

@ -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>

View File

@ -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.