diff options
author | Scott Rifenbark <srifenbark@gmail.com> | 2018-05-31 11:10:40 -0700 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2018-06-15 11:26:46 +0100 |
commit | 815d8296005edb1e15e5b4ac2cfa3a9370340f74 (patch) | |
tree | 24a9c80cc7296c3d178fe27d46931bf2bad31b4e /documentation | |
parent | 6068e017e8c8d439d23651a0f985e85a824a5e20 (diff) | |
download | poky-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')
-rw-r--r-- | documentation/sdk-manual/sdk-extensible.xml | 31 |
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 @@ | |||
1393 | <title>Working With Recipes</title> | 1393 | <title>Working With Recipes</title> |
1394 | 1394 | ||
1395 | <para> | 1395 | <para> |
1396 | When building a recipe with <filename>devtool build</filename>, the | 1396 | When building a recipe using the |
1397 | typical build progression is as follows: | 1397 | <filename>devtool build</filename> command, the typical build |
1398 | progresses as follows: | ||
1398 | <orderedlist> | 1399 | <orderedlist> |
1399 | <listitem><para> | 1400 | <listitem><para> |
1400 | Fetch the source | 1401 | Fetch the source |
@@ -1406,7 +1407,7 @@ | |||
1406 | Configure the source | 1407 | Configure the source |
1407 | </para></listitem> | 1408 | </para></listitem> |
1408 | <listitem><para> | 1409 | <listitem><para> |
1409 | Compiling the source | 1410 | Compile the source |
1410 | </para></listitem> | 1411 | </para></listitem> |
1411 | <listitem><para> | 1412 | <listitem><para> |
1412 | Install the build output | 1413 | Install the build output |
@@ -1417,10 +1418,13 @@ | |||
1417 | </orderedlist> | 1418 | </orderedlist> |
1418 | For recipes in the workspace, fetching and unpacking is disabled | 1419 | For recipes in the workspace, fetching and unpacking is disabled |
1419 | as the source tree has already been prepared and is persistent. | 1420 | as the source tree has already been prepared and is persistent. |
1420 | Each of these build steps is defined as a function, usually with a | 1421 | Each of these build steps is defined as a function (task), usually |
1421 | "do_" prefix. | 1422 | with a "do_" prefix (e.g. |
1422 | These functions are typically shell scripts but can instead be written | 1423 | <ulink url='&YOCTO_DOCS_REF_URL;#ref-tasks-fetch'><filename>do_fetch</filename></ulink>, |
1423 | in Python. | 1424 | <ulink url='&YOCTO_DOCS_REF_URL;#ref-tasks-unpack'><filename>do_unpack</filename></ulink>, |
1425 | and so forth). | ||
1426 | These functions are typically shell scripts but can instead be | ||
1427 | written in Python. | ||
1424 | </para> | 1428 | </para> |
1425 | 1429 | ||
1426 | <para> | 1430 | <para> |
@@ -1428,12 +1432,13 @@ | |||
1428 | recipe does not include complete instructions for building the | 1432 | recipe does not include complete instructions for building the |
1429 | software. | 1433 | software. |
1430 | Instead, common functionality is encapsulated in classes inherited | 1434 | Instead, common functionality is encapsulated in classes inherited |
1431 | with the <filename>inherit</filename> directive, leaving the recipe | 1435 | with the <filename>inherit</filename> directive. |
1432 | to describe just the things that are specific to the software to be | 1436 | This technique leaves the recipe to describe just the things that |
1433 | built. | 1437 | are specific to the software being built. |
1434 | A <ulink url='&YOCTO_DOCS_REF_URL;#ref-classes-base'><filename>base</filename></ulink> | 1438 | A |
1435 | class exists that is implicitly inherited by all recipes and provides | 1439 | <ulink url='&YOCTO_DOCS_REF_URL;#ref-classes-base'><filename>base</filename></ulink> |
1436 | the functionality that most typical recipes need. | 1440 | class exists that is implicitly inherited by all recipes and |
1441 | provides the functionality that most recipes typically need. | ||
1437 | </para> | 1442 | </para> |
1438 | 1443 | ||
1439 | <para> | 1444 | <para> |