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>
This commit is contained in:
Scott Rifenbark 2015-03-30 13:35:44 -07:00 committed by Richard Purdie
parent a92a2036b5
commit c41b060c2e
1 changed files with 12 additions and 12 deletions

View File

@ -1294,10 +1294,16 @@
or or
<ulink url='&YOCTO_DOCS_REF_URL;#structure-memres-core-script'><filename>oe-init-build-env-memres</filename></ulink>). <ulink url='&YOCTO_DOCS_REF_URL;#structure-memres-core-script'><filename>oe-init-build-env-memres</filename></ulink>).
Here is the basic <filename>recipetool</filename> syntax: Here is the basic <filename>recipetool</filename> syntax:
<note>
Running <filename>recipetool -h</filename> or
<filename>recipetool create -h</filename> produces the
Python-generated help, which presented differently
than what follows here.
</note>
<literallayout class='monospaced'> <literallayout class='monospaced'>
recipetool -h recipetool -h
recipetool create [-h] recipetool create [-h]
recipetool [-d] [-q] [--color auto | always | never ] create [-o <replaceable>OUTFILE</replaceable>] [-m] [-x <replaceable>EXTERNALSRC</replaceable>] <replaceable>source</replaceable> recipetool [-d] [-q] [--color auto | always | never ] create -o <replaceable>OUTFILE</replaceable> [-m] [-x <replaceable>EXTERNALSRC</replaceable>] <replaceable>source</replaceable>
-d Enables debug output. -d Enables debug output.
-q Outputs only errors (quiet mode). -q Outputs only errors (quiet mode).
@ -1320,9 +1326,9 @@
</para> </para>
<para> <para>
Running <filename>recipetool</filename> creates the base Running <filename>recipetool create -o</filename>&nbsp;<replaceable>OUTFILE</replaceable>
recipe and locates it properly in the layer that contains creates the base recipe and locates it properly in the
your source files. layer that contains your source files.
Following are some syntax examples: Following are some syntax examples:
</para> </para>
@ -1331,20 +1337,14 @@
Once generated, the recipe resides in the existing source Once generated, the recipe resides in the existing source
code layer: code layer:
<literallayout class='monospaced'> <literallayout class='monospaced'>
recipetool create <replaceable>source</replaceable> recipetool create -o <replaceable>OUTFILE</replaceable>&nbsp;<replaceable>source</replaceable>
</literallayout> </literallayout>
Use this syntax to generate a recipe using code that you Use this syntax to generate a recipe using code that you
extract from <replaceable>source</replaceable>. extract from <replaceable>source</replaceable>.
The extracted code is placed in its own layer defined The extracted code is placed in its own layer defined
by <replaceable>EXTERNALSRC</replaceable>. by <replaceable>EXTERNALSRC</replaceable>.
<literallayout class='monospaced'> <literallayout class='monospaced'>
recipetool create -x <replaceable>EXTERNALSRC</replaceable> <replaceable>source</replaceable> recipetool create -o <replaceable>OUTFILE</replaceable> -x <replaceable>EXTERNALSRC</replaceable> <replaceable>source</replaceable>
</literallayout>
Use this syntax to generate a recipe and override the
tool's default placement of the recipe by specifying both
its location and name using <replaceable>OUTFILE</replaceable>.
<literallayout class='monospaced'>
recipetool create -o <replaceable>OUTFILE</replaceable> <replaceable>source</replaceable>
</literallayout> </literallayout>
Use this syntax to generate a recipe based on <replaceable>source</replaceable>. Use this syntax to generate a recipe based on <replaceable>source</replaceable>.
The options direct <filename>recipetool</filename> to The options direct <filename>recipetool</filename> to