summaryrefslogtreecommitdiffstats
path: root/documentation
diff options
context:
space:
mode:
authorScott Rifenbark <scott.m.rifenbark@intel.com>2014-05-07 15:34:02 +0300
committerRichard Purdie <richard.purdie@linuxfoundation.org>2014-05-13 07:50:57 +0100
commit1744a1e5b9132cd9c93556fa10af5642e4738095 (patch)
treefbf761d329b468acff3c3207cc31d7d4c44cd66c /documentation
parentf7a161253f2be622b847fe8f642c5f72532d3210 (diff)
downloadpoky-1744a1e5b9132cd9c93556fa10af5642e4738095.tar.gz
dev-manual: Edits to the "Understanding Recipe Syntax" section.
(From yocto-docs rev: 9808ea79a1e219df794948bd42bc086ab4d56d9f) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation')
-rw-r--r--documentation/dev-manual/dev-manual-common-tasks.xml31
1 files changed, 16 insertions, 15 deletions
diff --git a/documentation/dev-manual/dev-manual-common-tasks.xml b/documentation/dev-manual/dev-manual-common-tasks.xml
index 9c316909e8..55257f7c58 100644
--- a/documentation/dev-manual/dev-manual-common-tasks.xml
+++ b/documentation/dev-manual/dev-manual-common-tasks.xml
@@ -1292,10 +1292,10 @@
1292 <itemizedlist> 1292 <itemizedlist>
1293 <listitem><para><emphasis>Functions:</emphasis> 1293 <listitem><para><emphasis>Functions:</emphasis>
1294 Functions provide a series of actions to be performed. 1294 Functions provide a series of actions to be performed.
1295 Functions are usually used to override the default 1295 You usually use functions to override the default
1296 implementation of a task function, or to compliment 1296 implementation of a task function or to compliment
1297 (append or prepend to an existing function) a default 1297 a default function (i.e. append or prepend to an
1298 function. 1298 existing function).
1299 Standard functions use <filename>sh</filename> shell 1299 Standard functions use <filename>sh</filename> shell
1300 syntax, although access to OpenEmbedded variables and 1300 syntax, although access to OpenEmbedded variables and
1301 internal methods are also available.</para> 1301 internal methods are also available.</para>
@@ -1308,10 +1308,11 @@
1308 mv ${D}${bindir}/sed ${D}${base_bindir}/sed.${PN} 1308 mv ${D}${bindir}/sed ${D}${base_bindir}/sed.${PN}
1309 } 1309 }
1310 </literallayout> 1310 </literallayout>
1311 It is also possible to implement new functions, that 1311 It is also possible to implement new functions that
1312 are not replacing or complimenting the default 1312 are called between existing tasks as long as the
1313 functions, which are called between existing tasks. 1313 new functions are not replacing or complimenting the
1314 It is also possible to implement functions in Python 1314 default functions.
1315 You can implement functions in Python
1315 instead of <filename>sh</filename>. 1316 instead of <filename>sh</filename>.
1316 Both of these options are not seen in the majority of 1317 Both of these options are not seen in the majority of
1317 recipes.</para></listitem> 1318 recipes.</para></listitem>
@@ -1320,7 +1321,7 @@
1320 variable. 1321 variable.
1321 The assignment can be static text or might include 1322 The assignment can be static text or might include
1322 the contents of other variables. 1323 the contents of other variables.
1323 In addition to assignment, appending and prepending 1324 In addition to the assignment, appending and prepending
1324 operations are also supported.</para> 1325 operations are also supported.</para>
1325 <para>The following example shows some of the ways 1326 <para>The following example shows some of the ways
1326 you can use variables in recipes: 1327 you can use variables in recipes:
@@ -1332,12 +1333,12 @@
1332 </literallayout> 1333 </literallayout>
1333 </para></listitem> 1334 </para></listitem>
1334 <listitem><para><emphasis>Keywords:</emphasis> 1335 <listitem><para><emphasis>Keywords:</emphasis>
1335 Only a few keywords are used in BitBake recipes. 1336 BitBake recipes use only a few keywords.
1336 Keywords are used for things such as including common 1337 You use keywords to include common
1337 functions (<filename>inherit</filename>), loading parts 1338 functions (<filename>inherit</filename>), load parts
1338 of a recipe from other files 1339 of a recipe from other files
1339 (<filename>include</filename> and 1340 (<filename>include</filename> and
1340 <filename>require</filename>) and exporting variables 1341 <filename>require</filename>) and export variables
1341 to the environment (<filename>export</filename>).</para> 1342 to the environment (<filename>export</filename>).</para>
1342 <para>The following example shows the use of some of 1343 <para>The following example shows the use of some of
1343 these keywords: 1344 these keywords:
@@ -1367,7 +1368,7 @@
1367 chapter in the BitBake User Manual. 1368 chapter in the BitBake User Manual.
1368 <itemizedlist> 1369 <itemizedlist>
1369 <listitem><para><emphasis>Line Continuation: <filename>\</filename></emphasis> - 1370 <listitem><para><emphasis>Line Continuation: <filename>\</filename></emphasis> -
1370 Use the backward slash (<filename>\</filename> 1371 Use the backward slash (<filename>\</filename>)
1371 character to split a statement over multiple lines. 1372 character to split a statement over multiple lines.
1372 Place the slash character at the end of the line that 1373 Place the slash character at the end of the line that
1373 is to be continued on the next line: 1374 is to be continued on the next line:
@@ -1551,7 +1552,7 @@
1551 <filename>grep</filename>, <filename>awk</filename>, 1552 <filename>grep</filename>, <filename>awk</filename>,
1552 and so forth) that you might wish to use. 1553 and so forth) that you might wish to use.
1553 If in doubt, you should check with multiple 1554 If in doubt, you should check with multiple
1554 implementations - including those from busybox. 1555 implementations - including those from BusyBox.
1555 </para></listitem> 1556 </para></listitem>
1556 </itemizedlist> 1557 </itemizedlist>
1557 </para> 1558 </para>