summaryrefslogtreecommitdiffstats
path: root/documentation
diff options
context:
space:
mode:
authorScott Rifenbark <scott.m.rifenbark@intel.com>2014-01-08 08:49:24 -0600
committerRichard Purdie <richard.purdie@linuxfoundation.org>2014-01-21 21:57:57 +0000
commit0e03166f2668553d1fd9f108e17c2167ac33d19f (patch)
treee71b40ff5eea3e2d4e5067451e3c981872cd8b0a /documentation
parent8657f00cfa9af6a88a8593aace5074ef9e35d867 (diff)
downloadpoky-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.xml80
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 d9e31baca5..06555c3c51 100644
--- a/documentation/dev-manual/dev-manual-common-tasks.xml
+++ b/documentation/dev-manual/dev-manual-common-tasks.xml
@@ -1264,55 +1264,53 @@
1264 </para> 1264 </para>
1265 </section> 1265 </section>
1266 1266
1267 <section id='new-recipe-naming-the-recipe'> 1267 <section id='new-recipe-storing-and-naming-the-recipe'>
1268 <title>Naming the Recipe</title> 1268 <title>Storing and Naming the Recipe</title>
1269 1269
1270 <para> 1270 <para>
1271 Once you have your base recipe, you need to name it and be 1271 Once you have your base recipe, you should put it in your
1272 sure that it resides where the OpenEmbedded build system 1272 own layer and name it appropriately.
1273 can find it. 1273 Locating it correctly ensures that the OpenEmbedded build
1274 system can find it when you use BitBake to process the
1275 recipe.
1274 </para> 1276 </para>
1275 1277
1276 <para> 1278 <itemizedlist>
1277 When you name your recipe, you need to follow this naming 1279 <listitem><para><emphasis>Storing Your Recipe:</emphasis>
1278 convention: 1280 The OpenEmbedded build system locates your recipe
1279 <literallayout class='monospaced'> 1281 through the <filename>layer.conf</filename> file and the
1282 <ulink url='&YOCTO_DOCS_REF_URL;#var-BBFILES'><filename>BBFILES</filename></ulink>
1283 variable.
1284 This variable sets up a path from which the build system can
1285 locate recipes.
1286 Here is the typical use:
1287 <literallayout class='monospaced'>
1288 BBFILES += "${LAYERDIR}/recipes-*/*/*.bb \
1289 ${LAYERDIR}/recipes-*/*/*.bbappend"
1290 </literallayout>
1291 Consequently, you need to be sure you locate your new recipe
1292 inside your layer such that it can be found.</para>
1293 <para>You can find more information on how layers are
1294 structured in the
1295 "<link linkend='understanding-and-creating-layers'>Understanding and Creating Layers</link>"
1296 section.</para></listitem>
1297 <listitem><para><emphasis>Naming Your Recipe:</emphasis>
1298 When you name your recipe, you need to follow this naming
1299 convention:
1300 <literallayout class='monospaced'>
1280 &lt;basename&gt;_&lt;version&gt;.bb 1301 &lt;basename&gt;_&lt;version&gt;.bb
1281 </literallayout> 1302 </literallayout>
1282 Use lower-cased characters and do not include the reserved 1303 Use lower-cased characters and do not include the reserved
1283 suffixes <filename>-native</filename>, 1304 suffixes <filename>-native</filename>,
1284 <filename>-cross</filename>, <filename>-initial</filename>, 1305 <filename>-cross</filename>, <filename>-initial</filename>,
1285 or <filename>-dev</filename>. 1306 or <filename>-dev</filename>.
1286 Here are some examples: 1307 Here are some examples:
1287 <literallayout class='monospaced'> 1308 <literallayout class='monospaced'>
1288 cups_1.7.0.bb 1309 cups_1.7.0.bb
1289 gawk_4.0.2.bb 1310 gawk_4.0.2.bb
1290 xdg-utils_1.1.0-rc1.bb 1311 xdg-utils_1.1.0-rc1.bb
1291 </literallayout> 1312 </literallayout></para></listitem>
1292 </para> 1313 </itemizedlist>
1293
1294 <para>
1295 The OpenEmbedded build system locates your recipe through
1296 the <filename>layer.conf</filename> file and the
1297 <ulink url='&YOCTO_DOCS_REF_URL;#var-BBFILES'><filename>BBFILES</filename></ulink>
1298 variable.
1299 This variable sets up a path from which the build system can
1300 locate recipes.
1301 Here is the typical use:
1302 <literallayout class='monospaced'>
1303 BBFILES += "${LAYERDIR}/recipes-*/*/*.bb \
1304 ${LAYERDIR}/recipes-*/*/*.bbappend"
1305 </literallayout>
1306 Consequently, you need to be sure you locate your new recipe
1307 inside your layer such that it can be found.
1308 </para>
1309
1310 <para>
1311 You can find more information on how layers are structured
1312 in the
1313 "<link linkend='understanding-and-creating-layers'>Understanding and Creating Layers</link>"
1314 section.
1315 </para>
1316 </section> 1314 </section>
1317 1315
1318 <section id='new-recipe-running-a-build-on-the-recipe'> 1316 <section id='new-recipe-running-a-build-on-the-recipe'>