summaryrefslogtreecommitdiffstats
path: root/documentation/ref-manual
diff options
context:
space:
mode:
authorScott Rifenbark <scott.m.rifenbark@intel.com>2014-04-04 16:43:53 -0700
committerRichard Purdie <richard.purdie@linuxfoundation.org>2014-04-08 14:20:14 +0100
commita8a0e805bb41c00f731fedeac33ff2f2c3ad542a (patch)
tree77bfbbed2d357f83b6ae4d1b54ce3ba9052d729d /documentation/ref-manual
parentb02932eb720de865c60bfb2d5b94110ebc7c16b7 (diff)
downloadpoky-a8a0e805bb41c00f731fedeac33ff2f2c3ad542a.tar.gz
ref-manual: Edits to the 1.6 migration section.
Applied review comments from Paul Eggleton to the section on migrating to the 1.6 version of YP. (From yocto-docs rev: ffd224a16cef4d643cc2c527ad8dc5e15d715faa) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/ref-manual')
-rw-r--r--documentation/ref-manual/migration.xml112
1 files changed, 74 insertions, 38 deletions
diff --git a/documentation/ref-manual/migration.xml b/documentation/ref-manual/migration.xml
index dd5f16017e..9dc0e131d7 100644
--- a/documentation/ref-manual/migration.xml
+++ b/documentation/ref-manual/migration.xml
@@ -1145,15 +1145,15 @@
1145 <title>Python Definition substitutions</title> 1145 <title>Python Definition substitutions</title>
1146 1146
1147 <para> 1147 <para>
1148 had some previously deprecated Python definitions within 1148 BitBake had some previously deprecated Python definitions
1149 its <filename>bb</filename> module removed. 1149 within its <filename>bb</filename> module removed.
1150 You should use their sub-module counterparts instead: 1150 You should use their sub-module counterparts instead:
1151 <itemizedlist> 1151 <itemizedlist>
1152 <listitem><para><filename>bb.MalformedUrl</filename>: 1152 <listitem><para><filename>bb.MalformedUrl</filename>:
1153 Use <filename>bb.fetch.MalformedUrl</filename>. 1153 Use <filename>bb.fetch.MalformedUrl</filename>.
1154 </para></listitem> 1154 </para></listitem>
1155 <listitem><para><filename>bb.encodeurl</filename>: 1155 <listitem><para><filename>bb.fetch.encodeurl</filename>:
1156 Use <filename>bb.fetch: encodeurl</filename>. 1156 Use <filename>bb.fetch.encodeurl</filename>.
1157 </para></listitem> 1157 </para></listitem>
1158 <listitem><para><filename>bb.decodeurl</filename>: 1158 <listitem><para><filename>bb.decodeurl</filename>:
1159 Use <filename>bb.fetch.decodeurl</filename> 1159 Use <filename>bb.fetch.decodeurl</filename>
@@ -1187,6 +1187,20 @@
1187 The SVK fetcher has been removed from BitBake. 1187 The SVK fetcher has been removed from BitBake.
1188 </para> 1188 </para>
1189 </section> 1189 </section>
1190
1191 <section id='migration-1.6-task-taskname-overrides'>
1192 <title><filename>task-&lt;taskname&gt;</filename> Overrides</title>
1193
1194 <para>
1195 <filename>task-&lt;taskname&gt;</filename> overrides have been
1196 adjusted so that tasks whose names contain underscores have the
1197 underscores replaced by hyphens for the override so that they
1198 now function properly.
1199 For example, the task override for
1200 <filename>do_populate_sdk</filename> is
1201 <filename>task-populate-sdk</filename>.
1202 </para>
1203 </section>
1190 </section> 1204 </section>
1191 1205
1192 <section id='migration-1.6-variable-changes'> 1206 <section id='migration-1.6-variable-changes'>
@@ -1210,12 +1224,9 @@
1210 </para> 1224 </para>
1211 1225
1212 <para> 1226 <para>
1213 The check for this does not occur on startup. 1227 The check for this occurs on startup.
1214 If <filename>TMPDIR</filename> is detected on an NFS mount, 1228 If <filename>TMPDIR</filename> is detected on an NFS mount,
1215 an error occurs. 1229 an error occurs.
1216 For more information on this restriction, see the
1217 <filename>TMPDIR</filename> description in the
1218 "<link linkend='ref-variables-glos'>Variables Glossary</link>".
1219 </para> 1230 </para>
1220 </section> 1231 </section>
1221 1232
@@ -1305,14 +1316,14 @@
1305 <para> 1316 <para>
1306 Separate build and source directories have been enabled 1317 Separate build and source directories have been enabled
1307 by default for selected recipes where it is known to work 1318 by default for selected recipes where it is known to work
1308 (a whitelist) and for when using the 1319 (a whitelist) and for all recipes that inherit the
1309 <link linkend='ref-classes-cmake'><filename>cmake</filename></link> 1320 <link linkend='ref-classes-cmake'><filename>cmake</filename></link>
1310 class. 1321 class.
1311 In future releases the 1322 In future releases the
1312 <link linkend='ref-classes-autotools'><filename>autotools</filename></link> 1323 <link linkend='ref-classes-autotools'><filename>autotools</filename></link>
1313 class will enable a separate build directory by default as 1324 class will enable a separate build directory by default as
1314 well. 1325 well.
1315 Recipes building <filename>autotools-based</filename> 1326 Recipes building Autotools-based
1316 software that fails to build with a separate build directory 1327 software that fails to build with a separate build directory
1317 should be changed to inherit from the 1328 should be changed to inherit from the
1318 <link linkend='ref-classes-autotools-brokensep'><filename>autotools-brokensep</filename></link> 1329 <link linkend='ref-classes-autotools-brokensep'><filename>autotools-brokensep</filename></link>
@@ -1327,16 +1338,17 @@
1327 <filename>qemu-native</filename> now builds without 1338 <filename>qemu-native</filename> now builds without
1328 SDL-based graphical output support by default. 1339 SDL-based graphical output support by default.
1329 The following additional lines are needed in your 1340 The following additional lines are needed in your
1330 <filename>local.conf</filename> to enable it. 1341 <filename>local.conf</filename> to enable it:
1331 Remove the comments from the following two lines when you
1332 need to build a headless server:
1333 <literallayout class='monospaced'> 1342 <literallayout class='monospaced'>
1334 PACKAGECONFIG_pn-qemu-native = "sdl" 1343 PACKAGECONFIG_pn-qemu-native = "sdl"
1335 ASSUME_PROVIDED += "libsdl-native" 1344 ASSUME_PROVIDED += "libsdl-native"
1336 </literallayout> 1345 </literallayout>
1337 <note> 1346 <note>
1338 The default <filename>local.conf</filename> 1347 The default <filename>local.conf</filename>
1339 contains these statements as comments. 1348 contains these statements.
1349 Consequently, if you are building a headless system and using
1350 a default <filename>local.conf</filename> file, you will need
1351 comment these two lines out.
1340 </note> 1352 </note>
1341 </para> 1353 </para>
1342 </section> 1354 </section>
@@ -1363,6 +1375,10 @@
1363 The top-level <filename>LICENSE</filename> file has been changed 1375 The top-level <filename>LICENSE</filename> file has been changed
1364 to better describe the license of the various components of 1376 to better describe the license of the various components of
1365 OE-Core. 1377 OE-Core.
1378 However, the licensing itself remains unchanged.
1379 </para>
1380
1381 <para>
1366 Normally, this change would not cause any side-effects. 1382 Normally, this change would not cause any side-effects.
1367 However, some recipes point to this file within 1383 However, some recipes point to this file within
1368 <link linkend='var-LIC_FILES_CHKSUM'><filename>LIC_FILES_CHKSUM</filename></link> 1384 <link linkend='var-LIC_FILES_CHKSUM'><filename>LIC_FILES_CHKSUM</filename></link>
@@ -1370,6 +1386,11 @@
1370 accompanying checksum must be changed from 1386 accompanying checksum must be changed from
1371 3f40d7994397109285ec7b81fdeb3b58 to 1387 3f40d7994397109285ec7b81fdeb3b58 to
1372 4d92cd373abda3937c2bc47fbc49d690. 1388 4d92cd373abda3937c2bc47fbc49d690.
1389 A better alternative is to have
1390 <filename>LIC_FILES_CHKSUM</filename> point to a file
1391 describing the license that is distributed with the source
1392 that the recipe is building, if possible, rather than pointing
1393 to <filename>${COREBASE}/LICENSE</filename>.
1373 </para> 1394 </para>
1374 </section> 1395 </section>
1375 1396
@@ -1380,19 +1401,20 @@
1380 The "-fpermissive" option has been removed from the default 1401 The "-fpermissive" option has been removed from the default
1381 <link linkend='var-CFLAGS'><filename>CFLAGS</filename></link> 1402 <link linkend='var-CFLAGS'><filename>CFLAGS</filename></link>
1382 value. 1403 value.
1383 Individual recipes that fail to build without it should either 1404 You need to take action on individual recipes that fail when
1384 be patched to fix the issues reported by the compiler. 1405 building with this option.
1385 Alternatively, you can add "-fpermissive" to 1406 You need to either patch the recipes to fix the issues reported by
1386 <filename>CFLAGS</filename> in the recipe. 1407 the compiler, or you to add "-fpermissive" to
1408 <filename>CFLAGS</filename> in the recipes.
1387 </para> 1409 </para>
1388 </section> 1410 </section>
1389 1411
1390 <section id='migration-1.6-custom-images'> 1412 <section id='migration-1.6-custom-images'>
1391 <title>Custom Images</title> 1413 <title>Custom Image Output Types</title>
1392 1414
1393 <para> 1415 <para>
1394 Custom image output types, as selected using 1416 Custom image output types, as selected using
1395 <link linkend='var-IMAGE_TYPES'><filename>IMAGE_TYPES</filename></link>, 1417 <link linkend='var-IMAGE_FSTYPES'><filename>IMAGE_FSTYPES</filename></link>,
1396 must declare their dependencies on other image types (if any) using 1418 must declare their dependencies on other image types (if any) using
1397 a new 1419 a new
1398 <link linkend='var-IMAGE_TYPEDEP'><filename>IMAGE_TYPEDEP</filename></link> 1420 <link linkend='var-IMAGE_TYPEDEP'><filename>IMAGE_TYPEDEP</filename></link>
@@ -1401,7 +1423,7 @@
1401 </section> 1423 </section>
1402 1424
1403 <section id='migration-1.6-do-package-write-task'> 1425 <section id='migration-1.6-do-package-write-task'>
1404 <title>Task Recipes</title> 1426 <title>Tasks</title>
1405 1427
1406 <para> 1428 <para>
1407 The <filename>do_package_write</filename> task has been removed. 1429 The <filename>do_package_write</filename> task has been removed.
@@ -1430,21 +1452,7 @@
1430 The <filename>virtclass</filename> overrides are now deprecated. 1452 The <filename>virtclass</filename> overrides are now deprecated.
1431 Use the equivalent class overrides instead (e.g. 1453 Use the equivalent class overrides instead (e.g.
1432 <filename>virtclass-native</filename> becomes 1454 <filename>virtclass-native</filename> becomes
1433 <filename>class-native</filename>. 1455 <filename>class-native</filename>.)
1434 </para>
1435 </section>
1436
1437 <section id='migration-1.6-task-taskname-overrides'>
1438 <title><filename>task-&lt;taskname&gt;</filename> Overrides</title>
1439
1440 <para>
1441 <filename>task-&lt;taskname&gt;</filename> overrides have been
1442 adjusted so that tasks whose names contain underscores have the
1443 underscores replaced by hyphens for the override so that they
1444 now function properly.
1445 For example, the task override for
1446 <filename>do_populate_sdk</filename> is
1447 <filename>task-populate-sdk</filename>.
1448 </para> 1456 </para>
1449 </section> 1457 </section>
1450 1458
@@ -1468,10 +1476,11 @@
1468 <filename>cryptodev-linux</filename>. 1476 <filename>cryptodev-linux</filename>.
1469 </para></listitem> 1477 </para></listitem>
1470 <listitem><para><filename>genext2fs</filename> - 1478 <listitem><para><filename>genext2fs</filename> -
1471 This upstream is no longer needed or maintained. 1479 <filename>genext2fs</filename> is no longer used by the
1480 build system and is unmaintained upstream.
1472 </para></listitem> 1481 </para></listitem>
1473 <listitem><para><filename>js</filename> - 1482 <listitem><para><filename>js</filename> -
1474 This supported an ancient version of Mozilla's javascript 1483 This provided an ancient version of Mozilla's javascript
1475 engine that is no longer needed. 1484 engine that is no longer needed.
1476 </para></listitem> 1485 </para></listitem>
1477 <listitem><para><filename>zaurusd</filename> - 1486 <listitem><para><filename>zaurusd</filename> -
@@ -1524,6 +1533,33 @@
1524 </itemizedlist> 1533 </itemizedlist>
1525 </para> 1534 </para>
1526 </section> 1535 </section>
1536
1537 <section id='migration-1.6-reference-bsps'>
1538 <title>Reference Board Support Packages (BSPs)</title>
1539
1540 <para>
1541 The following reference BSPs changes occurred:
1542 <itemizedlist>
1543 <listitem><para>The BeagleBoard
1544 (<filename>beagleboard</filename>) ARM reference hardware
1545 has been replaced by the BeagleBone
1546 (<filename>beaglebone</filename>) hardware.
1547 </para></listitem>
1548 <listitem><para>The RouterStation Pro
1549 (<filename>routerstationpro</filename>) MIPS reference
1550 hardware has been replaced by the EdgeRouter Lite
1551 (<filename>edgerouter</filename>) hardware.
1552 </para></listitem>
1553 </itemizedlist>
1554 The previous reference BSPs for the
1555 <filename>beagleboard</filename> and
1556 <filename>routerstationpro</filename> machines are still available
1557 in a new <filename>meta-yocto-bsp-old</filename> layer in the
1558 <ulink url='&YOCTO_GIT_URL;'>Source Repositories</ulink>
1559 at
1560 <ulink url='http://git.yoctoproject.org/cgit/cgit.cgi/meta-yocto-bsp-old/'>http://git.yoctoproject.org/cgit/cgit.cgi/meta-yocto-bsp-old/</ulink>.
1561 </para>
1562 </section>
1527</section> 1563</section>
1528</chapter> 1564</chapter>
1529<!-- 1565<!--