diff options
| author | Scott Rifenbark <scott.m.rifenbark@intel.com> | 2014-01-08 08:49:24 -0600 |
|---|---|---|
| committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2014-01-21 21:57:57 +0000 |
| commit | 0e03166f2668553d1fd9f108e17c2167ac33d19f (patch) | |
| tree | e71b40ff5eea3e2d4e5067451e3c981872cd8b0a /documentation | |
| parent | 8657f00cfa9af6a88a8593aace5074ef9e35d867 (diff) | |
| download | ast2050-yocto-poky-0e03166f2668553d1fd9f108e17c2167ac33d19f.zip ast2050-yocto-poky-0e03166f2668553d1fd9f108e17c2167ac33d19f.tar.gz | |
dev-manual: Edits to "Storing and Naming the Recipe"
Re-ordered this such that the storage of the recipe comes first
and that is followed by naming it. Also, formatted into a list
to give a better sense of the suggested order.
(From yocto-docs rev: aead82f034a097cbdfe38b3b1f09a60cc411d6ea)
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.xml | 80 |
1 files changed, 39 insertions, 41 deletions
diff --git a/documentation/dev-manual/dev-manual-common-tasks.xml b/documentation/dev-manual/dev-manual-common-tasks.xml index d9e31ba..06555c3 100644 --- a/documentation/dev-manual/dev-manual-common-tasks.xml +++ b/documentation/dev-manual/dev-manual-common-tasks.xml @@ -1264,55 +1264,53 @@ </para> </section> - <section id='new-recipe-naming-the-recipe'> - <title>Naming the Recipe</title> + <section id='new-recipe-storing-and-naming-the-recipe'> + <title>Storing and Naming the Recipe</title> <para> - Once you have your base recipe, you need to name it and be - sure that it resides where the OpenEmbedded build system - can find it. + Once you have your base recipe, you should put it in your + own layer and name it appropriately. + Locating it correctly ensures that the OpenEmbedded build + system can find it when you use BitBake to process the + recipe. </para> - <para> - When you name your recipe, you need to follow this naming - convention: - <literallayout class='monospaced'> + <itemizedlist> + <listitem><para><emphasis>Storing Your Recipe:</emphasis> + The OpenEmbedded build system locates your recipe + through the <filename>layer.conf</filename> file and the + <ulink url='&YOCTO_DOCS_REF_URL;#var-BBFILES'><filename>BBFILES</filename></ulink> + variable. + This variable sets up a path from which the build system can + locate recipes. + Here is the typical use: + <literallayout class='monospaced'> + BBFILES += "${LAYERDIR}/recipes-*/*/*.bb \ + ${LAYERDIR}/recipes-*/*/*.bbappend" + </literallayout> + Consequently, you need to be sure you locate your new recipe + inside your layer such that it can be found.</para> + <para>You can find more information on how layers are + structured in the + "<link linkend='understanding-and-creating-layers'>Understanding and Creating Layers</link>" + section.</para></listitem> + <listitem><para><emphasis>Naming Your Recipe:</emphasis> + When you name your recipe, you need to follow this naming + convention: + <literallayout class='monospaced'> <basename>_<version>.bb - </literallayout> - Use lower-cased characters and do not include the reserved - suffixes <filename>-native</filename>, - <filename>-cross</filename>, <filename>-initial</filename>, - or <filename>-dev</filename>. - Here are some examples: - <literallayout class='monospaced'> + </literallayout> + Use lower-cased characters and do not include the reserved + suffixes <filename>-native</filename>, + <filename>-cross</filename>, <filename>-initial</filename>, + or <filename>-dev</filename>. + Here are some examples: + <literallayout class='monospaced'> cups_1.7.0.bb gawk_4.0.2.bb xdg-utils_1.1.0-rc1.bb - </literallayout> - </para> - - <para> - The OpenEmbedded build system locates your recipe through - the <filename>layer.conf</filename> file and the - <ulink url='&YOCTO_DOCS_REF_URL;#var-BBFILES'><filename>BBFILES</filename></ulink> - variable. - This variable sets up a path from which the build system can - locate recipes. - Here is the typical use: - <literallayout class='monospaced'> - BBFILES += "${LAYERDIR}/recipes-*/*/*.bb \ - ${LAYERDIR}/recipes-*/*/*.bbappend" - </literallayout> - Consequently, you need to be sure you locate your new recipe - inside your layer such that it can be found. - </para> - - <para> - You can find more information on how layers are structured - in the - "<link linkend='understanding-and-creating-layers'>Understanding and Creating Layers</link>" - section. - </para> + </literallayout></para></listitem> + </itemizedlist> </section> <section id='new-recipe-running-a-build-on-the-recipe'> |
