summaryrefslogtreecommitdiffstats
path: root/documentation/ref-manual/migration.xml
diff options
context:
space:
mode:
authorKristi Rifenbark <kristi@buzzcollectivemarketing.com>2018-05-18 18:32:42 (GMT)
committerRichard Purdie <richard.purdie@linuxfoundation.org>2018-05-24 16:16:35 (GMT)
commitbd4438f4a4c945458fa9e373d0fe51886af8f49c (patch)
tree053818166590226cb4a649872602a524b9d544a4 /documentation/ref-manual/migration.xml
parente1b1f83208b52e44bf7b0edff3ebd03a512d24f3 (diff)
downloadpoky-bd4438f4a4c945458fa9e373d0fe51886af8f49c.tar.gz
ref-manual: Finalized edits on the 2.5 Migration section
(From yocto-docs rev: 54259a4d4d69be73e7c614baa2a8d87faa2e3ea5) Signed-off-by: Kristi Rifenbark <kristi@buzzcollectivemarketing.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/ref-manual/migration.xml')
-rw-r--r--documentation/ref-manual/migration.xml196
1 files changed, 88 insertions, 108 deletions
diff --git a/documentation/ref-manual/migration.xml b/documentation/ref-manual/migration.xml
index a4b3aed..b060968 100644
--- a/documentation/ref-manual/migration.xml
+++ b/documentation/ref-manual/migration.xml
@@ -5250,8 +5250,8 @@ id=f4d4f99cfbc2396e49c1613a7d237b9e57f06f81'>commit message</ulink>.
5250 </para></listitem> 5250 </para></listitem>
5251 <listitem><para> 5251 <listitem><para>
5252 <emphasis><filename>libfm-gtk</filename>:</emphasis> 5252 <emphasis><filename>libfm-gtk</filename>:</emphasis>
5253 The <filename>libfm gtk</filename>package and bindings are 5253 The <filename>libfm</filename> GTK+ bindings are split into
5254 split into a separate <filename>libfm-gtk</filename> package. 5254 a separate <filename>libfm-gtk</filename> package.
5255 </para></listitem> 5255 </para></listitem>
5256 <listitem><para> 5256 <listitem><para>
5257 <emphasis><filename>flex-libfl</filename>:</emphasis> 5257 <emphasis><filename>flex-libfl</filename>:</emphasis>
@@ -5274,10 +5274,11 @@ id=f4d4f99cfbc2396e49c1613a7d237b9e57f06f81'>commit message</ulink>.
5274 <filename>grub-efi</filename> recipe. 5274 <filename>grub-efi</filename> recipe.
5275 </para></listitem> 5275 </para></listitem>
5276 <listitem><para> 5276 <listitem><para>
5277 <emphasis>ARMv7-A Legacy Support:</emphasis> 5277 <emphasis>armv7a Legacy Package Feed Support:</emphasis>
5278 Legacy support is removed for transitioning from ARMv7-A 5278 Legacy support is removed for transitioning from
5279 to armv7a-vfp-neon in package feeds, which was previously 5279 <filename>armv7a</filename> to
5280 enabled by setting 5280 <filename>armv7a-vfp-neon</filename> in package feeds,
5281 which was previously enabled by setting
5281 <filename>PKGARCHCOMPAT_ARMV7A</filename>. 5282 <filename>PKGARCHCOMPAT_ARMV7A</filename>.
5282 This transition occurred in 2011 and active package feeds 5283 This transition occurred in 2011 and active package feeds
5283 should by now be updated to the new naming. 5284 should by now be updated to the new naming.
@@ -5303,7 +5304,7 @@ id=f4d4f99cfbc2396e49c1613a7d237b9e57f06f81'>commit message</ulink>.
5303 </para></listitem> 5304 </para></listitem>
5304 <listitem><para> 5305 <listitem><para>
5305 <emphasis><filename>hostap-utils</filename>:</emphasis> 5306 <emphasis><filename>hostap-utils</filename>:</emphasis>
5306 This recipe is obsolete. 5307 This software package is obsolete.
5307 </para></listitem> 5308 </para></listitem>
5308 <listitem><para> 5309 <listitem><para>
5309 <emphasis><filename>latencytop</filename>:</emphasis> 5310 <emphasis><filename>latencytop</filename>:</emphasis>
@@ -5322,12 +5323,12 @@ id=f4d4f99cfbc2396e49c1613a7d237b9e57f06f81'>commit message</ulink>.
5322 </para></listitem> 5323 </para></listitem>
5323 <listitem><para> 5324 <listitem><para>
5324 <emphasis><filename>man</filename>:</emphasis> 5325 <emphasis><filename>man</filename>:</emphasis>
5325 This recipe has been replaced by 5326 This recipe has been replaced by modern
5326 <filename>modern man-db</filename> 5327 <filename>man-db</filename>
5327 </para></listitem> 5328 </para></listitem>
5328 <listitem><para> 5329 <listitem><para>
5329 <emphasis><filename>mkelfimage</filename>:</emphasis> 5330 <emphasis><filename>mkelfimage</filename>:</emphasis>
5330 This recipe has been removed in the upstream coreboot, 5331 This tool has been removed in the upstream coreboot project,
5331 and is no longer needed with the removal of the ELF image 5332 and is no longer needed with the removal of the ELF image
5332 type. 5333 type.
5333 </para></listitem> 5334 </para></listitem>
@@ -5337,25 +5338,24 @@ id=f4d4f99cfbc2396e49c1613a7d237b9e57f06f81'>commit message</ulink>.
5337 </para></listitem> 5338 </para></listitem>
5338 <listitem><para> 5339 <listitem><para>
5339 <emphasis><filename>neon</filename>:</emphasis> 5340 <emphasis><filename>neon</filename>:</emphasis>
5340 This recipe is not maintained upstream and is not used by 5341 This software package is no longer maintained upstream and
5341 anything in OpenEmbedded-Core. 5342 is no longer needed by anything in OpenEmbedded-Core.
5342 </para></listitem> 5343 </para></listitem>
5343 <listitem><para> 5344 <listitem><para>
5344 <emphasis><filename>oprofile</filename>:</emphasis> 5345 <emphasis><filename>oprofile</filename>:</emphasis>
5345 The functionality of this recipe is replaced by 5346 The functionality of this recipe is replaced by
5346 <filename>perf</filename> since keeping ongoing 5347 <filename>perf</filename> and keeping compatibility on
5347 compatibility on with <filename>musl</filename> is 5348 an ongoing basis with <filename>musl</filename> is
5348 difficult. 5349 difficult.
5349 </para></listitem> 5350 </para></listitem>
5350 <listitem><para> 5351 <listitem><para>
5351 <emphasis><filename>pax</filename>:</emphasis> 5352 <emphasis><filename>pax</filename>:</emphasis>
5352 This recipe is obsolete. 5353 This software package is obsolete.
5353 </para></listitem> 5354 </para></listitem>
5354 <listitem><para> 5355 <listitem><para>
5355 <emphasis><filename>stat</filename>:</emphasis> 5356 <emphasis><filename>stat</filename>:</emphasis>
5356 This recipe is not maintained upstream. 5357 This software package is not maintained upstream.
5357 <filename>coreutils</filename> provides a modern binary for 5358 <filename>coreutils</filename> provides a modern stat binary.
5358 the stat recipe.
5359 </para></listitem> 5359 </para></listitem>
5360 <listitem><para> 5360 <listitem><para>
5361 <emphasis><filename>zisofs-tools-native</filename>:</emphasis> 5361 <emphasis><filename>zisofs-tools-native</filename>:</emphasis>
@@ -5410,8 +5410,8 @@ id=f4d4f99cfbc2396e49c1613a7d237b9e57f06f81'>commit message</ulink>.
5410 <listitem><para> 5410 <listitem><para>
5411 <emphasis><filename>scripts/test-dependencies.sh</filename> script:</emphasis> 5411 <emphasis><filename>scripts/test-dependencies.sh</filename> script:</emphasis>
5412 The script is largely made obsolete by the 5412 The script is largely made obsolete by the
5413 recipe-specific <filename>sysroots</filename> 5413 recipe-specific sysroots functionality introduced in the
5414 functionality introduced in the previous release. 5414 previous release.
5415 </para></listitem> 5415 </para></listitem>
5416 </itemizedlist> 5416 </itemizedlist>
5417 </para> 5417 </para>
@@ -5428,11 +5428,13 @@ id=f4d4f99cfbc2396e49c1613a7d237b9e57f06f81'>commit message</ulink>.
5428 There are two different behaviors people might want: 5428 There are two different behaviors people might want:
5429 <itemizedlist> 5429 <itemizedlist>
5430 <listitem><para> 5430 <listitem><para>
5431 <emphasis>Behavior A:</emphasis>
5431 For a given target (or set of targets) look through 5432 For a given target (or set of targets) look through
5432 the task graph and run task X only if it is present 5433 the task graph and run task X only if it is present
5433 and will be built. 5434 and will be built.
5434 </para></listitem> 5435 </para></listitem>
5435 <listitem><para> 5436 <listitem><para>
5437 <emphasis>Behavior B:</emphasis>
5436 For a given target (or set of targets) look through 5438 For a given target (or set of targets) look through
5437 the task graph and run task X if any recipe in the 5439 the task graph and run task X if any recipe in the
5438 taskgraph has such a target, even if it is not in 5440 taskgraph has such a target, even if it is not in
@@ -5440,11 +5442,11 @@ id=f4d4f99cfbc2396e49c1613a7d237b9e57f06f81'>commit message</ulink>.
5440 </para></listitem> 5442 </para></listitem>
5441 </itemizedlist> 5443 </itemizedlist>
5442 The <filename>--runall</filename> option now performs 5444 The <filename>--runall</filename> option now performs
5443 list item (b) mentioned in the previous bullet point. 5445 "Behavior B".
5444 Previously <filename>--runall</filename> behaved like list 5446 Previously <filename>--runall</filename> behaved like
5445 item (a) mentioned in the previous bullet point. 5447 "Behavior A".
5446 A <filename>--runonly</filename> option now exists to 5448 A <filename>--runonly</filename> option has been added to
5447 retain the ability to perform list item (a). 5449 retain the ability to perform "Behavior A".
5448 </para></listitem> 5450 </para></listitem>
5449 <listitem><para> 5451 <listitem><para>
5450 Several explicit "run this task for all recipes in the 5452 Several explicit "run this task for all recipes in the
@@ -5468,6 +5470,44 @@ id=f4d4f99cfbc2396e49c1613a7d237b9e57f06f81'>commit message</ulink>.
5468 </para> 5470 </para>
5469 </section> 5471 </section>
5470 5472
5473 <section id='migration-2.5-python-and-python3-changes'>
5474 <title>Python and Python 3 Changes</title>
5475
5476 <para>
5477 The following are auto-packaging changes to Python and Python 3:
5478 </para>
5479 <para>
5480 The script-managed <filename>python-*-manifest.inc</filename> files
5481 that were previously used to generate Python and Python 3
5482 packages have been replaced with a JSON-based file that is
5483 easier to read and maintain.
5484 A new task is available for maintainers of the Python recipes to
5485 update the JSON file when upgrading to new Python versions.
5486 You can now edit the file directly instead of having to edit a
5487 script and run it to update the file.
5488 </para>
5489 <para>
5490 One particular change to note is that the Python recipes no longer
5491 have build-time provides for their packages.
5492 This assumes <filename>python-foo</filename> is one of the packages
5493 provided by the Python recipe.
5494 You can no longer run <filename>bitbake python-foo</filename> or
5495 have a <ulink url='&YOCTO_DOCS_REF_URL;#var-DEPENDS'><filename>DEPENDS</filename></ulink> on
5496 <filename>python-foo</filename>, but doing either of the following
5497 causes the package to work as expected:
5498 <literallayout class='monospaced'>
5499 IMAGE_INSTALL_append = " python-foo"
5500 </literallayout>
5501 or
5502 <literallayout class='monospaced'>
5503 RDEPENDS_${PN} = "python-foo"
5504 </literallayout>
5505 The earlier build-time provides behavior was a quirk of the way the
5506 Python manifest file was created.
5507 For more information on this change please see
5508 <ulink url='http://git.yoctoproject.org/cgit/cgit.cgi/poky/commit/?id=8d94b9db221d1def42f091b991903faa2d1651ce'>this commit</ulink>.
5509 </para>
5510 </section>
5471 5511
5472 <section id='migration-2.5-miscellaneous-changes'> 5512 <section id='migration-2.5-miscellaneous-changes'>
5473 <title>Miscellaneous Changes</title> 5513 <title>Miscellaneous Changes</title>
@@ -5527,93 +5567,32 @@ id=f4d4f99cfbc2396e49c1613a7d237b9e57f06f81'>commit message</ulink>.
5527 to change back to <filename>make</filename>. 5567 to change back to <filename>make</filename>.
5528 </para></listitem> 5568 </para></listitem>
5529 <listitem><para> 5569 <listitem><para>
5530 <filename>python</filename>:
5531 This command restructures
5532 Python packaging and replaces it with autopackaging.
5533 </para></listitem>
5534 <listitem><para>
5535 <filename>python3</filename>:
5536 This command restructures Python3 packaging and replaces it
5537 with autopackaging.
5538 </para></listitem>
5539 <listitem><para>
5540 The previously deprecated <filename>base_*</filename> 5570 The previously deprecated <filename>base_*</filename>
5541 functions have been removed in favor of their replacements 5571 functions have been removed in favor of their replacements
5542 in <filename>meta/lib/oe</filename> and 5572 in <filename>meta/lib/oe</filename> and
5543 <filename>bitbake/lib/bb</filename>. 5573 <filename>bitbake/lib/bb</filename>.
5544 These are typically used from recipes and classes. 5574 These are typically used from recipes and classes.
5545 Any references to the old functions should be updated. 5575 Any references to the old functions must be updated.
5546 The following is a full list, along with each of their 5576 The following table shows the removed functions and their
5547 replacements: 5577 replacements:
5548 <itemizedlist> 5578
5549 <listitem><para> 5579 <literallayout class='monospaced'>
5550 <filename>base_path_join()</filename> 5580 <emphasis>Removed</emphasis> <emphasis>Replacement</emphasis>
5551 is replaced by 5581 ============================ ============================
5552 <filename>oe.path.join()</filename>. 5582 base_path_join() oe.path.join()
5553 </para></listitem> 5583 base_path_relative() oe.path.relative()
5554 <listitem><para> 5584 base_path_out() oe.path.format_display()
5555 <filename>base_path_relative()</filename> 5585 base_read_file() oe.utils.read_file()
5556 is replaced by 5586 base_ifelse() oe.utils.ifelse()
5557 <filename>oe.path.relative()</filename>. 5587 base_conditional() oe.utils.conditional()
5558 </para></listitem> 5588 base_less_or_equal() oe.utils.less_or_equal()
5559 <listitem><para> 5589 base_version_less_or_equal() oe.utils.version_less_or_equal()
5560 <filename>base_path_out()</filename> 5590 base_contains() bb.utils.contains()
5561 is replaced by 5591 base_both_contain() oe.utils.both_contain()
5562 <filename>oe.path.format_display()</filename>. 5592 base_prune_suffix() oe.utils.prune_suffix()
5563 </para></listitem> 5593 oe_filter() oe.utils.str_filter()
5564 <listitem><para> 5594 oe_filter_out() oe.utils.str_filter_out() (or use the _remove operator).
5565 <filename>base_read_file()</filename> 5595 </literallayout>
5566 is replaced by
5567 <filename>oe.utils.read_file()</filename>.
5568 </para></listitem>
5569 <listitem><para>
5570 <filename>base_ifelse()</filename>
5571 is replaced by
5572 <filename>oe.utils.ifelse()</filename>.
5573 </para></listitem>
5574 <listitem><para>
5575 <filename>base_conditional()</filename>
5576 is replaced by
5577 <filename>oe.utils.conditional()</filename>.
5578 </para></listitem>
5579 <listitem><para>
5580 <filename>base_less_or_equal()</filename>
5581 is replaced by
5582 <filename>oe.utils.less_or_equal()</filename>.
5583 </para></listitem>
5584 <listitem><para>
5585 <filename>base_version_less_or_equal()</filename>
5586 is replaced by
5587 <filename>oe.utils.version_less_or_equal()</filename>.
5588 </para></listitem>
5589 <listitem><para>
5590 <filename>base_contains()</filename>
5591 is replaced by
5592 <filename>bb.utils.contains()</filename>.
5593 </para></listitem>
5594 <listitem><para>
5595 <filename>base_both_contain()</filename>
5596 is replaced by
5597 <filename>oe.utils.both_contain()</filename>.
5598 </para></listitem>
5599 <listitem><para>
5600 <filename>base_prune_suffix()</filename>
5601 is replaced by
5602 <filename>oe.utils.prune_suffix()</filename>.
5603 </para></listitem>
5604 <listitem><para>
5605 <filename>oe_filter()</filename>
5606 is replaced by
5607 <filename>oe.utils.str_filter()</filename>.
5608 </para></listitem>
5609 <listitem><para>
5610 <filename>oe_filter_out()</filename>
5611 is replaced by
5612 <filename>oe.utils.str_filter_out()</filename>
5613 (or use the <filename>_remove</filename>
5614 operator).
5615 </para></listitem>
5616 </itemizedlist>
5617 </para></listitem> 5596 </para></listitem>
5618 <listitem><para> 5597 <listitem><para>
5619 Using <filename>exit 1</filename> to explicitly defer a 5598 Using <filename>exit 1</filename> to explicitly defer a
@@ -5647,7 +5626,7 @@ id=f4d4f99cfbc2396e49c1613a7d237b9e57f06f81'>commit message</ulink>.
5647 unmaintained and <filename>squashfs</filename> provides 5626 unmaintained and <filename>squashfs</filename> provides
5648 better performance and compression. 5627 better performance and compression.
5649 In order to build a live image with squashfs+lz4 compression 5628 In order to build a live image with squashfs+lz4 compression
5650 enabled you set 5629 enabled you should now set
5651 <filename>LIVE_ROOTFS_TYPE = "squashfs-lz4"</filename> 5630 <filename>LIVE_ROOTFS_TYPE = "squashfs-lz4"</filename>
5652 and ensure that <filename>live</filename> 5631 and ensure that <filename>live</filename>
5653 is in <filename>IMAGE_FSTYPES</filename>. 5632 is in <filename>IMAGE_FSTYPES</filename>.
@@ -5687,7 +5666,8 @@ id=f4d4f99cfbc2396e49c1613a7d237b9e57f06f81'>commit message</ulink>.
5687 <filename>LAYERSERIES_COMPAT_layername</filename>, a warning 5666 <filename>LAYERSERIES_COMPAT_layername</filename>, a warning
5688 will is shown. 5667 will is shown.
5689 If a layer sets a value that does not include the current 5668 If a layer sets a value that does not include the current
5690 version, then an error is be produced. 5669 version ("sumo" for the 2.5 release), then an error will be
5670 produced.
5691 </para></listitem> 5671 </para></listitem>
5692 <listitem><para> 5672 <listitem><para>
5693 The <filename>TZ</filename> environment variable is set to 5673 The <filename>TZ</filename> environment variable is set to