summaryrefslogtreecommitdiffstats
path: root/documentation/sdk-manual
diff options
context:
space:
mode:
authorScott Rifenbark <srifenbark@gmail.com>2018-05-31 11:10:40 -0700
committerRichard Purdie <richard.purdie@linuxfoundation.org>2018-06-15 11:26:46 +0100
commit815d8296005edb1e15e5b4ac2cfa3a9370340f74 (patch)
tree24a9c80cc7296c3d178fe27d46931bf2bad31b4e /documentation/sdk-manual
parent6068e017e8c8d439d23651a0f985e85a824a5e20 (diff)
downloadopenembedded-core-contrib-815d8296005edb1e15e5b4ac2cfa3a9370340f74.tar.gz
sdk-manual: Added links to sample tasks to "Working With Recipes"
(From yocto-docs rev: 6dd62a3f97dc4e70a532faae0055ef7937f40afc) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/sdk-manual')
-rw-r--r--documentation/sdk-manual/sdk-extensible.xml31
1 files changed, 18 insertions, 13 deletions
diff --git a/documentation/sdk-manual/sdk-extensible.xml b/documentation/sdk-manual/sdk-extensible.xml
index 9546bedc52..d758872b8a 100644
--- a/documentation/sdk-manual/sdk-extensible.xml
+++ b/documentation/sdk-manual/sdk-extensible.xml
@@ -1393,8 +1393,9 @@
<title>Working With Recipes</title>
<para>
- When building a recipe with <filename>devtool build</filename>, the
- typical build progression is as follows:
+ When building a recipe using the
+ <filename>devtool build</filename> command, the typical build
+ progresses as follows:
<orderedlist>
<listitem><para>
Fetch the source
@@ -1406,7 +1407,7 @@
Configure the source
</para></listitem>
<listitem><para>
- Compiling the source
+ Compile the source
</para></listitem>
<listitem><para>
Install the build output
@@ -1417,10 +1418,13 @@
</orderedlist>
For recipes in the workspace, fetching and unpacking is disabled
as the source tree has already been prepared and is persistent.
- Each of these build steps is defined as a function, usually with a
- "do_" prefix.
- These functions are typically shell scripts but can instead be written
- in Python.
+ Each of these build steps is defined as a function (task), usually
+ with a "do_" prefix (e.g.
+ <ulink url='&YOCTO_DOCS_REF_URL;#ref-tasks-fetch'><filename>do_fetch</filename></ulink>,
+ <ulink url='&YOCTO_DOCS_REF_URL;#ref-tasks-unpack'><filename>do_unpack</filename></ulink>,
+ and so forth).
+ These functions are typically shell scripts but can instead be
+ written in Python.
</para>
<para>
@@ -1428,12 +1432,13 @@
recipe does not include complete instructions for building the
software.
Instead, common functionality is encapsulated in classes inherited
- with the <filename>inherit</filename> directive, leaving the recipe
- to describe just the things that are specific to the software to be
- built.
- A <ulink url='&YOCTO_DOCS_REF_URL;#ref-classes-base'><filename>base</filename></ulink>
- class exists that is implicitly inherited by all recipes and provides
- the functionality that most typical recipes need.
+ with the <filename>inherit</filename> directive.
+ This technique leaves the recipe to describe just the things that
+ are specific to the software being built.
+ A
+ <ulink url='&YOCTO_DOCS_REF_URL;#ref-classes-base'><filename>base</filename></ulink>
+ class exists that is implicitly inherited by all recipes and
+ provides the functionality that most recipes typically need.
</para>
<para>