summaryrefslogtreecommitdiffstats
path: root/documentation
diff options
context:
space:
mode:
authorScott Rifenbark <scott.m.rifenbark@intel.com>2015-03-30 13:35:44 -0700
committerRichard Purdie <richard.purdie@linuxfoundation.org>2015-04-01 17:36:10 +0100
commit2f050af9822a913f04c881cc2590586b8f26d641 (patch)
treea8e5029092795e05186fbedb868ec8e763e720a5 /documentation
parentdbab9c0ba18d07a5f01944919723a63b0f867cb8 (diff)
downloadpoky-2f050af9822a913f04c881cc2590586b8f26d641.tar.gz
dev-manual: Updates to the receiptool section.
Applied review comments from Paul Eggleton. (From yocto-docs rev: 403c9ae5443eaf2a115e2224f07ee19f98c8139d) 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.xml24
1 files changed, 12 insertions, 12 deletions
diff --git a/documentation/dev-manual/dev-manual-common-tasks.xml b/documentation/dev-manual/dev-manual-common-tasks.xml
index 79a3da3437..b35dc2f0a9 100644
--- a/documentation/dev-manual/dev-manual-common-tasks.xml
+++ b/documentation/dev-manual/dev-manual-common-tasks.xml
@@ -1294,10 +1294,16 @@
1294 or 1294 or
1295 <ulink url='&YOCTO_DOCS_REF_URL;#structure-memres-core-script'><filename>oe-init-build-env-memres</filename></ulink>). 1295 <ulink url='&YOCTO_DOCS_REF_URL;#structure-memres-core-script'><filename>oe-init-build-env-memres</filename></ulink>).
1296 Here is the basic <filename>recipetool</filename> syntax: 1296 Here is the basic <filename>recipetool</filename> syntax:
1297 <note>
1298 Running <filename>recipetool -h</filename> or
1299 <filename>recipetool create -h</filename> produces the
1300 Python-generated help, which presented differently
1301 than what follows here.
1302 </note>
1297 <literallayout class='monospaced'> 1303 <literallayout class='monospaced'>
1298 recipetool -h 1304 recipetool -h
1299 recipetool create [-h] 1305 recipetool create [-h]
1300 recipetool [-d] [-q] [--color auto | always | never ] create [-o <replaceable>OUTFILE</replaceable>] [-m] [-x <replaceable>EXTERNALSRC</replaceable>] <replaceable>source</replaceable> 1306 recipetool [-d] [-q] [--color auto | always | never ] create -o <replaceable>OUTFILE</replaceable> [-m] [-x <replaceable>EXTERNALSRC</replaceable>] <replaceable>source</replaceable>
1301 1307
1302 -d Enables debug output. 1308 -d Enables debug output.
1303 -q Outputs only errors (quiet mode). 1309 -q Outputs only errors (quiet mode).
@@ -1320,9 +1326,9 @@
1320 </para> 1326 </para>
1321 1327
1322 <para> 1328 <para>
1323 Running <filename>recipetool</filename> creates the base 1329 Running <filename>recipetool create -o</filename>&nbsp;<replaceable>OUTFILE</replaceable>
1324 recipe and locates it properly in the layer that contains 1330 creates the base recipe and locates it properly in the
1325 your source files. 1331 layer that contains your source files.
1326 Following are some syntax examples: 1332 Following are some syntax examples:
1327 </para> 1333 </para>
1328 1334
@@ -1331,20 +1337,14 @@
1331 Once generated, the recipe resides in the existing source 1337 Once generated, the recipe resides in the existing source
1332 code layer: 1338 code layer:
1333 <literallayout class='monospaced'> 1339 <literallayout class='monospaced'>
1334 recipetool create <replaceable>source</replaceable> 1340 recipetool create -o <replaceable>OUTFILE</replaceable>&nbsp;<replaceable>source</replaceable>
1335 </literallayout> 1341 </literallayout>
1336 Use this syntax to generate a recipe using code that you 1342 Use this syntax to generate a recipe using code that you
1337 extract from <replaceable>source</replaceable>. 1343 extract from <replaceable>source</replaceable>.
1338 The extracted code is placed in its own layer defined 1344 The extracted code is placed in its own layer defined
1339 by <replaceable>EXTERNALSRC</replaceable>. 1345 by <replaceable>EXTERNALSRC</replaceable>.
1340 <literallayout class='monospaced'> 1346 <literallayout class='monospaced'>
1341 recipetool create -x <replaceable>EXTERNALSRC</replaceable> <replaceable>source</replaceable> 1347 recipetool create -o <replaceable>OUTFILE</replaceable> -x <replaceable>EXTERNALSRC</replaceable> <replaceable>source</replaceable>
1342 </literallayout>
1343 Use this syntax to generate a recipe and override the
1344 tool's default placement of the recipe by specifying both
1345 its location and name using <replaceable>OUTFILE</replaceable>.
1346 <literallayout class='monospaced'>
1347 recipetool create -o <replaceable>OUTFILE</replaceable> <replaceable>source</replaceable>
1348 </literallayout> 1348 </literallayout>
1349 Use this syntax to generate a recipe based on <replaceable>source</replaceable>. 1349 Use this syntax to generate a recipe based on <replaceable>source</replaceable>.
1350 The options direct <filename>recipetool</filename> to 1350 The options direct <filename>recipetool</filename> to