blob: ade8787b4d6611af306d144ece35bdc23161f26f [file] [log] [blame]
Patrick Williamsc124f4f2015-09-15 14:41:29 -05001<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
2"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"
3[<!ENTITY % poky SYSTEM "../poky.ent"> %poky; ] >
4
5<chapter id='migration'>
6<title>Migrating to a Newer Yocto Project Release</title>
7
8 <para>
9 This chapter provides information you can use to migrate work to a
10 newer Yocto Project release. You can find the same information in the
11 release notes for a given release.
12 </para>
13
14<section id='general-migration-considerations'>
15 <title>General Migration Considerations</title>
16
17 <para>
18 Some considerations are not tied to a specific Yocto Project
19 release.
20 This section presents information you should consider when
21 migrating to any new Yocto Project release.
22 <itemizedlist>
23 <listitem><para><emphasis>Dealing with Customized Recipes</emphasis>:
24 Issues could arise if you take older recipes that contain
25 customizations and simply copy them forward expecting them
26 to work after you migrate to new Yocto Project metadata.
27 For example, suppose you have a recipe in your layer that is
28 a customized version of a core recipe copied from the earlier
29 release, rather than through the use of an append file.
30 When you migrate to a newer version of Yocto Project, the
31 metadata (e.g. perhaps an include file used by the recipe)
32 could have changed in a way that would break the build.
33 Say, for example, a function is removed from an include file
34 and the customized recipe tries to call that function.
35 </para>
36
37 <para>You could "forward-port" all your customizations in your
38 recipe so that everything works for the new release.
39 However, this is not the optimal solution as you would have
40 to repeat this process with each new release if changes
41 occur that give rise to problems.</para>
42
43 <para>The better solution (where practical) is to use append
44 files (<filename>*.bbappend</filename>) to capture any
45 customizations you want to make to a recipe.
46 Doing so, isolates your changes from the main recipe making
47 them much more manageable.
48 However, sometimes it is not practical to use an append
49 file.
50 A good example of this is when introducing a newer or older
51 version of a recipe in another layer.</para>
52 </listitem>
53 <listitem><para><emphasis>Updating Append Files</emphasis>:
54 Since append files generally only contain your customizations,
55 they often do not need to be adjusted for new releases.
56 However, if the <filename>.bbappend</filename> file is
57 specific to a particular version of the recipe (i.e. its
58 name does not use the % wildcard) and the version of the
59 recipe to which it is appending has changed, then you will
60 at a minimum need to rename the append file to match the
61 name of the recipe file.
62 A mismatch between an append file and its corresponding
63 recipe file (<filename>.bb</filename>) will
64 trigger an error during parsing.</para>
65 <para>Depending on the type of customization the append file
66 applies, other incompatibilities might occur when you
67 upgrade.
68 For example, if your append file applies a patch and the
69 recipe to which it is appending is updated to a newer
70 version, the patch might no longer apply.
71 If this is the case and assuming the patch is still needed,
72 you must modify the patch file so that it does apply.
73 </para></listitem>
74 </itemizedlist>
75 </para>
76</section>
77
78<section id='moving-to-the-yocto-project-1.3-release'>
79 <title>Moving to the Yocto Project 1.3 Release</title>
80
81 <para>
82 This section provides migration information for moving to the
83 Yocto Project 1.3 Release from the prior release.
84 </para>
85
86 <section id='1.3-local-configuration'>
87 <title>Local Configuration</title>
88
89 <para>
90 Differences include changes for
91 <link linkend='var-SSTATE_MIRRORS'><filename>SSTATE_MIRRORS</filename></link>
92 and <filename>bblayers.conf</filename>.
93 </para>
94
95 <section id='migration-1.3-sstate-mirrors'>
96 <title>SSTATE_MIRRORS</title>
97
98 <para>
99 The shared state cache (sstate-cache), as pointed to by
Patrick Williamsd8c66bc2016-06-20 12:57:21 -0500100 <link linkend='var-SSTATE_DIR'><filename>SSTATE_DIR</filename></link>,
101 by default now has two-character subdirectories to prevent
102 issues arising from too many files in the same directory.
103 Also, native sstate-cache packages, which are built to run
104 on the host system, will go into a subdirectory named using
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500105 the distro ID string.
Patrick Williamsd8c66bc2016-06-20 12:57:21 -0500106 If you copy the newly structured sstate-cache to a mirror
107 location (either local or remote) and then point to it in
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500108 <link linkend='var-SSTATE_MIRRORS'><filename>SSTATE_MIRRORS</filename></link>,
109 you need to append "PATH" to the end of the mirror URL so that
110 the path used by BitBake before the mirror substitution is
111 appended to the path used to access the mirror.
112 Here is an example:
113 <literallayout class='monospaced'>
114 SSTATE_MIRRORS = "file://.* http://<replaceable>someserver</replaceable>.tld/share/sstate/PATH"
115 </literallayout>
116 </para>
117 </section>
118
119 <section id='migration-1.3-bblayers-conf'>
120 <title>bblayers.conf</title>
121
122 <para>
123 The <filename>meta-yocto</filename> layer consists of two parts
124 that correspond to the Poky reference distribution and the
125 reference hardware Board Support Packages (BSPs), respectively:
126 <filename>meta-yocto</filename> and
127 <filename>meta-yocto-bsp</filename>.
Patrick Williamsd8c66bc2016-06-20 12:57:21 -0500128 When running BitBake for the first time after upgrading,
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500129 your <filename>conf/bblayers.conf</filename> file will be
130 updated to handle this change and you will be asked to
131 re-run or restart for the changes to take effect.
132 </para>
133 </section>
134 </section>
135
136 <section id='1.3-recipes'>
137 <title>Recipes</title>
138
139 <para>
140 Differences include changes for the following:
141 <itemizedlist>
142 <listitem><para>Python function whitespace</para></listitem>
143 <listitem><para><filename>proto=</filename> in <filename>SRC_URI</filename></para></listitem>
144 <listitem><para><filename>nativesdk</filename></para></listitem>
145 <listitem><para>Task recipes</para></listitem>
146 <listitem><para><filename>IMAGE_FEATURES</filename></para></listitem>
147 <listitem><para>Removed recipes</para></listitem>
148 </itemizedlist>
149 </para>
150
151 <section id='migration-1.3-python-function-whitespace'>
152 <title>Python Function Whitespace</title>
153
154 <para>
155 All Python functions must now use four spaces for indentation.
156 Previously, an inconsistent mix of spaces and tabs existed,
157 which made extending these functions using
158 <filename>_append</filename> or <filename>_prepend</filename>
159 complicated given that Python treats whitespace as
160 syntactically significant.
161 If you are defining or extending any Python functions (e.g.
162 <filename>populate_packages</filename>, <filename>do_unpack</filename>,
163 <filename>do_patch</filename> and so forth) in custom recipes
164 or classes, you need to ensure you are using consistent
165 four-space indentation.
166 </para>
167 </section>
168
169 <section id='migration-1.3-proto=-in-src-uri'>
170 <title>proto= in SRC_URI</title>
171
172 <para>
173 Any use of <filename>proto=</filename> in
174 <link linkend='var-SRC_URI'><filename>SRC_URI</filename></link>
175 needs to be changed to <filename>protocol=</filename>.
176 In particular, this applies to the following URIs:
177 <itemizedlist>
178 <listitem><para><filename>svn://</filename></para></listitem>
179 <listitem><para><filename>bzr://</filename></para></listitem>
180 <listitem><para><filename>hg://</filename></para></listitem>
181 <listitem><para><filename>osc://</filename></para></listitem>
182 </itemizedlist>
183 Other URIs were already using <filename>protocol=</filename>.
184 This change improves consistency.
185 </para>
186 </section>
187
188 <section id='migration-1.3-nativesdk'>
189 <title>nativesdk</title>
190
191 <para>
192 The suffix <filename>nativesdk</filename> is now implemented
193 as a prefix, which simplifies a lot of the packaging code for
194 <filename>nativesdk</filename> recipes.
Patrick Williamsd8c66bc2016-06-20 12:57:21 -0500195 All custom <filename>nativesdk</filename> recipes, which are
196 relocatable packages that are native to
197 <link linkend='var-SDK_ARCH'><filename>SDK_ARCH</filename></link>,
198 and any references need to be updated to use
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500199 <filename>nativesdk-*</filename> instead of
200 <filename>*-nativesdk</filename>.
201 </para>
202 </section>
203
204 <section id='migration-1.3-task-recipes'>
205 <title>Task Recipes</title>
206
207 <para>
208 "Task" recipes are now known as "Package groups" and have
209 been renamed from <filename>task-*.bb</filename> to
210 <filename>packagegroup-*.bb</filename>.
211 Existing references to the previous <filename>task-*</filename>
212 names should work in most cases as there is an automatic
213 upgrade path for most packages.
214 However, you should update references in your own recipes and
215 configurations as they could be removed in future releases.
216 You should also rename any custom <filename>task-*</filename>
217 recipes to <filename>packagegroup-*</filename>, and change
218 them to inherit <filename>packagegroup</filename> instead of
219 <filename>task</filename>, as well as taking the opportunity
220 to remove anything now handled by
221 <filename>packagegroup.bbclass</filename>, such as providing
222 <filename>-dev</filename> and <filename>-dbg</filename>
223 packages, setting
224 <link linkend='var-LIC_FILES_CHKSUM'><filename>LIC_FILES_CHKSUM</filename></link>,
225 and so forth.
226 See the
227 "<link linkend='ref-classes-packagegroup'><filename>packagegroup.bbclass</filename></link>"
228 section for further details.
229 </para>
230 </section>
231
232 <section id='migration-1.3-image-features'>
233 <title>IMAGE_FEATURES</title>
234
235 <para>
236 Image recipes that previously included "apps-console-core"
237 in <link linkend='var-IMAGE_FEATURES'><filename>IMAGE_FEATURES</filename></link>
238 should now include "splash" instead to enable the boot-up
239 splash screen.
240 Retaining "apps-console-core" will still include the splash
241 screen but generates a warning.
242 The "apps-x11-core" and "apps-x11-games"
243 <filename>IMAGE_FEATURES</filename> features have been removed.
244 </para>
245 </section>
246
247 <section id='migration-1.3-removed-recipes'>
248 <title>Removed Recipes</title>
249
250 <para>
251 The following recipes have been removed.
252 For most of them, it is unlikely that you would have any
253 references to them in your own
Brad Bishopd7bf8c12018-02-25 22:55:05 -0500254 <link linkend='metadata'>Metadata</link>.
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500255 However, you should check your metadata against this list to be sure:
256 <itemizedlist>
257 <listitem><para><emphasis><filename>libx11-trim</filename></emphasis>:
258 Replaced by <filename>libx11</filename>, which has a negligible
259 size difference with modern Xorg.</para></listitem>
260 <listitem><para><emphasis><filename>xserver-xorg-lite</filename></emphasis>:
261 Use <filename>xserver-xorg</filename>, which has a negligible
262 size difference when DRI and GLX modules are not installed.</para></listitem>
263 <listitem><para><emphasis><filename>xserver-kdrive</filename></emphasis>:
264 Effectively unmaintained for many years.</para></listitem>
265 <listitem><para><emphasis><filename>mesa-xlib</filename></emphasis>:
266 No longer serves any purpose.</para></listitem>
267 <listitem><para><emphasis><filename>galago</filename></emphasis>:
268 Replaced by telepathy.</para></listitem>
269 <listitem><para><emphasis><filename>gail</filename></emphasis>:
270 Functionality was integrated into GTK+ 2.13.</para></listitem>
271 <listitem><para><emphasis><filename>eggdbus</filename></emphasis>:
272 No longer needed.</para></listitem>
273 <listitem><para><emphasis><filename>gcc-*-intermediate</filename></emphasis>:
274 The build has been restructured to avoid the need for
275 this step.</para></listitem>
276 <listitem><para><emphasis><filename>libgsmd</filename></emphasis>:
277 Unmaintained for many years.
278 Functionality now provided by
279 <filename>ofono</filename> instead.</para></listitem>
280 <listitem><para><emphasis>contacts, dates, tasks, eds-tools</emphasis>:
281 Largely unmaintained PIM application suite.
282 It has been moved to <filename>meta-gnome</filename>
283 in <filename>meta-openembedded</filename>.</para></listitem>
284 </itemizedlist>
285 In addition to the previously listed changes, the
286 <filename>meta-demoapps</filename> directory has also been removed
287 because the recipes in it were not being maintained and many
288 had become obsolete or broken.
289 Additionally, these recipes were not parsed in the default configuration.
290 Many of these recipes are already provided in an updated and
291 maintained form within the OpenEmbedded community layers such as
292 <filename>meta-oe</filename> and <filename>meta-gnome</filename>.
293 For the remainder, you can now find them in the
294 <filename>meta-extras</filename> repository, which is in the
295 Yocto Project
Brad Bishop316dfdd2018-06-25 12:45:53 -0400296 <ulink url='&YOCTO_DOCS_OM_URL;#source-repositories'>Source Repositories</ulink>.
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500297 </para>
298 </section>
299 </section>
300
301 <section id='1.3-linux-kernel-naming'>
302 <title>Linux Kernel Naming</title>
303
304 <para>
305 The naming scheme for kernel output binaries has been changed to
306 now include
307 <link linkend='var-PE'><filename>PE</filename></link> as part of the
308 filename:
309 <literallayout class='monospaced'>
310 KERNEL_IMAGE_BASE_NAME ?= "${KERNEL_IMAGETYPE}-${PE}-${PV}-${PR}-${MACHINE}-${DATETIME}"
311 </literallayout>
312 </para>
313
314 <para>
315 Because the <filename>PE</filename> variable is not set by default,
316 these binary files could result with names that include two dash
317 characters.
318 Here is an example:
319 <literallayout class='monospaced'>
320 bzImage--3.10.9+git0+cd502a8814_7144bcc4b8-r0-qemux86-64-20130830085431.bin
321 </literallayout>
322 </para>
323 </section>
324</section>
325
326<section id='moving-to-the-yocto-project-1.4-release'>
327 <title>Moving to the Yocto Project 1.4 Release</title>
328
329 <para>
330 This section provides migration information for moving to the
331 Yocto Project 1.4 Release from the prior release.
332 </para>
333
334 <section id='migration-1.4-bitbake'>
335 <title>BitBake</title>
336
337 <para>
338 Differences include the following:
339 <itemizedlist>
340 <listitem><para><emphasis>Comment Continuation:</emphasis>
341 If a comment ends with a line continuation (\) character,
342 then the next line must also be a comment.
343 Any instance where this is not the case, now triggers
344 a warning.
345 You must either remove the continuation character, or be
346 sure the next line is a comment.
347 </para></listitem>
348 <listitem><para><emphasis>Package Name Overrides:</emphasis>
349 The runtime package specific variables
350 <link linkend='var-RDEPENDS'><filename>RDEPENDS</filename></link>,
351 <link linkend='var-RRECOMMENDS'><filename>RRECOMMENDS</filename></link>,
352 <link linkend='var-RSUGGESTS'><filename>RSUGGESTS</filename></link>,
353 <link linkend='var-RPROVIDES'><filename>RPROVIDES</filename></link>,
354 <link linkend='var-RCONFLICTS'><filename>RCONFLICTS</filename></link>,
355 <link linkend='var-RREPLACES'><filename>RREPLACES</filename></link>,
356 <link linkend='var-FILES'><filename>FILES</filename></link>,
357 <link linkend='var-ALLOW_EMPTY'><filename>ALLOW_EMPTY</filename></link>,
358 and the pre, post, install, and uninstall script functions
359 <filename>pkg_preinst</filename>,
360 <filename>pkg_postinst</filename>,
361 <filename>pkg_prerm</filename>, and
362 <filename>pkg_postrm</filename> should always have a
363 package name override.
364 For example, use <filename>RDEPENDS_${PN}</filename> for
365 the main package instead of <filename>RDEPENDS</filename>.
366 BitBake uses more strict checks when it parses recipes.
367 </para></listitem>
368 </itemizedlist>
369 </para>
370 </section>
371
372 <section id='migration-1.4-build-behavior'>
373 <title>Build Behavior</title>
374
375 <para>
376 Differences include the following:
377 <itemizedlist>
378 <listitem><para><emphasis>Shared State Code:</emphasis>
379 The shared state code has been optimized to avoid running
380 unnecessary tasks.
381 For example, the following no longer populates the target
382 sysroot since that is not necessary:
383 <literallayout class='monospaced'>
384 $ bitbake -c rootfs <replaceable>some-image</replaceable>
385 </literallayout>
386 Instead, the system just needs to extract the output
387 package contents, re-create the packages, and construct
388 the root filesystem.
389 This change is unlikely to cause any problems unless
390 you have missing declared dependencies.
391 </para></listitem>
392 <listitem><para><emphasis>Scanning Directory Names:</emphasis>
393 When scanning for files in
394 <link linkend='var-SRC_URI'><filename>SRC_URI</filename></link>,
395 the build system now uses
396 <link linkend='var-FILESOVERRIDES'><filename>FILESOVERRIDES</filename></link>
397 instead of <link linkend='var-OVERRIDES'><filename>OVERRIDES</filename></link>
398 for the directory names.
399 In general, the values previously in
400 <filename>OVERRIDES</filename> are now in
401 <filename>FILESOVERRIDES</filename> as well.
402 However, if you relied upon an additional value
403 you previously added to <filename>OVERRIDES</filename>,
404 you might now need to add it to
405 <filename>FILESOVERRIDES</filename> unless you are already
406 adding it through the
407 <link linkend='var-MACHINEOVERRIDES'><filename>MACHINEOVERRIDES</filename></link>
408 or <link linkend='var-DISTROOVERRIDES'><filename>DISTROOVERRIDES</filename></link>
409 variables, as appropriate.
410 For more related changes, see the
411 "<link linkend='migration-1.4-variables'>Variables</link>"
412 section.
413 </para></listitem>
414 </itemizedlist>
415 </para>
416 </section>
417
418
419 <section id='migration-1.4-proxies-and-fetching-source'>
420 <title>Proxies and Fetching Source</title>
421
422 <para>
423 A new <filename>oe-git-proxy</filename> script has been added to
424 replace previous methods of handling proxies and fetching source
425 from Git.
426 See the <filename>meta-yocto/conf/site.conf.sample</filename> file
427 for information on how to use this script.
428 </para>
429 </section>
430
431 <section id='migration-1.4-custom-interfaces-file-netbase-change'>
432 <title>Custom Interfaces File (netbase change)</title>
433
434 <para>
435 If you have created your own custom
436 <filename>etc/network/interfaces</filename> file by creating
437 an append file for the <filename>netbase</filename> recipe,
438 you now need to create an append file for the
439 <filename>init-ifupdown</filename> recipe instead, which you can
440 find in the
Brad Bishopd7bf8c12018-02-25 22:55:05 -0500441 <link linkend='source-directory'>Source Directory</link>
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500442 at <filename>meta/recipes-core/init-ifupdown</filename>.
443 For information on how to use append files, see the
444 "<ulink url='&YOCTO_DOCS_DEV_URL;#using-bbappend-files'>Using .bbappend Files</ulink>"
Brad Bishop316dfdd2018-06-25 12:45:53 -0400445 section in the Yocto Project Development Tasks Manual.
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500446 </para>
447 </section>
448
449 <section id='migration-1.4-remote-debugging'>
450 <title>Remote Debugging</title>
451
452 <para>
453 Support for remote debugging with the Eclipse IDE is now
454 separated into an image feature
455 (<filename>eclipse-debug</filename>) that corresponds to the
456 <filename>packagegroup-core-eclipse-debug</filename> package group.
457 Previously, the debugging feature was included through the
458 <filename>tools-debug</filename> image feature, which corresponds
459 to the <filename>packagegroup-core-tools-debug</filename>
460 package group.
461 </para>
462 </section>
463
464 <section id='migration-1.4-variables'>
465 <title>Variables</title>
466
467 <para>
468 The following variables have changed:
469 <itemizedlist>
470 <listitem><para><emphasis><filename>SANITY_TESTED_DISTROS</filename>:</emphasis>
471 This variable now uses a distribution ID, which is composed
472 of the host distributor ID followed by the release.
473 Previously,
474 <link linkend='var-SANITY_TESTED_DISTROS'><filename>SANITY_TESTED_DISTROS</filename></link>
475 was composed of the description field.
476 For example, "Ubuntu 12.10" becomes "Ubuntu-12.10".
477 You do not need to worry about this change if you are not
478 specifically setting this variable, or if you are
479 specifically setting it to "".
480 </para></listitem>
481 <listitem><para><emphasis><filename>SRC_URI</filename>:</emphasis>
482 The <filename>${</filename><link linkend='var-PN'><filename>PN</filename></link><filename>}</filename>,
483 <filename>${</filename><link linkend='var-PF'><filename>PF</filename></link><filename>}</filename>,
484 <filename>${</filename><link linkend='var-P'><filename>P</filename></link><filename>}</filename>,
485 and <filename>FILE_DIRNAME</filename> directories have been
486 dropped from the default value of the
487 <link linkend='var-FILESPATH'><filename>FILESPATH</filename></link>
488 variable, which is used as the search path for finding files
489 referred to in
490 <link linkend='var-SRC_URI'><filename>SRC_URI</filename></link>.
491 If you have a recipe that relied upon these directories,
492 which would be unusual, then you will need to add the
493 appropriate paths within the recipe or, alternatively,
494 rearrange the files.
495 The most common locations are still covered by
496 <filename>${BP}</filename>, <filename>${BPN}</filename>,
497 and "files", which all remain in the default value of
498 <link linkend='var-FILESPATH'><filename>FILESPATH</filename></link>.
499 </para></listitem>
500 </itemizedlist>
501 </para>
502 </section>
503
504 <section id='migration-target-package-management-with-rpm'>
505 <title>Target Package Management with RPM</title>
506
507 <para>
508 If runtime package management is enabled and the RPM backend
509 is selected, Smart is now installed for package download, dependency
510 resolution, and upgrades instead of Zypper.
511 For more information on how to use Smart, run the following command
512 on the target:
513 <literallayout class='monospaced'>
514 smart --help
515 </literallayout>
516 </para>
517 </section>
518
519 <section id='migration-1.4-recipes-moved'>
520 <title>Recipes Moved</title>
521
522 <para>
523 The following recipes were moved from their previous locations
524 because they are no longer used by anything in
525 the OpenEmbedded-Core:
526 <itemizedlist>
527 <listitem><para><emphasis><filename>clutter-box2d</filename>:</emphasis>
528 Now resides in the <filename>meta-oe</filename> layer.
529 </para></listitem>
530 <listitem><para><emphasis><filename>evolution-data-server</filename>:</emphasis>
531 Now resides in the <filename>meta-gnome</filename> layer.
532 </para></listitem>
533 <listitem><para><emphasis><filename>gthumb</filename>:</emphasis>
534 Now resides in the <filename>meta-gnome</filename> layer.
535 </para></listitem>
536 <listitem><para><emphasis><filename>gtkhtml2</filename>:</emphasis>
537 Now resides in the <filename>meta-oe</filename> layer.
538 </para></listitem>
539 <listitem><para><emphasis><filename>gupnp</filename>:</emphasis>
540 Now resides in the <filename>meta-multimedia</filename> layer.
541 </para></listitem>
542 <listitem><para><emphasis><filename>gypsy</filename>:</emphasis>
543 Now resides in the <filename>meta-oe</filename> layer.
544 </para></listitem>
545 <listitem><para><emphasis><filename>libcanberra</filename>:</emphasis>
546 Now resides in the <filename>meta-gnome</filename> layer.
547 </para></listitem>
548 <listitem><para><emphasis><filename>libgdata</filename>:</emphasis>
549 Now resides in the <filename>meta-gnome</filename> layer.
550 </para></listitem>
551 <listitem><para><emphasis><filename>libmusicbrainz</filename>:</emphasis>
552 Now resides in the <filename>meta-multimedia</filename> layer.
553 </para></listitem>
554 <listitem><para><emphasis><filename>metacity</filename>:</emphasis>
555 Now resides in the <filename>meta-gnome</filename> layer.
556 </para></listitem>
557 <listitem><para><emphasis><filename>polkit</filename>:</emphasis>
558 Now resides in the <filename>meta-oe</filename> layer.
559 </para></listitem>
560 <listitem><para><emphasis><filename>zeroconf</filename>:</emphasis>
561 Now resides in the <filename>meta-networking</filename> layer.
562 </para></listitem>
563 </itemizedlist>
564 </para>
565 </section>
566
567 <section id='migration-1.4-removals-and-renames'>
568 <title>Removals and Renames</title>
569
570 <para>
571 The following list shows what has been removed or renamed:
572 <itemizedlist>
573 <listitem><para><emphasis><filename>evieext</filename>:</emphasis>
574 Removed because it has been removed from
575 <filename>xserver</filename> since 2008.
576 </para></listitem>
577 <listitem><para><emphasis>Gtk+ DirectFB:</emphasis>
578 Removed support because upstream Gtk+ no longer supports it
579 as of version 2.18.
580 </para></listitem>
581 <listitem><para><emphasis><filename>libxfontcache / xfontcacheproto</filename>:</emphasis>
582 Removed because they were removed from the Xorg server in 2008.
583 </para></listitem>
584 <listitem><para><emphasis><filename>libxp / libxprintapputil / libxprintutil / printproto</filename>:</emphasis>
585 Removed because the XPrint server was removed from
586 Xorg in 2008.
587 </para></listitem>
588 <listitem><para><emphasis><filename>libxtrap / xtrapproto</filename>:</emphasis>
589 Removed because their functionality was broken upstream.
590 </para></listitem>
591 <listitem><para><emphasis>linux-yocto 3.0 kernel:</emphasis>
592 Removed with linux-yocto 3.8 kernel being added.
593 The linux-yocto 3.2 and linux-yocto 3.4 kernels remain
594 as part of the release.
595 </para></listitem>
596 <listitem><para><emphasis><filename>lsbsetup</filename>:</emphasis>
597 Removed with functionality now provided by
598 <filename>lsbtest</filename>.
599 </para></listitem>
600 <listitem><para><emphasis><filename>matchbox-stroke</filename>:</emphasis>
601 Removed because it was never more than a proof-of-concept.
602 </para></listitem>
603 <listitem><para><emphasis><filename>matchbox-wm-2 / matchbox-theme-sato-2</filename>:</emphasis>
604 Removed because they are not maintained.
605 However, <filename>matchbox-wm</filename> and
606 <filename>matchbox-theme-sato</filename> are still
607 provided.
608 </para></listitem>
609 <listitem><para><emphasis><filename>mesa-dri</filename>:</emphasis>
610 Renamed to <filename>mesa</filename>.
611 </para></listitem>
612 <listitem><para><emphasis><filename>mesa-xlib</filename>:</emphasis>
613 Removed because it was no longer useful.
614 </para></listitem>
615 <listitem><para><emphasis><filename>mutter</filename>:</emphasis>
616 Removed because nothing ever uses it and the recipe is
617 very old.
618 </para></listitem>
619 <listitem><para><emphasis><filename>orinoco-conf</filename>:</emphasis>
620 Removed because it has become obsolete.
621 </para></listitem>
622 <listitem><para><emphasis><filename>update-modules</filename>:</emphasis>
623 Removed because it is no longer used.
624 The kernel module <filename>postinstall</filename> and
625 <filename>postrm</filename> scripts can now do the same
626 task without the use of this script.
627 </para></listitem>
628 <listitem><para><emphasis><filename>web</filename>:</emphasis>
629 Removed because it is not maintained. Superseded by
630 <filename>web-webkit</filename>.
631 </para></listitem>
632 <listitem><para><emphasis><filename>xf86bigfontproto</filename>:</emphasis>
633 Removed because upstream it has been disabled by default
634 since 2007.
635 Nothing uses <filename>xf86bigfontproto</filename>.
636 </para></listitem>
637 <listitem><para><emphasis><filename>xf86rushproto</filename>:</emphasis>
638 Removed because its dependency in
639 <filename>xserver</filename> was spurious and it was
640 removed in 2005.
641 </para></listitem>
642 <listitem><para><emphasis><filename>zypper / libzypp / sat-solver</filename>:</emphasis>
643 Removed and been functionally replaced with Smart
644 (<filename>python-smartpm</filename>) when RPM packaging
645 is used and package management is enabled on the target.
646 </para></listitem>
647 </itemizedlist>
648 </para>
649 </section>
650</section>
651
652<section id='moving-to-the-yocto-project-1.5-release'>
653 <title>Moving to the Yocto Project 1.5 Release</title>
654
655 <para>
656 This section provides migration information for moving to the
657 Yocto Project 1.5 Release from the prior release.
658 </para>
659
660 <section id='migration-1.5-host-dependency-changes'>
661 <title>Host Dependency Changes</title>
662
663 <para>
664 The OpenEmbedded build system now has some additional requirements
665 on the host system:
666 <itemizedlist>
667 <listitem><para>Python 2.7.3+</para></listitem>
668 <listitem><para>Tar 1.24+</para></listitem>
669 <listitem><para>Git 1.7.8+</para></listitem>
670 <listitem><para>Patched version of Make if you are using
671 3.82.
672 Most distributions that provide Make 3.82 use the patched
673 version.</para></listitem>
674 </itemizedlist>
675 If the Linux distribution you are using on your build host
676 does not provide packages for these, you can install and use
677 the Buildtools tarball, which provides an SDK-like environment
678 containing them.
679 </para>
680
681 <para>
682 For more information on this requirement, see the
683 "<link linkend='required-git-tar-and-python-versions'>Required Git, tar, and Python Versions</link>"
684 section.
685 </para>
686 </section>
687
688 <section id='migration-1.5-atom-pc-bsp'>
689 <title><filename>atom-pc</filename> Board Support Package (BSP)</title>
690
691 <para>
692 The <filename>atom-pc</filename> hardware reference BSP has been
693 replaced by a <filename>genericx86</filename> BSP.
694 This BSP is not necessarily guaranteed to work on all x86
695 hardware, but it will run on a wider range of systems than the
696 <filename>atom-pc</filename> did.
697 <note>
698 Additionally, a <filename>genericx86-64</filename> BSP has
699 been added for 64-bit Atom systems.
700 </note>
701 </para>
702 </section>
703
704 <section id='migration-1.5-bitbake'>
705 <title>BitBake</title>
706
707 <para>
708 The following changes have been made that relate to BitBake:
709 <itemizedlist>
710 <listitem><para>
711 BitBake now supports a <filename>_remove</filename>
712 operator.
713 The addition of this operator means you will have to
714 rename any items in recipe space (functions, variables)
715 whose names currently contain
716 <filename>_remove_</filename> or end with
717 <filename>_remove</filename> to avoid unexpected behavior.
718 </para></listitem>
719 <listitem><para>
720 BitBake's global method pool has been removed.
721 This method is not particularly useful and led to clashes
722 between recipes containing functions that had the
723 same name.</para></listitem>
724 <listitem><para>
725 The "none" server backend has been removed.
726 The "process" server backend has been serving well as the
727 default for a long time now.</para></listitem>
728 <listitem><para>
729 The <filename>bitbake-runtask</filename> script has been
730 removed.</para></listitem>
731 <listitem><para>
732 <filename>${</filename><link linkend='var-P'><filename>P</filename></link><filename>}</filename>
733 and
734 <filename>${</filename><link linkend='var-PF'><filename>PF</filename></link><filename>}</filename>
735 are no longer added to
736 <link linkend='var-PROVIDES'><filename>PROVIDES</filename></link>
737 by default in <filename>bitbake.conf</filename>.
738 These version-specific <filename>PROVIDES</filename>
739 items were seldom used.
740 Attempting to use them could result in two versions being
741 built simultaneously rather than just one version due to
742 the way BitBake resolves dependencies.</para></listitem>
743 </itemizedlist>
744 </para>
745 </section>
746
747 <section id='migration-1.5-qa-warnings'>
748 <title>QA Warnings</title>
749
750 <para>
751 The following changes have been made to the package QA checks:
752 <itemizedlist>
753 <listitem><para>
754 If you have customized
755 <link linkend='var-ERROR_QA'><filename>ERROR_QA</filename></link>
756 or <link linkend='var-WARN_QA'><filename>WARN_QA</filename></link>
757 values in your configuration, check that they contain all of
758 the issues that you wish to be reported.
759 Previous Yocto Project versions contained a bug that meant
760 that any item not mentioned in <filename>ERROR_QA</filename>
761 or <filename>WARN_QA</filename> would be treated as a
762 warning.
763 Consequently, several important items were not already in
764 the default value of <filename>WARN_QA</filename>.
765 All of the possible QA checks are now documented in the
766 "<link linkend='ref-classes-insane'><filename>insane.bbclass</filename></link>"
767 section.</para></listitem>
768 <listitem><para>
769 An additional QA check has been added to check if
770 <filename>/usr/share/info/dir</filename> is being installed.
771 Your recipe should delete this file within
772 <link linkend='ref-tasks-install'><filename>do_install</filename></link>
773 if "make install" is installing it.
774 </para></listitem>
775 <listitem><para>
776 If you are using the buildhistory class, the check for the
777 package version going backwards is now controlled using a
778 standard QA check.
779 Thus, if you have customized your
780 <filename>ERROR_QA</filename> or
781 <filename>WARN_QA</filename> values and still wish to have
782 this check performed, you should add
783 "version-going-backwards" to your value for one or the
784 other variables depending on how you wish it to be handled.
785 See the documented QA checks in the
786 "<link linkend='ref-classes-insane'><filename>insane.bbclass</filename></link>"
787 section.
788 </para></listitem>
789 </itemizedlist>
790 </para>
791 </section>
792
793 <section id='migration-1.5-directory-layout-changes'>
794 <title>Directory Layout Changes</title>
795
796 <para>
797 The following directory changes exist:
798 <itemizedlist>
799 <listitem><para>
800 Output SDK installer files are now named to include the
801 image name and tuning architecture through the
802 <link linkend='var-SDK_NAME'><filename>SDK_NAME</filename></link>
803 variable.</para></listitem>
804 <listitem><para>
805 Images and related files are now installed into a directory
806 that is specific to the machine, instead of a parent
807 directory containing output files for multiple machines.
808 The
809 <link linkend='var-DEPLOY_DIR_IMAGE'><filename>DEPLOY_DIR_IMAGE</filename></link>
810 variable continues to point to the directory containing
811 images for the current
812 <link linkend='var-MACHINE'><filename>MACHINE</filename></link>
813 and should be used anywhere there is a need to refer to
814 this directory.
815 The <filename>runqemu</filename> script now uses this
816 variable to find images and kernel binaries and will use
817 BitBake to determine the directory.
818 Alternatively, you can set the
819 <filename>DEPLOY_DIR_IMAGE</filename> variable in the
820 external environment.</para></listitem>
821 <listitem><para>
822 When buildhistory is enabled, its output is now written
823 under the
Brad Bishopd7bf8c12018-02-25 22:55:05 -0500824 <link linkend='build-directory'>Build Directory</link>
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500825 rather than
826 <link linkend='var-TMPDIR'><filename>TMPDIR</filename></link>.
827 Doing so makes it easier to delete
828 <filename>TMPDIR</filename> and preserve the build history.
829 Additionally, data for produced SDKs is now split by
830 <link linkend='var-IMAGE_NAME'><filename>IMAGE_NAME</filename></link>.
831 </para></listitem>
832 <listitem><para>
833 The <filename>pkgdata</filename> directory produced as
834 part of the packaging process has been collapsed into a
835 single machine-specific directory.
836 This directory is located under
837 <filename>sysroots</filename> and uses a machine-specific
838 name (i.e.
839 <filename>tmp/sysroots/<replaceable>machine</replaceable>/pkgdata</filename>).
840 </para></listitem>
841 </itemizedlist>
842 </para>
843 </section>
844
845 <section id='migration-1.5-shortened-git-srcrev-values'>
846 <title>Shortened Git <filename>SRCREV</filename> Values</title>
847
848 <para>
849 BitBake will now shorten revisions from Git repositories from the
850 normal 40 characters down to 10 characters within
851 <link linkend='var-SRCPV'><filename>SRCPV</filename></link>
852 for improved usability in path and file names.
853 This change should be safe within contexts where these revisions
854 are used because the chances of spatially close collisions
855 is very low.
856 Distant collisions are not a major issue in the way
857 the values are used.
858 </para>
859 </section>
860
861 <section id='migration-1.5-image-features'>
862 <title><filename>IMAGE_FEATURES</filename></title>
863
864 <para>
865 The following changes have been made that relate to
866 <link linkend='var-IMAGE_FEATURES'><filename>IMAGE_FEATURES</filename></link>:
867 <itemizedlist>
868 <listitem><para>
Brad Bishop316dfdd2018-06-25 12:45:53 -0400869 The value of <filename>IMAGE_FEATURES</filename> is now
870 validated to ensure invalid feature items are not added.
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500871 Some users mistakenly add package names to this variable
872 instead of using
873 <link linkend='var-IMAGE_INSTALL'><filename>IMAGE_INSTALL</filename></link>
874 in order to have the package added to the image, which does
875 not work.
876 This change is intended to catch those kinds of situations.
877 Valid <filename>IMAGE_FEATURES</filename> are drawn from
878 <link linkend='var-PACKAGE_GROUP'><filename>PACKAGE_GROUP</filename></link>
879 definitions,
880 <link linkend='var-COMPLEMENTARY_GLOB'><filename>COMPLEMENTARY_GLOB</filename></link>
881 and a new "validitems" varflag on
882 <filename>IMAGE_FEATURES</filename>.
883 The "validitems" varflag change allows additional features
884 to be added if they are not provided using the previous
885 two mechanisms.
886 </para></listitem>
887 <listitem><para>
888 The previously deprecated "apps-console-core"
889 <filename>IMAGE_FEATURES</filename> item is no longer
890 supported.
891 Add "splash" to <filename>IMAGE_FEATURES</filename> if you
892 wish to have the splash screen enabled, since this is
893 all that apps-console-core was doing.</para></listitem>
894 </itemizedlist>
895 </para>
896 </section>
897
898 <section id='migration-1.5-run'>
899 <title><filename>/run</filename></title>
900
901 <para>
902 The <filename>/run</filename> directory from the Filesystem
903 Hierarchy Standard 3.0 has been introduced.
904 You can find some of the implications for this change
905 <ulink url='http://cgit.openembedded.org/openembedded-core/commit/?id=0e326280a15b0f2c4ef2ef4ec441f63f55b75873'>here</ulink>.
906 The change also means that recipes that install files to
907 <filename>/var/run</filename> must be changed.
908 You can find a guide on how to make these changes
909 <ulink url='http://permalink.gmane.org/gmane.comp.handhelds.openembedded/58530'>here</ulink>.
910 </para>
911 </section>
912
913 <section id='migration-1.5-removal-of-package-manager-database-within-image-recipes'>
914 <title>Removal of Package Manager Database Within Image Recipes</title>
915
916 <para>
917 The image <filename>core-image-minimal</filename> no longer adds
918 <filename>remove_packaging_data_files</filename> to
919 <link linkend='var-ROOTFS_POSTPROCESS_COMMAND'><filename>ROOTFS_POSTPROCESS_COMMAND</filename></link>.
920 This addition is now handled automatically when "package-management"
921 is not in
922 <link linkend='var-IMAGE_FEATURES'><filename>IMAGE_FEATURES</filename></link>.
923 If you have custom image recipes that make this addition,
924 you should remove the lines, as they are not needed and might
925 interfere with correct operation of postinstall scripts.
926 </para>
927 </section>
928
929 <section id='migration-1.5-images-now-rebuild-only-on-changes-instead-of-every-time'>
930 <title>Images Now Rebuild Only on Changes Instead of Every Time</title>
931
932 <para>
933 The
934 <link linkend='ref-tasks-rootfs'><filename>do_rootfs</filename></link>
935 and other related image
936 construction tasks are no longer marked as "nostamp".
937 Consequently, they will only be re-executed when their inputs have
938 changed.
939 Previous versions of the OpenEmbedded build system always rebuilt
940 the image when requested rather when necessary.
941 </para>
942 </section>
943
944 <section id='migration-1.5-task-recipes'>
945 <title>Task Recipes</title>
946
947 <para>
948 The previously deprecated <filename>task.bbclass</filename> has
949 now been dropped.
950 For recipes that previously inherited from this class, you should
951 rename them from <filename>task-*</filename> to
952 <filename>packagegroup-*</filename> and inherit packagegroup
953 instead.
954 </para>
955
956 <para>
957 For more information, see the
958 "<link linkend='ref-classes-packagegroup'><filename>packagegroup.bbclass</filename></link>"
959 section.
960 </para>
961 </section>
962
963 <section id='migration-1.5-busybox'>
964 <title>BusyBox</title>
965
966 <para>
967 By default, we now split BusyBox into two binaries:
968 one that is suid root for those components that need it, and
969 another for the rest of the components.
970 Splitting BusyBox allows for optimization that eliminates the
971 <filename>tinylogin</filename> recipe as recommended by upstream.
972 You can disable this split by setting
973 <link linkend='var-BUSYBOX_SPLIT_SUID'><filename>BUSYBOX_SPLIT_SUID</filename></link>
974 to "0".
975 </para>
976 </section>
977
978 <section id='migration-1.5-automated-image-testing'>
979 <title>Automated Image Testing</title>
980
981 <para>
982 A new automated image testing framework has been added
983 through the
Patrick Williamsf1e5d692016-03-30 15:21:19 -0500984 <link linkend='ref-classes-testimage*'><filename>testimage.bbclass</filename></link>
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500985 class.
986 This framework replaces the older
987 <filename>imagetest-qemu</filename> framework.
988 </para>
989
990 <para>
991 You can learn more about performing automated image tests in the
992 "<ulink url='&YOCTO_DOCS_DEV_URL;#performing-automated-runtime-testing'>Performing Automated Runtime Testing</ulink>"
Brad Bishopd7bf8c12018-02-25 22:55:05 -0500993 section in the Yocto Project Development Tasks Manual.
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500994 </para>
995 </section>
996
997 <section id='migration-1.5-build-history'>
998 <title>Build History</title>
999
1000 <para>
1001 Following are changes to Build History:
1002 <itemizedlist>
1003 <listitem><para>
1004 Installed package sizes:
1005 <filename>installed-package-sizes.txt</filename> for an
1006 image now records the size of the files installed by each
1007 package instead of the size of each compressed package
1008 archive file.</para></listitem>
1009 <listitem><para>
1010 The dependency graphs (<filename>depends*.dot</filename>)
1011 now use the actual package names instead of replacing
1012 dashes, dots and plus signs with underscores.
1013 </para></listitem>
1014 <listitem><para>
1015 The <filename>buildhistory-diff</filename> and
1016 <filename>buildhistory-collect-srcrevs</filename>
1017 utilities have improved command-line handling.
1018 Use the <filename>--help</filename> option for
1019 each utility for more information on the new syntax.
1020 </para></listitem>
1021 </itemizedlist>
1022 For more information on Build History, see the
Brad Bishop316dfdd2018-06-25 12:45:53 -04001023 "<ulink url='&YOCTO_DOCS_DEV_URL;#maintaining-build-output-quality'>Maintaining Build Output Quality</ulink>"
1024 section in the Yocto Project Development Tasks Manual.
Patrick Williamsc124f4f2015-09-15 14:41:29 -05001025 </para>
1026 </section>
1027
1028 <section id='migration-1.5-udev'>
1029 <title><filename>udev</filename></title>
1030
1031 <para>
1032 Following are changes to <filename>udev</filename>:
1033 <itemizedlist>
1034 <listitem><para>
1035 <filename>udev</filename> no longer brings in
1036 <filename>udev-extraconf</filename> automatically
1037 through
1038 <link linkend='var-RRECOMMENDS'><filename>RRECOMMENDS</filename></link>,
1039 since this was originally intended to be optional.
1040 If you need the extra rules, then add
1041 <filename>udev-extraconf</filename> to your image.
1042 </para></listitem>
1043 <listitem><para>
1044 <filename>udev</filename> no longer brings in
1045 <filename>pciutils-ids</filename> or
1046 <filename>usbutils-ids</filename> through
1047 <filename>RRECOMMENDS</filename>.
1048 These are not needed by <filename>udev</filename> itself
1049 and removing them saves around 350KB.
1050 </para></listitem>
1051 </itemizedlist>
1052 </para>
1053 </section>
1054
1055 <section id='migration-1.5-removed-renamed-recipes'>
1056 <title>Removed and Renamed Recipes</title>
1057
1058 <itemizedlist>
1059 <listitem><para>
1060 The <filename>linux-yocto</filename> 3.2 kernel has been
1061 removed.</para></listitem>
1062 <listitem><para>
1063 <filename>libtool-nativesdk</filename> has been renamed to
1064 <filename>nativesdk-libtool</filename>.</para></listitem>
1065 <listitem><para>
1066 <filename>tinylogin</filename> has been removed.
1067 It has been replaced by a suid portion of Busybox.
1068 See the
1069 "<link linkend='migration-1.5-busybox'>BusyBox</link>" section
1070 for more information.</para></listitem>
1071 <listitem><para>
1072 <filename>external-python-tarball</filename> has been renamed
1073 to <filename>buildtools-tarball</filename>.
1074 </para></listitem>
1075 <listitem><para>
1076 <filename>web-webkit</filename> has been removed.
1077 It has been functionally replaced by
1078 <filename>midori</filename>.</para></listitem>
1079 <listitem><para>
1080 <filename>imake</filename> has been removed.
1081 It is no longer needed by any other recipe.
1082 </para></listitem>
1083 <listitem><para>
1084 <filename>transfig-native</filename> has been removed.
1085 It is no longer needed by any other recipe.
1086 </para></listitem>
1087 <listitem><para>
1088 <filename>anjuta-remote-run</filename> has been removed.
1089 Anjuta IDE integration has not been officially supported for
1090 several releases.</para></listitem>
1091 </itemizedlist>
1092 </section>
1093
1094 <section id='migration-1.5-other-changes'>
1095 <title>Other Changes</title>
1096
1097 <para>
1098 Following is a list of short entries describing other changes:
1099 <itemizedlist>
1100 <listitem><para>
1101 <filename>run-postinsts</filename>: Make this generic.
1102 </para></listitem>
1103 <listitem><para>
1104 <filename>base-files</filename>: Remove the unnecessary
1105 <filename>media/</filename><replaceable>xxx</replaceable> directories.
1106 </para></listitem>
1107 <listitem><para>
1108 <filename>alsa-state</filename>: Provide an empty
1109 <filename>asound.conf</filename> by default.
1110 </para></listitem>
1111 <listitem><para>
1112 <filename>classes/image</filename>: Ensure
1113 <link linkend='var-BAD_RECOMMENDATIONS'><filename>BAD_RECOMMENDATIONS</filename></link>
1114 supports pre-renamed package names.</para></listitem>
1115 <listitem><para>
1116 <filename>classes/rootfs_rpm</filename>: Implement
Brad Bishop316dfdd2018-06-25 12:45:53 -04001117 <filename>BAD_RECOMMENDATIONS</filename> for RPM.
1118 </para></listitem>
Patrick Williamsc124f4f2015-09-15 14:41:29 -05001119 <listitem><para>
1120 <filename>systemd</filename>: Remove
1121 <filename>systemd_unitdir</filename> if
1122 <filename>systemd</filename> is not in
1123 <link linkend='var-DISTRO_FEATURES'><filename>DISTRO_FEATURES</filename></link>.
1124 </para></listitem>
1125 <listitem><para>
1126 <filename>systemd</filename>: Remove
1127 <filename>init.d</filename> dir if
1128 <filename>systemd</filename> unit file is present and
1129 <filename>sysvinit</filename> is not a distro feature.
1130 </para></listitem>
1131 <listitem><para>
1132 <filename>libpam</filename>: Deny all services for the
1133 <filename>OTHER</filename> entries.
1134 </para></listitem>
1135 <listitem><para>
1136 <filename>image.bbclass</filename>: Move
1137 <filename>runtime_mapping_rename</filename> to avoid
1138 conflict with <filename>multilib</filename>.
1139 See
1140 <ulink url='https://bugzilla.yoctoproject.org/show_bug.cgi?id=4993'><filename>YOCTO #4993</filename></ulink>
1141 in Bugzilla for more information.
1142 </para></listitem>
1143 <listitem><para>
1144 <filename>linux-dtb</filename>: Use kernel build system
1145 to generate the <filename>dtb</filename> files.
1146 </para></listitem>
1147 <listitem><para>
1148 <filename>kern-tools</filename>: Switch from guilt to
1149 new <filename>kgit-s2q</filename> tool.
1150 </para></listitem>
1151 </itemizedlist>
1152 </para>
1153 </section>
1154</section>
1155
1156<section id='moving-to-the-yocto-project-1.6-release'>
1157 <title>Moving to the Yocto Project 1.6 Release</title>
1158
1159 <para>
1160 This section provides migration information for moving to the
1161 Yocto Project 1.6 Release from the prior release.
1162 </para>
1163
1164
1165 <section id='migration-1.6-archiver-class'>
1166 <title><filename>archiver</filename> Class</title>
1167
1168 <para>
1169 The
1170 <link linkend='ref-classes-archiver'><filename>archiver</filename></link>
1171 class has been rewritten and its configuration has been simplified.
1172 For more details on the source archiver, see the
1173 "<ulink url='&YOCTO_DOCS_DEV_URL;#maintaining-open-source-license-compliance-during-your-products-lifecycle'>Maintaining Open Source License Compliance During Your Product's Lifecycle</ulink>"
Brad Bishopd7bf8c12018-02-25 22:55:05 -05001174 section in the Yocto Project Development Tasks Manual.
Patrick Williamsc124f4f2015-09-15 14:41:29 -05001175 </para>
1176 </section>
1177
1178 <section id='migration-1.6-packaging-changes'>
1179 <title>Packaging Changes</title>
1180
1181 <para>
1182 The following packaging changes have been made:
1183 <itemizedlist>
1184 <listitem><para>
1185 The <filename>binutils</filename> recipe no longer produces
1186 a <filename>binutils-symlinks</filename> package.
1187 <filename>update-alternatives</filename> is now used to
1188 handle the preferred <filename>binutils</filename>
1189 variant on the target instead.
1190 </para></listitem>
1191 <listitem><para>
1192 The tc (traffic control) utilities have been split out of
1193 the main <filename>iproute2</filename> package and put
1194 into the <filename>iproute2-tc</filename> package.
1195 </para></listitem>
1196 <listitem><para>
1197 The <filename>gtk-engines</filename> schemas have been
1198 moved to a dedicated
1199 <filename>gtk-engines-schemas</filename> package.
1200 </para></listitem>
1201 <listitem><para>
1202 The <filename>armv7a</filename> with thumb package
1203 architecture suffix has changed.
1204 The suffix for these packages with the thumb
1205 optimization enabled is "t2" as it should be.
1206 Use of this suffix was not the case in the 1.5 release.
1207 Architecture names will change within package feeds as a
1208 result.
1209 </para></listitem>
1210 </itemizedlist>
1211 </para>
1212 </section>
1213
1214 <section id='migration-1.6-bitbake'>
1215 <title>BitBake</title>
1216
1217 <para>
1218 The following changes have been made to
Brad Bishopd7bf8c12018-02-25 22:55:05 -05001219 <link linkend='bitbake-term'>BitBake</link>.
Patrick Williamsc124f4f2015-09-15 14:41:29 -05001220 </para>
1221
1222 <section id='migration-1.6-matching-branch-requirement-for-git-fetching'>
1223 <title>Matching Branch Requirement for Git Fetching</title>
1224
1225 <para>
1226 When fetching source from a Git repository using
1227 <link linkend='var-SRC_URI'><filename>SRC_URI</filename></link>,
1228 BitBake will now validate the
1229 <link linkend='var-SRCREV'><filename>SRCREV</filename></link>
1230 value against the branch.
1231 You can specify the branch using the following form:
1232 <literallayout class='monospaced'>
1233 SRC_URI = "git://server.name/repository;branch=<replaceable>branchname</replaceable>"
1234 </literallayout>
1235 If you do not specify a branch, BitBake looks
1236 in the default "master" branch.
1237 </para>
1238
1239 <para>
1240 Alternatively, if you need to bypass this check (e.g.
1241 if you are fetching a revision corresponding to a tag that
1242 is not on any branch), you can add ";nobranch=1" to
1243 the end of the URL within <filename>SRC_URI</filename>.
1244 </para>
1245 </section>
1246
1247 <section id='migration-1.6-bitbake-deps'>
1248 <title>Python Definition substitutions</title>
1249
1250 <para>
1251 BitBake had some previously deprecated Python definitions
1252 within its <filename>bb</filename> module removed.
1253 You should use their sub-module counterparts instead:
1254 <itemizedlist>
1255 <listitem><para><filename>bb.MalformedUrl</filename>:
1256 Use <filename>bb.fetch.MalformedUrl</filename>.
1257 </para></listitem>
Patrick Williamsf1e5d692016-03-30 15:21:19 -05001258 <listitem><para><filename>bb.encodeurl</filename>:
Patrick Williamsc124f4f2015-09-15 14:41:29 -05001259 Use <filename>bb.fetch.encodeurl</filename>.
1260 </para></listitem>
1261 <listitem><para><filename>bb.decodeurl</filename>:
1262 Use <filename>bb.fetch.decodeurl</filename>
1263 </para></listitem>
1264 <listitem><para><filename>bb.mkdirhier</filename>:
1265 Use <filename>bb.utils.mkdirhier</filename>.
1266 </para></listitem>
1267 <listitem><para><filename>bb.movefile</filename>:
1268 Use <filename>bb.utils.movefile</filename>.
1269 </para></listitem>
1270 <listitem><para><filename>bb.copyfile</filename>:
1271 Use <filename>bb.utils.copyfile</filename>.
1272 </para></listitem>
1273 <listitem><para><filename>bb.which</filename>:
1274 Use <filename>bb.utils.which</filename>.
1275 </para></listitem>
1276 <listitem><para><filename>bb.vercmp_string</filename>:
1277 Use <filename>bb.utils.vercmp_string</filename>.
1278 </para></listitem>
1279 <listitem><para><filename>bb.vercmp</filename>:
1280 Use <filename>bb.utils.vercmp</filename>.
1281 </para></listitem>
1282 </itemizedlist>
1283 </para>
1284 </section>
1285
1286 <section id='migration-1.6-bitbake-fetcher'>
1287 <title>SVK Fetcher</title>
1288
1289 <para>
1290 The SVK fetcher has been removed from BitBake.
1291 </para>
1292 </section>
1293
1294 <section id='migration-1.6-bitbake-console-output'>
1295 <title>Console Output Error Redirection</title>
1296
1297 <para>
1298 The BitBake console UI will now output errors to
1299 <filename>stderr</filename> instead of
1300 <filename>stdout</filename>.
1301 Consequently, if you are piping or redirecting the output of
1302 <filename>bitbake</filename> to somewhere else, and you wish
1303 to retain the errors, you will need to add
1304 <filename>2>&amp;1</filename> (or something similar) to the
1305 end of your <filename>bitbake</filename> command line.
1306 </para>
1307 </section>
1308
1309 <section id='migration-1.6-task-taskname-overrides'>
1310 <title><filename>task-</filename><replaceable>taskname</replaceable> Overrides</title>
1311
1312 <para>
1313 <filename>task-</filename><replaceable>taskname</replaceable> overrides have been
1314 adjusted so that tasks whose names contain underscores have the
1315 underscores replaced by hyphens for the override so that they
1316 now function properly.
1317 For example, the task override for
1318 <link linkend='ref-tasks-populate_sdk'><filename>do_populate_sdk</filename></link>
1319 is <filename>task-populate-sdk</filename>.
1320 </para>
1321 </section>
1322 </section>
1323
1324 <section id='migration-1.6-variable-changes'>
1325 <title>Changes to Variables</title>
1326
1327 <para>
1328 The following variables have changed.
1329 For information on the OpenEmbedded build system variables, see the
1330 "<link linkend='ref-variables-glos'>Variables Glossary</link>" Chapter.
1331 </para>
1332
1333 <section id='migration-1.6-variable-changes-TMPDIR'>
1334 <title><filename>TMPDIR</filename></title>
1335
1336 <para>
1337 <link linkend='var-TMPDIR'><filename>TMPDIR</filename></link>
1338 can no longer be on an NFS mount.
1339 NFS does not offer full POSIX locking and inode consistency
1340 and can cause unexpected issues if used to store
1341 <filename>TMPDIR</filename>.
1342 </para>
1343
1344 <para>
1345 The check for this occurs on startup.
1346 If <filename>TMPDIR</filename> is detected on an NFS mount,
1347 an error occurs.
1348 </para>
1349 </section>
1350
1351 <section id='migration-1.6-variable-changes-PRINC'>
1352 <title><filename>PRINC</filename></title>
1353
1354 <para>
1355 The <filename>PRINC</filename>
1356 variable has been deprecated and triggers a warning if
1357 detected during a build.
1358 For
1359 <link linkend='var-PR'><filename>PR</filename></link>
1360 increments on changes, use the PR service instead.
1361 You can find out more about this service in the
1362 "<ulink url='&YOCTO_DOCS_DEV_URL;#working-with-a-pr-service'>Working With a PR Service</ulink>"
Brad Bishopd7bf8c12018-02-25 22:55:05 -05001363 section in the Yocto Project Development Tasks Manual.
Patrick Williamsc124f4f2015-09-15 14:41:29 -05001364 </para>
1365 </section>
1366
1367 <section id='migration-1.6-variable-changes-IMAGE_TYPES'>
1368 <title><filename>IMAGE_TYPES</filename></title>
1369
1370 <para>
1371 The "sum.jffs2" option for
1372 <link linkend='var-IMAGE_TYPES'><filename>IMAGE_TYPES</filename></link>
1373 has been replaced by the "jffs2.sum" option, which fits the
1374 processing order.
1375 </para>
1376 </section>
1377
1378 <section id='migration-1.6-variable-changes-COPY_LIC_MANIFEST'>
1379 <title><filename>COPY_LIC_MANIFEST</filename></title>
1380
1381 <para>
1382 The
1383 <link linkend='var-COPY_LIC_MANIFEST'><filename>COPY_LIC_MANIFEST</filename></link>
1384 variable must
1385 now be set to "1" rather than any value in order to enable
1386 it.
1387 </para>
1388 </section>
1389
1390 <section id='migration-1.6-variable-changes-COPY_LIC_DIRS'>
1391 <title><filename>COPY_LIC_DIRS</filename></title>
1392
1393 <para>
1394 The
1395 <link linkend='var-COPY_LIC_DIRS'><filename>COPY_LIC_DIRS</filename></link>
1396 variable must
1397 now be set to "1" rather than any value in order to enable
1398 it.
1399 </para>
1400 </section>
1401
1402 <section id='migration-1.6-variable-changes-PACKAGE_GROUP'>
1403 <title><filename>PACKAGE_GROUP</filename></title>
1404
1405 <para>
1406 The
1407 <link linkend='var-PACKAGE_GROUP'><filename>PACKAGE_GROUP</filename></link>
1408 variable has been renamed to
1409 <link linkend='var-FEATURE_PACKAGES'><filename>FEATURE_PACKAGES</filename></link>
1410 to more accurately reflect its purpose.
1411 You can still use <filename>PACKAGE_GROUP</filename> but
1412 the OpenEmbedded build system produces a warning message when
1413 it encounters the variable.
1414 </para>
1415 </section>
1416
1417 <section id='migration-1.6-variable-changes-variable-entry-behavior'>
1418 <title>Preprocess and Post Process Command Variable Behavior</title>
1419
1420 <para>
1421 The following variables now expect a semicolon separated
1422 list of functions to call and not arbitrary shell commands:
1423 <literallayout class='monospaced'>
1424 <link linkend='var-ROOTFS_PREPROCESS_COMMAND'>ROOTFS_PREPROCESS_COMMAND</link>
1425 <link linkend='var-ROOTFS_POSTPROCESS_COMMAND'>ROOTFS_POSTPROCESS_COMMAND</link>
1426 <link linkend='var-SDK_POSTPROCESS_COMMAND'>SDK_POSTPROCESS_COMMAND</link>
1427 <link linkend='var-POPULATE_SDK_POST_TARGET_COMMAND'>POPULATE_SDK_POST_TARGET_COMMAND</link>
1428 <link linkend='var-POPULATE_SDK_POST_HOST_COMMAND'>POPULATE_SDK_POST_HOST_COMMAND</link>
1429 <link linkend='var-IMAGE_POSTPROCESS_COMMAND'>IMAGE_POSTPROCESS_COMMAND</link>
1430 <link linkend='var-IMAGE_PREPROCESS_COMMAND'>IMAGE_PREPROCESS_COMMAND</link>
1431 <link linkend='var-ROOTFS_POSTUNINSTALL_COMMAND'>ROOTFS_POSTUNINSTALL_COMMAND</link>
1432 <link linkend='var-ROOTFS_POSTINSTALL_COMMAND'>ROOTFS_POSTINSTALL_COMMAND</link>
1433 </literallayout>
1434 For migration purposes, you can simply wrap shell commands in
1435 a shell function and then call the function.
1436 Here is an example:
1437 <literallayout class='monospaced'>
1438 my_postprocess_function() {
1439 echo "hello" > ${IMAGE_ROOTFS}/hello.txt
1440 }
1441 ROOTFS_POSTPROCESS_COMMAND += "my_postprocess_function; "
1442 </literallayout>
1443 </para>
1444 </section>
1445 </section>
1446
Patrick Williamsc124f4f2015-09-15 14:41:29 -05001447 <section id='migration-1.6-package-test-ptest'>
1448 <title>Package Test (ptest)</title>
1449
1450 <para>
1451 Package Tests (ptest) are built but not installed by default.
1452 For information on using Package Tests, see the
Brad Bishop316dfdd2018-06-25 12:45:53 -04001453 "<ulink url='&YOCTO_DOCS_DEV_URL;#testing-packages-with-ptest'>Testing Packages with ptest</ulink>"
Brad Bishopd7bf8c12018-02-25 22:55:05 -05001454 section in the Yocto Project Development Tasks Manual.
Patrick Williamsc124f4f2015-09-15 14:41:29 -05001455 For information on the <filename>ptest</filename> class, see the
1456 "<link linkend='ref-classes-ptest'><filename>ptest.bbclass</filename></link>"
1457 section.
1458 </para>
1459 </section>
1460
1461 <section id='migration-1.6-build-changes'>
1462 <title>Build Changes</title>
1463
1464 <para>
1465 Separate build and source directories have been enabled
1466 by default for selected recipes where it is known to work
1467 (a whitelist) and for all recipes that inherit the
1468 <link linkend='ref-classes-cmake'><filename>cmake</filename></link>
1469 class.
1470 In future releases the
1471 <link linkend='ref-classes-autotools'><filename>autotools</filename></link>
1472 class will enable a separate build directory by default as
1473 well.
1474 Recipes building Autotools-based
1475 software that fails to build with a separate build directory
1476 should be changed to inherit from the
Patrick Williamsf1e5d692016-03-30 15:21:19 -05001477 <link linkend='ref-classes-autotools'><filename>autotools-brokensep</filename></link>
1478 class instead of the <filename>autotools</filename> or
1479 <filename>autotools_stage</filename>classes.
Patrick Williamsc124f4f2015-09-15 14:41:29 -05001480 </para>
1481 </section>
1482
1483 <section id='migration-1.6-building-qemu-native'>
1484 <title><filename>qemu-native</filename></title>
1485
1486 <para>
1487 <filename>qemu-native</filename> now builds without
1488 SDL-based graphical output support by default.
1489 The following additional lines are needed in your
1490 <filename>local.conf</filename> to enable it:
1491 <literallayout class='monospaced'>
1492 PACKAGECONFIG_pn-qemu-native = "sdl"
1493 ASSUME_PROVIDED += "libsdl-native"
1494 </literallayout>
1495 <note>
1496 The default <filename>local.conf</filename>
1497 contains these statements.
1498 Consequently, if you are building a headless system and using
1499 a default <filename>local.conf</filename> file, you will need
1500 comment these two lines out.
1501 </note>
1502 </para>
1503 </section>
1504
1505 <section id='migration-1.6-core-image-basic'>
1506 <title><filename>core-image-basic</filename></title>
1507
1508 <para>
1509 <filename>core-image-basic</filename> has been renamed to
1510 <filename>core-image-full-cmdline</filename>.
1511 </para>
1512
1513 <para>
1514 In addition to <filename>core-image-basic</filename> being renamed,
1515 <filename>packagegroup-core-basic</filename> has been renamed to
1516 <filename>packagegroup-core-full-cmdline</filename> to match.
1517 </para>
1518 </section>
1519
1520 <section id='migration-1.6-licensing'>
1521 <title>Licensing</title>
1522
1523 <para>
1524 The top-level <filename>LICENSE</filename> file has been changed
1525 to better describe the license of the various components of
Brad Bishopd7bf8c12018-02-25 22:55:05 -05001526 <link linkend='oe-core'>OE-Core</link>.
Patrick Williamsc124f4f2015-09-15 14:41:29 -05001527 However, the licensing itself remains unchanged.
1528 </para>
1529
1530 <para>
1531 Normally, this change would not cause any side-effects.
1532 However, some recipes point to this file within
1533 <link linkend='var-LIC_FILES_CHKSUM'><filename>LIC_FILES_CHKSUM</filename></link>
1534 (as <filename>${COREBASE}/LICENSE</filename>) and thus the
1535 accompanying checksum must be changed from
1536 3f40d7994397109285ec7b81fdeb3b58 to
1537 4d92cd373abda3937c2bc47fbc49d690.
1538 A better alternative is to have
1539 <filename>LIC_FILES_CHKSUM</filename> point to a file
1540 describing the license that is distributed with the source
1541 that the recipe is building, if possible, rather than pointing
1542 to <filename>${COREBASE}/LICENSE</filename>.
1543 </para>
1544 </section>
1545
1546 <section id='migration-1.6-cflags-options'>
1547 <title><filename>CFLAGS</filename> Options</title>
1548
1549 <para>
1550 The "-fpermissive" option has been removed from the default
1551 <link linkend='var-CFLAGS'><filename>CFLAGS</filename></link>
1552 value.
1553 You need to take action on individual recipes that fail when
1554 building with this option.
1555 You need to either patch the recipes to fix the issues reported by
1556 the compiler, or you need to add "-fpermissive" to
1557 <filename>CFLAGS</filename> in the recipes.
1558 </para>
1559 </section>
1560
1561 <section id='migration-1.6-custom-images'>
1562 <title>Custom Image Output Types</title>
1563
1564 <para>
1565 Custom image output types, as selected using
1566 <link linkend='var-IMAGE_FSTYPES'><filename>IMAGE_FSTYPES</filename></link>,
1567 must declare their dependencies on other image types (if any) using
1568 a new
1569 <link linkend='var-IMAGE_TYPEDEP'><filename>IMAGE_TYPEDEP</filename></link>
1570 variable.
1571 </para>
1572 </section>
1573
1574 <section id='migration-1.6-do-package-write-task'>
1575 <title>Tasks</title>
1576
1577 <para>
1578 The <filename>do_package_write</filename> task has been removed.
1579 The task is no longer needed.
1580 </para>
1581 </section>
1582
1583 <section id='migration-1.6-update-alternatives-provider'>
1584 <title><filename>update-alternative</filename> Provider</title>
1585
1586 <para>
1587 The default <filename>update-alternatives</filename> provider has
1588 been changed from <filename>opkg</filename> to
1589 <filename>opkg-utils</filename>.
1590 This change resolves some troublesome circular dependencies.
1591 The runtime package has also been renamed from
1592 <filename>update-alternatives-cworth</filename>
1593 to <filename>update-alternatives-opkg</filename>.
1594 </para>
1595 </section>
1596
1597 <section id='migration-1.6-virtclass-overrides'>
1598 <title><filename>virtclass</filename> Overrides</title>
1599
1600 <para>
1601 The <filename>virtclass</filename> overrides are now deprecated.
1602 Use the equivalent class overrides instead (e.g.
1603 <filename>virtclass-native</filename> becomes
1604 <filename>class-native</filename>.)
1605 </para>
1606 </section>
1607
1608 <section id='migration-1.6-removed-renamed-recipes'>
1609 <title>Removed and Renamed Recipes</title>
1610
1611 <para>
1612 The following recipes have been removed:
1613 <itemizedlist>
1614 <listitem><para><filename>packagegroup-toolset-native</filename> -
1615 This recipe is largely unused.
1616 </para></listitem>
1617 <listitem><para><filename>linux-yocto-3.8</filename> -
1618 Support for the Linux yocto 3.8 kernel has been dropped.
1619 Support for the 3.10 and 3.14 kernels have been added
1620 with the <filename>linux-yocto-3.10</filename> and
1621 <filename>linux-yocto-3.14</filename> recipes.
1622 </para></listitem>
1623 <listitem><para><filename>ocf-linux</filename> -
1624 This recipe has been functionally replaced using
1625 <filename>cryptodev-linux</filename>.
1626 </para></listitem>
1627 <listitem><para><filename>genext2fs</filename> -
1628 <filename>genext2fs</filename> is no longer used by the
1629 build system and is unmaintained upstream.
1630 </para></listitem>
1631 <listitem><para><filename>js</filename> -
1632 This provided an ancient version of Mozilla's javascript
1633 engine that is no longer needed.
1634 </para></listitem>
1635 <listitem><para><filename>zaurusd</filename> -
1636 The recipe has been moved to the
1637 <filename>meta-handheld</filename> layer.
1638 </para></listitem>
1639 <listitem><para><filename>eglibc 2.17</filename> -
1640 Replaced by the <filename>eglibc 2.19</filename>
1641 recipe.
1642 </para></listitem>
1643 <listitem><para><filename>gcc 4.7.2</filename> -
1644 Replaced by the now stable
1645 <filename>gcc 4.8.2</filename>.
1646 </para></listitem>
1647 <listitem><para><filename>external-sourcery-toolchain</filename> -
1648 this recipe is now maintained in the
1649 <filename>meta-sourcery</filename> layer.
1650 </para></listitem>
1651 <listitem><para><filename>linux-libc-headers-yocto 3.4+git</filename> -
1652 Now using version 3.10 of the
1653 <filename>linux-libc-headers</filename> by default.
1654 </para></listitem>
1655 <listitem><para><filename>meta-toolchain-gmae</filename> -
1656 This recipe is obsolete.
1657 </para></listitem>
1658 <listitem><para><filename>packagegroup-core-sdk-gmae</filename> -
1659 This recipe is obsolete.
1660 </para></listitem>
1661 <listitem><para><filename>packagegroup-core-standalone-gmae-sdk-target</filename> -
1662 This recipe is obsolete.
1663 </para></listitem>
1664 </itemizedlist>
1665 </para>
1666 </section>
1667
1668 <section id='migration-1.6-removed-classes'>
1669 <title>Removed Classes</title>
1670
1671 <para>
1672 The following classes have become obsolete and have been removed:
1673 <itemizedlist>
1674 <listitem><para><filename>module_strip</filename>
1675 </para></listitem>
1676 <listitem><para><filename>pkg_metainfo</filename>
1677 </para></listitem>
1678 <listitem><para><filename>pkg_distribute</filename>
1679 </para></listitem>
1680 <listitem><para><filename>image-empty</filename>
1681 </para></listitem>
1682 </itemizedlist>
1683 </para>
1684 </section>
1685
1686 <section id='migration-1.6-reference-bsps'>
1687 <title>Reference Board Support Packages (BSPs)</title>
1688
1689 <para>
1690 The following reference BSPs changes occurred:
1691 <itemizedlist>
1692 <listitem><para>The BeagleBoard
1693 (<filename>beagleboard</filename>) ARM reference hardware
1694 has been replaced by the BeagleBone
1695 (<filename>beaglebone</filename>) hardware.
1696 </para></listitem>
1697 <listitem><para>The RouterStation Pro
1698 (<filename>routerstationpro</filename>) MIPS reference
1699 hardware has been replaced by the EdgeRouter Lite
1700 (<filename>edgerouter</filename>) hardware.
1701 </para></listitem>
1702 </itemizedlist>
1703 The previous reference BSPs for the
1704 <filename>beagleboard</filename> and
1705 <filename>routerstationpro</filename> machines are still available
1706 in a new <filename>meta-yocto-bsp-old</filename> layer in the
1707 <ulink url='&YOCTO_GIT_URL;'>Source Repositories</ulink>
1708 at
1709 <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>.
1710 </para>
1711 </section>
1712</section>
1713
1714<section id='moving-to-the-yocto-project-1.7-release'>
1715 <title>Moving to the Yocto Project 1.7 Release</title>
1716
1717 <para>
1718 This section provides migration information for moving to the
1719 Yocto Project 1.7 Release from the prior release.
1720 </para>
1721
1722 <section id='migration-1.7-changes-to-setting-qemu-packageconfig-options'>
1723 <title>Changes to Setting QEMU <filename>PACKAGECONFIG</filename> Options in <filename>local.conf</filename></title>
1724
1725 <para>
1726 The QEMU recipe now uses a number of
1727 <link linkend='var-PACKAGECONFIG'><filename>PACKAGECONFIG</filename></link>
1728 options to enable various optional features.
1729 The method used to set defaults for these options means that
1730 existing
1731 <filename>local.conf</filename> files will need to be be
1732 modified to append to <filename>PACKAGECONFIG</filename> for
1733 <filename>qemu-native</filename> and
1734 <filename>nativesdk-qemu</filename> instead of setting it.
1735 In other words, to enable graphical output for QEMU, you should
1736 now have these lines in <filename>local.conf</filename>:
1737 <literallayout class='monospaced'>
1738 PACKAGECONFIG_append_pn-qemu-native = " sdl"
1739 PACKAGECONFIG_append_pn-nativesdk-qemu = " sdl"
1740 </literallayout>
1741 </para>
1742 </section>
1743
1744 <section id='migration-1.7-minimum-git-version'>
1745 <title>Minimum Git version</title>
1746
1747 <para>
1748 The minimum
Brad Bishop316dfdd2018-06-25 12:45:53 -04001749 <ulink url='&YOCTO_DOCS_OM_URL;#git'>Git</ulink> version
1750 required on the build host is now 1.7.8 because the
Patrick Williamsc124f4f2015-09-15 14:41:29 -05001751 <filename>--list</filename> option is now required by
1752 BitBake's Git fetcher.
1753 As always, if your host distribution does not provide a version of
1754 Git that meets this requirement, you can use the
1755 <filename>buildtools-tarball</filename> that does.
1756 See the
1757 "<link linkend='required-git-tar-and-python-versions'>Required Git, tar, and Python Versions</link>"
1758 section for more information.
1759 </para>
1760 </section>
1761
1762 <section id='migration-1.7-autotools-class-changes'>
1763 <title>Autotools Class Changes</title>
1764
1765 <para>
1766 The following
1767 <link linkend='ref-classes-autotools'><filename>autotools</filename></link>
1768 class changes occurred:
1769 <itemizedlist>
1770 <listitem><para><emphasis>
1771 A separate build directory is now used by default:</emphasis>
1772 The <filename>autotools</filename> class has been changed
1773 to use a directory for building
1774 (<link linkend='var-B'><filename>B</filename></link>),
1775 which is separate from the source directory
1776 (<link linkend='var-S'><filename>S</filename></link>).
1777 This is commonly referred to as
1778 <filename>B != S</filename>, or an out-of-tree build.</para>
1779 <para>If the software being built is already capable of
1780 building in a directory separate from the source, you
1781 do not need to do anything.
1782 However, if the software is not capable of being built
1783 in this manner, you will
1784 need to either patch the software so that it can build
1785 separately, or you will need to change the recipe to
1786 inherit the
Patrick Williamsf1e5d692016-03-30 15:21:19 -05001787 <link linkend='ref-classes-autotools'><filename>autotools-brokensep</filename></link>
1788 class instead of the <filename>autotools</filename> or
1789 <filename>autotools_stage</filename> classes.
Patrick Williamsc124f4f2015-09-15 14:41:29 -05001790 </para></listitem>
1791 <listitem><para><emphasis>
1792 The <filename>--foreign</filename> option is
1793 no longer passed to <filename>automake</filename> when
1794 running <filename>autoconf</filename>:</emphasis>
1795 This option tells <filename>automake</filename> that a
1796 particular software package does not follow the GNU
1797 standards and therefore should not be expected
1798 to distribute certain files such as
1799 <filename>ChangeLog</filename>,
1800 <filename>AUTHORS</filename>, and so forth.
1801 Because the majority of upstream software packages already
1802 tell <filename>automake</filename> to enable foreign mode
1803 themselves, the option is mostly superfluous.
1804 However, some recipes will need patches for this change.
1805 You can easily make the change by patching
1806 <filename>configure.ac</filename> so that it passes
1807 "foreign" to <filename>AM_INIT_AUTOMAKE()</filename>.
1808 See
1809 <ulink url='http://cgit.openembedded.org/openembedded-core/commit/?id=01943188f85ce6411717fb5bf702d609f55813f2'>this commit</ulink>
1810 for an example showing how to make the patch.
1811 </para></listitem>
1812 </itemizedlist>
1813 </para>
1814 </section>
1815
1816 <section id='migration-1.7-binary-configuration-scripts-disabled'>
1817 <title>Binary Configuration Scripts Disabled</title>
1818
1819 <para>
1820 Some of the core recipes that package binary configuration scripts
1821 now disable the scripts due to the
1822 scripts previously requiring error-prone path substitution.
1823 Software that links against these libraries using these scripts
1824 should use the much more robust <filename>pkg-config</filename>
1825 instead.
1826 The list of recipes changed in this version (and their
1827 configuration scripts) is as follows:
1828 <literallayout class='monospaced'>
1829 directfb (directfb-config)
1830 freetype (freetype-config)
1831 gpgme (gpgme-config)
1832 libassuan (libassuan-config)
1833 libcroco (croco-6.0-config)
1834 libgcrypt (libgcrypt-config)
1835 libgpg-error (gpg-error-config)
1836 libksba (ksba-config)
1837 libpcap (pcap-config)
1838 libpcre (pcre-config)
1839 libpng (libpng-config, libpng16-config)
1840 libsdl (sdl-config)
1841 libusb-compat (libusb-config)
1842 libxml2 (xml2-config)
1843 libxslt (xslt-config)
1844 ncurses (ncurses-config)
1845 neon (neon-config)
1846 npth (npth-config)
1847 pth (pth-config)
1848 taglib (taglib-config)
1849 </literallayout>
1850 Additionally, support for <filename>pkg-config</filename> has been
1851 added to some recipes in the previous list in the rare cases
1852 where the upstream software package does not already provide
1853 it.
1854 </para>
1855 </section>
1856
1857 <section id='migration-1.7-glibc-replaces-eglibc'>
1858 <title><filename>eglibc 2.19</filename> Replaced with <filename>glibc 2.20</filename></title>
1859
1860 <para>
1861 Because <filename>eglibc</filename> and
1862 <filename>glibc</filename> were already fairly close, this
1863 replacement should not require any significant changes to other
1864 software that links to <filename>eglibc</filename>.
1865 However, there were a number of minor changes in
1866 <filename>glibc 2.20</filename> upstream that could require
1867 patching some software (e.g. the removal of the
1868 <filename>_BSD_SOURCE</filename> feature test macro).
1869 </para>
1870
1871 <para>
1872 <filename>glibc 2.20</filename> requires version 2.6.32 or greater
1873 of the Linux kernel.
1874 Thus, older kernels will no longer be usable in conjunction with it.
1875 </para>
1876
1877 <para>
1878 For full details on the changes in <filename>glibc 2.20</filename>,
1879 see the upstream release notes
1880 <ulink url='https://sourceware.org/ml/libc-alpha/2014-09/msg00088.html'>here</ulink>.
1881 </para>
1882 </section>
1883
1884 <section id='migration-1.7-kernel-module-autoloading'>
1885 <title>Kernel Module Autoloading</title>
1886
1887 <para>
1888 The
1889 <link linkend='var-module_autoload'><filename>module_autoload_*</filename></link>
1890 variable is now deprecated and a new
1891 <link linkend='var-KERNEL_MODULE_AUTOLOAD'><filename>KERNEL_MODULE_AUTOLOAD</filename></link>
1892 variable should be used instead.
1893 Also,
1894 <link linkend='var-module_conf'><filename>module_conf_*</filename></link>
1895 must now be used in conjunction with a new
1896 <link linkend='var-KERNEL_MODULE_PROBECONF'><filename>KERNEL_MODULE_PROBECONF</filename></link>
1897 variable.
1898 The new variables no longer require you to specify the module name
1899 as part of the variable name.
1900 This change not only simplifies usage but also allows the values
1901 of these variables to be appropriately incorporated into task
1902 signatures and thus trigger the appropriate tasks to re-execute
1903 when changed.
1904 You should replace any references to
1905 <filename>module_autoload_*</filename> with
1906 <filename>KERNEL_MODULE_AUTOLOAD</filename>, and add any modules
1907 for which <filename>module_conf_*</filename> is specified to
1908 <filename>KERNEL_MODULE_PROBECONF</filename>.
1909 </para>
Patrick Williamsc124f4f2015-09-15 14:41:29 -05001910 </section>
1911
1912 <section id='migration-1.7-qa-check-changes'>
1913 <title>QA Check Changes</title>
1914
1915 <para>
1916 The following changes have occurred to the QA check process:
1917 <itemizedlist>
1918 <listitem><para>
1919 Additional QA checks <filename>file-rdeps</filename>
1920 and <filename>build-deps</filename> have been added in
1921 order to verify that file dependencies are satisfied
1922 (e.g. package contains a script requiring
1923 <filename>/bin/bash</filename>) and build-time dependencies
1924 are declared, respectively.
1925 For more information, please see the
1926 "<link linkend='ref-qa-checks'>QA Error and Warning Messages</link>"
1927 chapter.
1928 </para></listitem>
1929 <listitem><para>
1930 Package QA checks are now performed during a new
1931 <link linkend='ref-tasks-package_qa'><filename>do_package_qa</filename></link>
1932 task rather than being part of the
1933 <link linkend='ref-tasks-package'><filename>do_package</filename></link>
1934 task.
1935 This allows more parallel execution.
1936 This change is unlikely to be an issue except for highly
1937 customized recipes that disable packaging tasks themselves
1938 by marking them as <filename>noexec</filename>.
1939 For those packages, you will need to disable the
1940 <filename>do_package_qa</filename> task as well.
1941 </para></listitem>
1942 <listitem><para>
1943 Files being overwritten during the
1944 <link linkend='ref-tasks-populate_sysroot'><filename>do_populate_sysroot</filename></link>
1945 task now trigger an error instead of a warning.
1946 Recipes should not be overwriting files written to the
1947 sysroot by other recipes.
1948 If you have these types of recipes, you need to alter them
1949 so that they do not overwrite these files.</para>
1950 <para>You might now receive this error after changes in
1951 configuration or metadata resulting in orphaned files
1952 being left in the sysroot.
1953 If you do receive this error, the way to resolve the issue
1954 is to delete your
1955 <link linkend='var-TMPDIR'><filename>TMPDIR</filename></link>
1956 or to move it out of the way and then re-start the build.
1957 Anything that has been fully built up to that point and
1958 does not need rebuilding will be restored from the shared
1959 state cache and the rest of the build will be able to
1960 proceed as normal.
1961 </para></listitem>
1962 </itemizedlist>
1963 </para>
1964 </section>
1965
1966 <section id='migration-1.7-removed-recipes'>
1967 <title>Removed Recipes</title>
1968
1969 <para>
1970 The following recipes have been removed:
1971 <itemizedlist>
1972 <listitem><para>
1973 <filename>x-load</filename>:
1974 This recipe has been superseded by
1975 U-boot SPL for all Cortex-based TI SoCs.
1976 For legacy boards, the <filename>meta-ti</filename>
1977 layer, which contains a maintained recipe, should be used
1978 instead.
1979 </para></listitem>
1980 <listitem><para>
1981 <filename>ubootchart</filename>:
1982 This recipe is obsolete.
1983 A <filename>bootchart2</filename> recipe has been added
1984 to functionally replace it.
1985 </para></listitem>
1986 <listitem><para>
1987 <filename>linux-yocto 3.4</filename>:
1988 Support for the linux-yocto 3.4 kernel has been dropped.
1989 Support for the 3.10 and 3.14 kernels remains, while
1990 support for version 3.17 has been added.
1991 </para></listitem>
1992 <listitem><para>
1993 <filename>eglibc</filename> has been removed in favor of
1994 <filename>glibc</filename>.
1995 See the
1996 "<link linkend='migration-1.7-glibc-replaces-eglibc'><filename>eglibc 2.19</filename> Replaced with <filename>glibc 2.20</filename></link>"
1997 section for more information.
1998 </para></listitem>
1999 </itemizedlist>
2000 </para>
2001 </section>
2002
2003 <section id='migration-1.7-miscellaneous-changes'>
2004 <title>Miscellaneous Changes</title>
2005
2006 <para>
2007 The following miscellaneous change occurred:
2008 <itemizedlist>
2009 <listitem><para>
2010 The build history feature now writes
2011 <filename>build-id.txt</filename> instead of
2012 <filename>build-id</filename>.
2013 Additionally, <filename>build-id.txt</filename>
2014 now contains the full build header as printed by
2015 BitBake upon starting the build.
2016 You should manually remove old "build-id" files from your
2017 existing build history repositories to avoid confusion.
2018 For information on the build history feature, see the
Brad Bishop316dfdd2018-06-25 12:45:53 -04002019 "<ulink url='&YOCTO_DOCS_DEV_URL;#maintaining-build-output-quality'>Maintaining Build Output Quality</ulink>"
2020 section in the Yocto Project Development Tasks Manual.
Patrick Williamsc124f4f2015-09-15 14:41:29 -05002021 </para></listitem>
2022 </itemizedlist>
2023 </para>
2024 </section>
2025</section>
2026
2027<section id='moving-to-the-yocto-project-1.8-release'>
2028 <title>Moving to the Yocto Project 1.8 Release</title>
2029
2030 <para>
2031 This section provides migration information for moving to the
2032 Yocto Project 1.8 Release from the prior release.
2033 </para>
2034
2035 <section id='migration-1.8-removed-recipes'>
2036 <title>Removed Recipes</title>
2037
2038 <para>
2039 The following recipes have been removed:
2040 <itemizedlist>
2041 <listitem><para><filename>owl-video</filename>:
2042 Functionality replaced by <filename>gst-player</filename>.
2043 </para></listitem>
2044 <listitem><para><filename>gaku</filename>:
2045 Functionality replaced by <filename>gst-player</filename>.
2046 </para></listitem>
2047 <listitem><para><filename>gnome-desktop</filename>:
2048 This recipe is now available in
2049 <filename>meta-gnome</filename> and is no longer needed.
2050 </para></listitem>
2051 <listitem><para><filename>gsettings-desktop-schemas</filename>:
2052 This recipe is now available in
2053 <filename>meta-gnome</filename> and is no longer needed.
2054 </para></listitem>
2055 <listitem><para><filename>python-argparse</filename>:
2056 The <filename>argparse</filename> module is already
2057 provided in the default Python distribution in a
2058 package named <filename>python-argparse</filename>.
2059 Consequently, the separate
2060 <filename>python-argparse</filename> recipe is no
2061 longer needed.
2062 </para></listitem>
2063 <listitem><para><filename>telepathy-python, libtelepathy, telepathy-glib, telepathy-idle, telepathy-mission-control</filename>:
2064 All these recipes have moved to
2065 <filename>meta-oe</filename> and are consequently no
2066 longer needed by any recipes in OpenEmbedded-Core.
2067 </para></listitem>
2068 <listitem><para><filename>linux-yocto_3.10</filename> and <filename>linux-yocto_3.17</filename>:
2069 Support for the linux-yocto 3.10 and 3.17 kernels has been
2070 dropped.
2071 Support for the 3.14 kernel remains, while support for
2072 3.19 kernel has been added.
2073 </para></listitem>
2074 <listitem><para><filename>poky-feed-config-opkg</filename>:
2075 This recipe has become obsolete and is no longer needed.
2076 Use <filename>distro-feed-config</filename> from
2077 <filename>meta-oe</filename> instead.
2078 </para></listitem>
2079 <listitem><para><filename>libav 0.8.x</filename>:
2080 <filename>libav 9.x</filename> is now used.
2081 </para></listitem>
2082 <listitem><para><filename>sed-native</filename>:
2083 No longer needed.
2084 A working version of <filename>sed</filename> is expected
2085 to be provided by the host distribution.
2086 </para></listitem>
2087 </itemizedlist>
2088 </para>
2089 </section>
2090
2091 <section id='migration-1.8-bluez'>
2092 <title>BlueZ 4.x / 5.x Selection</title>
2093
2094 <para>
2095 Proper built-in support for selecting BlueZ 5.x in preference
2096 to the default of 4.x now exists.
2097 To use BlueZ 5.x, simply add "bluez5" to your
2098 <link linkend='var-DISTRO_FEATURES'><filename>DISTRO_FEATURES</filename></link>
2099 value.
2100 If you had previously added append files
2101 (<filename>*.bbappend</filename>) to make this selection, you can
2102 now remove them.
2103 </para>
2104
2105 <para>
2106 Additionally, a
2107 <link linkend='ref-classes-bluetooth'><filename>bluetooth</filename></link>
2108 class has been added to make selection of the appropriate bluetooth
2109 support within a recipe a little easier.
2110 If you wish to make use of this class in a recipe, add something
2111 such as the following:
2112 <literallayout class='monospaced'>
2113 inherit bluetooth
2114 PACKAGECONFIG ??= "${@bb.utils.contains('DISTRO_FEATURES', 'bluetooth', '${BLUEZ}', '', d)}
2115 PACKAGECONFIG[bluez4] = "--enable-bluetooth,--disable-bluetooth,bluez4"
2116 PACKAGECONFIG[bluez5] = "--enable-bluez5,--disable-bluez5,bluez5"
2117 </literallayout>
2118 </para>
2119 </section>
2120
2121 <section id='migration-1.8-kernel-build-changes'>
2122 <title>Kernel Build Changes</title>
2123
2124 <para>
2125 The kernel build process was changed to place the source
2126 in a common shared work area and to place build artifacts
2127 separately in the source code tree.
2128 In theory, migration paths have been provided for most common
2129 usages in kernel recipes but this might not work in all cases.
2130 In particular, users need to ensure that
2131 <filename>${S}</filename> (source files) and
2132 <filename>${B}</filename> (build artifacts) are used
2133 correctly in functions such as
2134 <link linkend='ref-tasks-configure'><filename>do_configure</filename></link>
2135 and
2136 <link linkend='ref-tasks-install'><filename>do_install</filename></link>.
2137 For kernel recipes that do not inherit from
2138 <filename>kernel-yocto</filename> or include
2139 <filename>linux-yocto.inc</filename>, you might wish to
2140 refer to the <filename>linux.inc</filename> file in the
2141 <filename>meta-oe</filename> layer for the kinds of changes you
2142 need to make.
2143 For reference, here is the
2144 <ulink url='http://cgit.openembedded.org/meta-openembedded/commit/meta-oe/recipes-kernel/linux/linux.inc?id=fc7132ede27ac67669448d3d2845ce7d46c6a1ee'>commit</ulink>
2145 where the <filename>linux.inc</filename> file in
2146 <filename>meta-oe</filename> was updated.
2147 </para>
2148
2149 <para>
2150 Recipes that rely on the kernel source code and do not inherit
2151 the module classes might need to add explicit dependencies on
2152 the <filename>do_shared_workdir</filename> kernel task, for example:
2153 <literallayout class='monospaced'>
2154 do_configure[depends] += "virtual/kernel:do_shared_workdir"
2155 </literallayout>
2156 </para>
2157 </section>
2158
2159 <section id='migration-1.8-ssl'>
2160 <title>SSL 3.0 is Now Disabled in OpenSSL</title>
2161
2162 <para>
2163 SSL 3.0 is now disabled when building OpenSSL.
2164 Disabling SSL 3.0 avoids any lingering instances of the POODLE
2165 vulnerability.
2166 If you feel you must re-enable SSL 3.0, then you can add an
2167 append file (<filename>*.bbappend</filename>) for the
2168 <filename>openssl</filename> recipe to remove "-no-ssl3"
2169 from
2170 <link linkend='var-EXTRA_OECONF'><filename>EXTRA_OECONF</filename></link>.
2171 </para>
2172 </section>
2173
2174 <section id='migration-1.8-default-sysroot-poisoning'>
2175 <title>Default Sysroot Poisoning</title>
2176
2177 <para>
2178 <filename>gcc's</filename> default sysroot and include directories
2179 are now "poisoned".
2180 In other words, the sysroot and include directories are being
2181 redirected to a non-existent location in order to catch when
2182 host directories are being used due to the correct options not
2183 being passed.
2184 This poisoning applies both to the cross-compiler used within the
2185 build and to the cross-compiler produced in the SDK.
2186 </para>
2187
2188 <para>
2189 If this change causes something in the build to fail, it almost
2190 certainly means the various compiler flags and commands are not
2191 being passed correctly to the underlying piece of software.
2192 In such cases, you need to take corrective steps.
2193 </para>
2194 </section>
2195
2196 <section id='migration-1.8-rebuild-improvements'>
2197 <title>Rebuild Improvements</title>
2198
2199 <para>
2200 Changes have been made to the
2201 <link linkend='ref-classes-base'><filename>base</filename></link>,
2202 <link linkend='ref-classes-autotools'><filename>autotools</filename></link>,
2203 and
2204 <link linkend='ref-classes-cmake'><filename>cmake</filename></link>
2205 classes to clean out generated files when the
2206 <link linkend='ref-tasks-configure'><filename>do_configure</filename></link>
2207 task needs to be re-executed.
2208 </para>
2209
2210 <para>
2211 One of the improvements is to attempt to run "make clean" during
2212 the <filename>do_configure</filename> task if a
2213 <filename>Makefile</filename> exists.
2214 Some software packages do not provide a working clean target
2215 within their make files.
2216 If you have such recipes, you need to set
2217 <link linkend='var-CLEANBROKEN'><filename>CLEANBROKEN</filename></link>
2218 to "1" within the recipe, for example:
2219 <literallayout class='monospaced'>
2220 CLEANBROKEN = "1"
2221 </literallayout>
2222 </para>
2223 </section>
2224
2225 <section id='migration-1.8-qa-check-and-validation-changes'>
2226 <title>QA Check and Validation Changes</title>
2227
2228 <para>
2229 The following QA Check and Validation Changes have occurred:
2230 <itemizedlist>
2231 <listitem><para>
2232 Usage of <filename>PRINC</filename>
2233 previously triggered a warning.
2234 It now triggers an error.
2235 You should remove any remaining usage of
2236 <filename>PRINC</filename> in any recipe or append file.
2237 </para></listitem>
2238 <listitem><para>
2239 An additional QA check has been added to detect usage of
2240 <filename>${D}</filename> in
2241 <link linkend='var-FILES'><filename>FILES</filename></link>
2242 values where
2243 <link linkend='var-D'><filename>D</filename></link> values
2244 should not be used at all.
2245 The same check ensures that <filename>$D</filename> is used
2246 in
2247 <filename>pkg_preinst/pkg_postinst/pkg_prerm/pkg_postrm</filename>
2248 functions instead of <filename>${D}</filename>.
2249 </para></listitem>
2250 <listitem><para>
2251 <link linkend='var-S'><filename>S</filename></link> now
2252 needs to be set to a valid value within a recipe.
2253 If <filename>S</filename> is not set in the recipe, the
2254 directory is not automatically created.
2255 If <filename>S</filename> does not point to a directory
2256 that exists at the time the
2257 <link linkend='ref-tasks-unpack'><filename>do_unpack</filename></link>
2258 task finishes, a warning will be shown.
2259 </para></listitem>
2260 <listitem><para>
2261 <link linkend='var-LICENSE'><filename>LICENSE</filename></link>
2262 is now validated for correct formatting of multiple
2263 licenses.
2264 If the format is invalid (e.g. multiple licenses are
2265 specified with no operators to specify how the multiple
2266 licenses interact), then a warning will be shown.
2267 </para></listitem>
2268 </itemizedlist>
2269 </para>
2270 </section>
2271
2272 <section id='migration-1.8-miscellaneous-changes'>
2273 <title>Miscellaneous Changes</title>
2274
2275 <para>
2276 The following miscellaneous changes have occurred:
2277 <itemizedlist>
2278 <listitem><para>
2279 The <filename>send-error-report</filename> script now
2280 expects a "-s" option to be specified before the server
2281 address.
2282 This assumes a server address is being specified.
2283 </para></listitem>
2284 <listitem><para>
2285 The <filename>oe-pkgdata-util</filename> script now
2286 expects a "-p" option to be specified before the
2287 <filename>pkgdata</filename> directory, which is now
2288 optional.
2289 If the <filename>pkgdata</filename> directory is not
2290 specified, the script will run BitBake to query
2291 <link linkend='var-PKGDATA_DIR'><filename>PKGDATA_DIR</filename></link>
2292 from the build environment.
2293 </para></listitem>
2294 </itemizedlist>
2295 </para>
2296 </section>
2297</section>
2298
Patrick Williamsf1e5d692016-03-30 15:21:19 -05002299<section id='moving-to-the-yocto-project-2.0-release'>
2300 <title>Moving to the Yocto Project 2.0 Release</title>
2301
2302 <para>
2303 This section provides migration information for moving to the
2304 Yocto Project 2.0 Release from the prior release.
2305 </para>
2306
2307 <section id='migration-2.0-gcc-5'>
2308 <title>GCC 5</title>
2309
2310 <para>
2311 The default compiler is now GCC 5.2.
2312 This change has required fixes for compilation errors in a number
2313 of other recipes.
2314 </para>
2315
2316 <para>
2317 One important example is a fix for when the Linux kernel freezes at
2318 boot time on ARM when built with GCC 5.
2319 If you are using your own kernel recipe or source tree and
2320 building for ARM, you will likely need to apply this
2321 <ulink url='https://git.kernel.org/cgit/linux/kernel/git/torvalds/linux.git/commit?id=a077224fd35b2f7fbc93f14cf67074fc792fbac2'>patch</ulink>.
2322 The standard <filename>linux-yocto</filename> kernel source tree
2323 already has a workaround for the same issue.
2324 </para>
2325
2326 <para>
2327 For further details, see
2328 <ulink url='https://gcc.gnu.org/gcc-5/changes.html'></ulink> and
2329 the porting guide at
2330 <ulink url='https://gcc.gnu.org/gcc-5/porting_to.html'></ulink>.
2331 </para>
2332
2333 <para>
2334 Alternatively, you can switch back to GCC 4.9 or 4.8 by
2335 setting <filename>GCCVERSION</filename> in your configuration,
2336 as follows:
2337 <literallayout class='monospaced'>
2338 GCCVERSION = "4.9%"
2339 </literallayout>
2340 </para>
2341 </section>
2342
2343 <section id='migration-2.0-Gstreamer-0.10-removed'>
2344 <title>Gstreamer 0.10 Removed</title>
2345
2346 <para>
2347 Gstreamer 0.10 has been removed in favor of Gstreamer 1.x.
2348 As part of the change, recipes for Gstreamer 0.10 and related
2349 software are now located
2350 in <filename>meta-multimedia</filename>.
2351 This change results in Qt4 having Phonon and Gstreamer
2352 support in QtWebkit disabled by default.
2353 </para>
2354 </section>
2355
2356 <section id='migration-2.0-removed-recipes'>
2357 <title>Removed Recipes</title>
2358
2359 <para>
2360 The following recipes have been moved or removed:
2361 <itemizedlist>
2362 <listitem><para>
2363 <filename>bluez4</filename>: The recipe is obsolete and
2364 has been moved due to <filename>bluez5</filename>
2365 becoming fully integrated.
2366 The <filename>bluez4</filename> recipe now resides in
2367 <filename>meta-oe</filename>.
2368 </para></listitem>
2369 <listitem><para>
2370 <filename>gamin</filename>: The recipe is obsolete and
2371 has been removed.
2372 </para></listitem>
2373 <listitem><para>
2374 <filename>gnome-icon-theme</filename>: The recipe's
2375 functionally has been replaced by
2376 <filename>adwaita-icon-theme</filename>.
2377 </para></listitem>
2378 <listitem><para>
2379 Gstreamer 0.10 Recipes: Recipes for Gstreamer 0.10 have
2380 been removed in favor of the recipes for Gstreamer 1.x.
2381 </para></listitem>
2382 <listitem><para>
2383 <filename>insserv</filename>: The recipe is obsolete and
2384 has been removed.
2385 </para></listitem>
2386 <listitem><para>
2387 <filename>libunique</filename>: The recipe is no longer
2388 used and has been moved to <filename>meta-oe</filename>.
2389 </para></listitem>
2390 <listitem><para>
2391 <filename>midori</filename>: The recipe's functionally
2392 has been replaced by <filename>epiphany</filename>.
2393 </para></listitem>
2394 <listitem><para>
2395 <filename>python-gst</filename>: The recipe is obsolete
2396 and has been removed since it only contains bindings for
2397 Gstreamer 0.10.
2398 </para></listitem>
2399 <listitem><para>
2400 <filename>qt-mobility</filename>: The recipe is obsolete and
2401 has been removed since it requires
2402 <filename>Gstreamer 0.10</filename>, which has been
2403 replaced.
2404 </para></listitem>
2405 <listitem><para>
2406 <filename>subversion</filename>: All 1.6.x versions of this
2407 recipe have been removed.
2408 </para></listitem>
2409 <listitem><para>
2410 <filename>webkit-gtk</filename>: The older 1.8.3 version
2411 of this recipe has been removed in favor of
2412 <filename>webkitgtk</filename>.
2413 </para></listitem>
2414 </itemizedlist>
2415 </para>
2416 </section>
2417
2418 <section id='migration-2.0-bitbake-datastore-improvements'>
2419 <title>BitBake datastore improvements</title>
2420
2421 <para>
2422 The method by which BitBake's datastore handles overrides has
2423 changed.
2424 Overrides are now applied dynamically and
2425 <filename>bb.data.update_data()</filename> is now a no-op.
2426 Thus, <filename>bb.data.update_data()</filename> is no longer
2427 required in order to apply the correct overrides.
2428 In practice, this change is unlikely to require any changes to
2429 Metadata.
2430 However, these minor changes in behavior exist:
2431 <itemizedlist>
2432 <listitem><para>
2433 All potential overrides are now visible in the variable
2434 history as seen when you run the following:
2435 <literallayout class='monospaced'>
2436 $ bitbake -e
2437 </literallayout>
2438 </para></listitem>
2439 <listitem><para>
Patrick Williamsc0f7c042017-02-23 20:41:17 -06002440 <filename>d.delVar('</filename><replaceable>VARNAME</replaceable><filename>')</filename> and
2441 <filename>d.setVar('</filename><replaceable>VARNAME</replaceable><filename>', None)</filename>
Patrick Williamsd8c66bc2016-06-20 12:57:21 -05002442 result in the variable and all of its overrides being
2443 cleared out.
Patrick Williamsf1e5d692016-03-30 15:21:19 -05002444 Before the change, only the non-overridden values
2445 were cleared.
2446 </para></listitem>
2447 </itemizedlist>
2448 </para>
2449 </section>
2450
2451 <section id='migration-2.0-shell-message-function-changes'>
2452 <title>Shell Message Function Changes</title>
2453
2454 <para>
2455 The shell versions of the BitBake message functions (i.e.
2456 <filename>bbdebug</filename>, <filename>bbnote</filename>,
2457 <filename>bbwarn</filename>, <filename>bbplain</filename>,
2458 <filename>bberror</filename>, and <filename>bbfatal</filename>)
2459 are now connected through to their BitBake equivalents
2460 <filename>bb.debug()</filename>, <filename>bb.note()</filename>,
2461 <filename>bb.warn()</filename>, <filename>bb.plain()</filename>,
2462 <filename>bb.error()</filename>, and
2463 <filename>bb.fatal()</filename>, respectively.
2464 Thus, those message functions that you would expect to be printed
2465 by the BitBake UI are now actually printed.
2466 In practice, this change means two things:
2467 <itemizedlist>
2468 <listitem><para>
2469 If you now see messages on the console that you did not
2470 previously see as a result of this change, you might
2471 need to clean up the calls to
2472 <filename>bbwarn</filename>, <filename>bberror</filename>,
2473 and so forth.
2474 Or, you might want to simply remove the calls.
2475 </para></listitem>
2476 <listitem><para>
2477 The <filename>bbfatal</filename> message function now
2478 suppresses the full error log in the UI, which means any
2479 calls to <filename>bbfatal</filename> where you still
2480 wish to see the full error log should be replaced by
2481 <filename>die</filename> or
2482 <filename>bbfatal_log</filename>.
2483 </para></listitem>
2484 </itemizedlist>
2485 </para>
2486 </section>
2487
2488 <section id='migration-2.0-extra-development-debug-package-cleanup'>
2489 <title>Extra Development/Debug Package Cleanup</title>
2490
2491 <para>
2492 The following recipes have had extra
2493 <filename>dev/dbg</filename> packages removed:
2494 <itemizedlist>
2495 <listitem><para>
2496 <filename>acl</filename>
2497 </para></listitem>
2498 <listitem><para>
2499 <filename>apmd</filename>
2500 </para></listitem>
2501 <listitem><para>
2502 <filename>aspell</filename>
2503 </para></listitem>
2504 <listitem><para>
2505 <filename>attr</filename>
2506 </para></listitem>
2507 <listitem><para>
2508 <filename>augeas</filename>
2509 </para></listitem>
2510 <listitem><para>
2511 <filename>bzip2</filename>
2512 </para></listitem>
2513 <listitem><para>
2514 <filename>cogl</filename>
2515 </para></listitem>
2516 <listitem><para>
2517 <filename>curl</filename>
2518 </para></listitem>
2519 <listitem><para>
2520 <filename>elfutils</filename>
2521 </para></listitem>
2522 <listitem><para>
2523 <filename>gcc-target</filename>
2524 </para></listitem>
2525 <listitem><para>
2526 <filename>libgcc</filename>
2527 </para></listitem>
2528 <listitem><para>
2529 <filename>libtool</filename>
2530 </para></listitem>
2531 <listitem><para>
2532 <filename>libxmu</filename>
2533 </para></listitem>
2534 <listitem><para>
2535 <filename>opkg</filename>
2536 </para></listitem>
2537 <listitem><para>
2538 <filename>pciutils</filename>
2539 </para></listitem>
2540 <listitem><para>
2541 <filename>rpm</filename>
2542 </para></listitem>
2543 <listitem><para>
2544 <filename>sysfsutils</filename>
2545 </para></listitem>
2546 <listitem><para>
2547 <filename>tiff</filename>
2548 </para></listitem>
2549 <listitem><para>
2550 <filename>xz</filename>
2551 </para></listitem>
2552 </itemizedlist>
2553 All of the above recipes now conform to the standard packaging
2554 scheme where a single <filename>-dev</filename>,
2555 <filename>-dbg</filename>, and <filename>-staticdev</filename>
2556 package exists per recipe.
2557 </para>
2558 </section>
2559
2560 <section id='migration-2.0-recipe-maintenance-tracking-data-moved-to-oe-core'>
2561 <title>Recipe Maintenance Tracking Data Moved to OE-Core</title>
2562
2563 <para>
2564 Maintenance tracking data for recipes that was previously part
Brad Bishopd7bf8c12018-02-25 22:55:05 -05002565 of <filename>meta-yocto</filename> has been moved to
2566 <link linkend='oe-core'>OE-Core</link>.
Patrick Williamsf1e5d692016-03-30 15:21:19 -05002567 The change includes <filename>package_regex.inc</filename> and
2568 <filename>distro_alias.inc</filename>, which are typically enabled
Brad Bishop15ae2502019-06-18 21:44:24 -04002569 when using the <filename>distrodata</filename> class.
Patrick Williamsf1e5d692016-03-30 15:21:19 -05002570 Additionally, the contents of
2571 <filename>upstream_tracking.inc</filename> has now been split out
2572 to the relevant recipes.
2573 </para>
2574 </section>
2575
2576 <section id='migration-2.0-automatic-stale-sysroot-file-cleanup'>
2577 <title>Automatic Stale Sysroot File Cleanup</title>
2578
2579 <para>
2580 Stale files from recipes that no longer exist in the current
2581 configuration are now automatically removed from
2582 sysroot as well as removed from
2583 any other place managed by shared state.
2584 This automatic cleanup means that the build system now properly
2585 handles situations such as renaming the build system side of
2586 recipes, removal of layers from
2587 <filename>bblayers.conf</filename>, and
2588 <link linkend='var-DISTRO_FEATURES'><filename>DISTRO_FEATURES</filename></link>
2589 changes.
2590 </para>
2591
2592 <para>
2593 Additionally, work directories for old versions of recipes are
2594 now pruned.
2595 If you wish to disable pruning old work directories, you can set
2596 the following variable in your configuration:
2597 <literallayout class='monospaced'>
2598 SSTATE_PRUNE_OBSOLETEWORKDIR = "0"
2599 </literallayout>
2600 </para>
2601 </section>
2602
2603 <section id='migration-2.0-linux-yocto-kernel-metadata-repository-now-split-from-source'>
2604 <title><filename>linux-yocto</filename> Kernel Metadata Repository Now Split from Source</title>
2605
2606 <para>
2607 The <filename>linux-yocto</filename> tree has up to now been a
2608 combined set of kernel changes and configuration (meta) data
2609 carried in a single tree.
2610 While this format is effective at keeping kernel configuration and
2611 source modifications synchronized, it is not always obvious to
2612 developers how to manipulate the Metadata as compared to the
2613 source.
2614 </para>
2615
2616 <para>
2617 Metadata processing has now been removed from the
2618 <link linkend='ref-classes-kernel-yocto'><filename>kernel-yocto</filename></link>
2619 class and the external Metadata repository
2620 <filename>yocto-kernel-cache</filename>, which has always been used
2621 to seed the <filename>linux-yocto</filename> "meta" branch.
2622 This separate <filename>linux-yocto</filename> cache repository
2623 is now the primary location for this data.
2624 Due to this change, <filename>linux-yocto</filename> is no longer
2625 able to process combined trees.
2626 Thus, if you need to have your own combined kernel repository,
2627 you must do the split there as well and update your recipes
2628 accordingly.
2629 See the <filename>meta/recipes-kernel/linux/linux-yocto_4.1.bb</filename>
2630 recipe for an example.
2631 </para>
2632 </section>
2633
2634 <section id='migration-2.0-additional-qa-checks'>
2635 <title>Additional QA checks</title>
2636
2637 <para>
2638 The following QA checks have been added:
2639 <itemizedlist>
2640 <listitem><para>
2641 Added a "host-user-contaminated" check for ownership
2642 issues for packaged files outside of
2643 <filename>/home</filename>.
2644 The check looks for files that are incorrectly owned by the
2645 user that ran BitBake instead of owned by a valid user in
2646 the target system.
2647 </para></listitem>
2648 <listitem><para>
2649 Added an "invalid-chars" check for invalid (non-UTF8)
2650 characters in recipe metadata variable values
2651 (i.e.
2652 <link linkend='var-DESCRIPTION'><filename>DESCRIPTION</filename></link>,
2653 <link linkend='var-SUMMARY'><filename>SUMMARY</filename></link>,
2654 <link linkend='var-LICENSE'><filename>LICENSE</filename></link>,
2655 and
2656 <link linkend='var-SECTION'><filename>SECTION</filename></link>).
2657 Some package managers do not support these characters.
2658 </para></listitem>
2659 <listitem><para>
2660 Added an "invalid-packageconfig" check for any options
2661 specified in
2662 <link linkend='var-PACKAGECONFIG'><filename>PACKAGECONFIG</filename></link>
2663 that do not match any <filename>PACKAGECONFIG</filename>
2664 option defined for the recipe.
2665 </para></listitem>
2666 </itemizedlist>
2667 </para>
2668 </section>
2669
2670 <section id='migration-2.0-miscellaneous'>
2671 <title>Miscellaneous Changes</title>
2672
2673 <para>
2674 These additional changes exist:
2675 <itemizedlist>
2676 <listitem><para>
2677 <filename>gtk-update-icon-cache</filename> has been
2678 renamed to <filename>gtk-icon-utils</filename>.
2679 </para></listitem>
2680 <listitem><para>
2681 The <filename>tools-profile</filename>
2682 <link linkend='var-IMAGE_FEATURES'><filename>IMAGE_FEATURES</filename></link>
2683 item as well as its corresponding packagegroup and
2684 <filename>packagegroup-core-tools-profile</filename> no
2685 longer bring in <filename>oprofile</filename>.
2686 Bringing in <filename>oprofile</filename> was originally
2687 added to aid compilation on resource-constrained
2688 targets.
2689 However, this aid has not been widely used and is not
2690 likely to be used going forward due to the more powerful
2691 target platforms and the existence of better
2692 cross-compilation tools.
2693 </para></listitem>
2694 <listitem><para>
2695 The
2696 <link linkend='var-IMAGE_FSTYPES'><filename>IMAGE_FSTYPES</filename></link>
2697 variable's default value now specifies
2698 <filename>ext4</filename> instead of
2699 <filename>ext3</filename>.
2700 </para></listitem>
2701 <listitem><para>
2702 All support for the <filename>PRINC</filename>
2703 variable has been removed.
2704 </para></listitem>
2705 <listitem><para>
2706 The <filename>packagegroup-core-full-cmdline</filename>
2707 packagegroup no longer brings in
2708 <filename>lighttpd</filename> due to the fact that
2709 bringing in <filename>lighttpd</filename> is not really in
2710 line with the packagegroup's purpose, which is to add full
2711 versions of command-line tools that by default are
2712 provided by <filename>busybox</filename>.
2713 </para></listitem>
2714 </itemizedlist>
2715 </para>
2716 </section>
2717</section>
2718
Patrick Williamsd8c66bc2016-06-20 12:57:21 -05002719<section id='moving-to-the-yocto-project-2.1-release'>
2720 <title>Moving to the Yocto Project 2.1 Release</title>
2721
2722 <para>
2723 This section provides migration information for moving to the
2724 Yocto Project 2.1 Release from the prior release.
2725 </para>
2726
2727 <section id='migration-2.1-variable-expansion-in-python-functions'>
2728 <title>Variable Expansion in Python Functions</title>
2729
2730 <para>
2731 Variable expressions, such as
Patrick Williamsc0f7c042017-02-23 20:41:17 -06002732 <filename>${</filename><replaceable>VARNAME</replaceable><filename>}</filename>
Patrick Williamsd8c66bc2016-06-20 12:57:21 -05002733 no longer expand automatically within Python functions.
2734 Suppressing expansion was done to allow Python functions to
2735 construct shell scripts or other code for situations in which you
2736 do not want such expressions expanded.
2737 For any existing code that relies on these expansions, you need to
Patrick Williamsc0f7c042017-02-23 20:41:17 -06002738 change the expansions to expand the value of individual
Patrick Williamsd8c66bc2016-06-20 12:57:21 -05002739 variables through <filename>d.getVar()</filename>.
2740 To alternatively expand more complex expressions,
2741 use <filename>d.expand()</filename>.
2742 </para>
2743 </section>
2744
2745 <section id='migration-2.1-overrides-must-now-be-lower-case'>
2746 <title>Overrides Must Now be Lower-Case</title>
2747
2748 <para>
2749 The convention for overrides has always been for them to be
2750 lower-case characters.
2751 This practice is now a requirement as BitBake's datastore now
2752 assumes lower-case characters in order to give a slight performance
2753 boost during parsing.
2754 In practical terms, this requirement means that anything that ends
2755 up in
2756 <link linkend='var-OVERRIDES'><filename>OVERRIDES</filename></link>
2757 must now appear in lower-case characters (e.g. values for
2758 <filename>MACHINE</filename>, <filename>TARGET_ARCH</filename>,
2759 <filename>DISTRO</filename>, and also recipe names if
2760 <filename>_pn-</filename><replaceable>recipename</replaceable>
2761 overrides are to be effective).
2762 </para>
2763 </section>
2764
2765 <section id='migration-2.1-expand-parameter-to-getvar-and-getvarflag-now-mandatory'>
2766 <title>Expand Parameter to <filename>getVar()</filename> and
2767 <filename>getVarFlag()</filename> is Now Mandatory</title>
2768
2769 <para>
2770 The expand parameter to <filename>getVar()</filename> and
2771 <filename>getVarFlag()</filename> previously defaulted to
2772 False if not specified.
2773 Now, however, no default exists so one must be specified.
2774 You must change any <filename>getVar()</filename> calls that
2775 do not specify the final expand parameter to calls that do specify
2776 the parameter.
2777 You can run the following <filename>sed</filename> command at the
2778 base of a layer to make this change:
2779 <literallayout class='monospaced'>
2780 sed -e 's:\(\.getVar([^,()]*\)):\1, False):g' -i `grep -ril getVar *`
2781 sed -e 's:\(\.getVarFlag([^,()]*, [^,()]*\)):\1, False):g' -i `grep -ril getVarFlag *`
2782 </literallayout>
2783 <note>
2784 The reason for this change is that it prepares the way for
2785 changing the default to True in a future Yocto Project release.
2786 This future change is a much more sensible default than False.
2787 However, the change needs to be made gradually as a sudden
2788 change of the default would potentially cause side-effects
2789 that would be difficult to detect.
2790 </note>
2791 </para>
2792 </section>
2793
2794 <section id='migration-2.1-makefile-environment-changes'>
2795 <title>Makefile Environment Changes</title>
2796
2797 <para>
2798 <link linkend='var-EXTRA_OEMAKE'><filename>EXTRA_OEMAKE</filename></link>
2799 now defaults to "" instead of "-e MAKEFLAGS=".
2800 Setting <filename>EXTRA_OEMAKE</filename> to "-e MAKEFLAGS=" by
2801 default was a historical accident that has required many classes
2802 (e.g. <filename>autotools</filename>, <filename>module</filename>)
2803 and recipes to override this default in order to work with
2804 sensible build systems.
2805 When upgrading to the release, you must edit any recipe that
2806 relies upon this old default by either setting
2807 <filename>EXTRA_OEMAKE</filename> back to "-e MAKEFLAGS=" or by
2808 explicitly setting any required variable value overrides using
2809 <filename>EXTRA_OEMAKE</filename>, which is typically only needed
2810 when a Makefile sets a default value for a variable that is
2811 inappropriate for cross-compilation using the "=" operator rather
2812 than the "?=" operator.
2813 </para>
2814 </section>
2815
2816 <section id='migration-2.1-libexecdir-reverted-to-prefix-libexec'>
2817 <title><filename>libexecdir</filename> Reverted to <filename>${prefix}/libexec</filename></title>
2818
2819 <para>
2820 The use of <filename>${libdir}/${BPN}</filename> as
2821 <filename>libexecdir</filename> is different as compared to all
2822 other mainstream distributions, which either uses
2823 <filename>${prefix}/libexec</filename> or
2824 <filename>${libdir}</filename>.
2825 The use is also contrary to the GNU Coding Standards
2826 (i.e. <ulink url='https://www.gnu.org/prep/standards/html_node/Directory-Variables.html'></ulink>)
2827 that suggest <filename>${prefix}/libexec</filename> and also
2828 notes that any package-specific nesting should be done by the
2829 package itself.
2830 Finally, having <filename>libexecdir</filename> change between
2831 recipes makes it very difficult for different recipes to invoke
2832 binaries that have been installed into
2833 <filename>libexecdir</filename>.
2834 The Filesystem Hierarchy Standard
2835 (i.e. <ulink url='http://refspecs.linuxfoundation.org/FHS_3.0/fhs/ch04s07.html'></ulink>)
2836 now recognizes the use of <filename>${prefix}/libexec/</filename>,
2837 giving distributions the choice between
2838 <filename>${prefix}/lib</filename> or
2839 <filename>${prefix}/libexec</filename> without breaking FHS.
2840 </para>
2841 </section>
2842
2843 <section id='migration-2.1-ac-cv-sizeof-off-t-no-longer-cached-in-site-files'>
2844 <title><filename>ac_cv_sizeof_off_t</filename> is No Longer Cached in Site Files</title>
2845
2846 <para>
2847 For recipes inheriting the
2848 <link linkend='ref-classes-autotools'><filename>autotools</filename></link>
2849 class, <filename>ac_cv_sizeof_off_t</filename> is no longer cached
2850 in the site files for <filename>autoconf</filename>.
2851 The reason for this change is because the
2852 <filename>ac_cv_sizeof_off_t</filename> value is not necessarily
2853 static per architecture as was previously assumed.
2854 Rather, the value changes based on whether large file support is
2855 enabled.
2856 For most software that uses <filename>autoconf</filename>, this
2857 change should not be a problem.
2858 However, if you have a recipe that bypasses the standard
2859 <link linkend='ref-tasks-configure'><filename>do_configure</filename></link>
2860 task from the <filename>autotools</filename> class and the software
2861 the recipe is building uses a very old version of
2862 <filename>autoconf</filename>, the recipe might be incapable of
2863 determining the correct size of <filename>off_t</filename> during
2864 <filename>do_configure</filename>.
2865 </para>
2866
2867 <para>
2868 The best course of action is to patch the software as necessary
2869 to allow the default implementation from the
2870 <filename>autotools</filename> class to work such that
2871 <filename>autoreconf</filename> succeeds and produces a working
Patrick Williamsc0f7c042017-02-23 20:41:17 -06002872 configure script, and to remove the
Patrick Williamsd8c66bc2016-06-20 12:57:21 -05002873 overridden <filename>do_configure</filename> task such that the
2874 default implementation does get used.
2875 </para>
2876 </section>
2877
2878 <section id='migration-2.1-image-generation-split-out-from-filesystem-generation'>
2879 <title>Image Generation is Now Split Out from Filesystem Generation</title>
2880
2881 <para>
2882 Previously, for image recipes the
2883 <link linkend='ref-tasks-rootfs'><filename>do_rootfs</filename></link>
2884 task assembled the filesystem and then from that filesystem
2885 generated images.
2886 With this Yocto Project release, image generation is split into
2887 separate
2888 <link linkend='ref-tasks-image'><filename>do_image_*</filename></link>
2889 tasks for clarity both in operation and in the code.
2890 </para>
2891
2892 <para>
2893 For most cases, this change does not present any problems.
2894 However, if you have made customizations that directly modify the
2895 <filename>do_rootfs</filename> task or that mention
2896 <filename>do_rootfs</filename>, you might need to update those
2897 changes.
2898 In particular, if you had added any tasks after
2899 <filename>do_rootfs</filename>, you should make edits so that
2900 those tasks are after the
2901 <link linkend='ref-tasks-image-complete'><filename>do_image_complete</filename></link>
Patrick Williamsc0f7c042017-02-23 20:41:17 -06002902 task rather than after <filename>do_rootfs</filename>
2903 so that the your added tasks
Patrick Williamsd8c66bc2016-06-20 12:57:21 -05002904 run at the correct time.
2905 </para>
2906
2907 <para>
2908 A minor part of this restructuring is that the post-processing
2909 definitions and functions have been moved from the
2910 <link linkend='ref-classes-image'><filename>image</filename></link>
2911 class to the
2912 <link linkend='ref-classes-rootfs*'><filename>rootfs-postcommands</filename></link>
2913 class.
2914 Functionally, however, they remain unchanged.
2915 </para>
2916 </section>
2917
2918 <section id='migration-2.1-removed-recipes'>
2919 <title>Removed Recipes</title>
2920
2921 <para>
2922 The following recipes have been removed in the 2.1 release:
2923 <itemizedlist>
2924 <listitem><para><filename>gcc</filename> version 4.8:
2925 Versions 4.9 and 5.3 remain.
2926 </para></listitem>
2927 <listitem><para><filename>qt4</filename>:
2928 All support for Qt 4.x has been moved out to a separate
2929 <filename>meta-qt4</filename> layer because Qt 4 is no
2930 longer supported upstream.
2931 </para></listitem>
2932 <listitem><para><filename>x11vnc</filename>:
2933 Moved to the <filename>meta-oe</filename> layer.
2934 </para></listitem>
2935 <listitem><para><filename>linux-yocto-3.14</filename>:
2936 No longer supported.
2937 </para></listitem>
2938 <listitem><para><filename>linux-yocto-3.19</filename>:
2939 No longer supported.
2940 </para></listitem>
2941 <listitem><para><filename>libjpeg</filename>:
2942 Replaced by the <filename>libjpeg-turbo</filename> recipe.
2943 </para></listitem>
2944 <listitem><para><filename>pth</filename>:
2945 Became obsolete.
2946 </para></listitem>
2947 <listitem><para><filename>liboil</filename>:
2948 Recipe is no longer needed and has been moved to the
2949 <filename>meta-multimedia</filename> layer.
2950 </para></listitem>
2951 <listitem><para><filename>gtk-theme-torturer</filename>:
2952 Recipe is no longer needed and has been moved to the
2953 <filename>meta-gnome</filename> layer.
2954 </para></listitem>
2955 <listitem><para><filename>gnome-mime-data</filename>:
2956 Recipe is no longer needed and has been moved to the
2957 <filename>meta-gnome</filename> layer.
2958 </para></listitem>
2959 <listitem><para><filename>udev</filename>:
2960 Replaced by the <filename>eudev</filename> recipe for
2961 compatibility when using <filename>sysvinit</filename>
2962 with newer kernels.
2963 </para></listitem>
2964 <listitem><para><filename>python-pygtk</filename>:
2965 Recipe became obsolete.
2966 </para></listitem>
2967 <listitem><para><filename>adt-installer</filename>:
2968 Recipe became obsolete.
2969 See the
2970 "<link linkend='migration-2.1-adt-removed'>ADT Removed</link>"
2971 section for more information.
2972 </para></listitem>
2973 </itemizedlist>
2974 </para>
2975 </section>
2976
2977 <section id='migration-2.1-class-changes'>
2978 <title>Class Changes</title>
2979
2980 <para>
2981 The following classes have changed:
2982 <itemizedlist>
2983 <listitem><para><filename>autotools_stage</filename>:
2984 Removed because the
2985 <link linkend='ref-classes-autotools'><filename>autotools</filename></link>
2986 class now provides its functionality.
2987 Recipes that inherited from
2988 <filename>autotools_stage</filename> should now inherit
2989 from <filename>autotools</filename> instead.
2990 </para></listitem>
2991 <listitem><para><filename>boot-directdisk</filename>:
Brad Bishopd7bf8c12018-02-25 22:55:05 -05002992 Merged into the <filename>image-vm</filename>
Patrick Williamsd8c66bc2016-06-20 12:57:21 -05002993 class.
2994 The <filename>boot-directdisk</filename> class was rarely
2995 directly used.
2996 Consequently, this change should not cause any issues.
2997 </para></listitem>
2998 <listitem><para><filename>bootimg</filename>:
2999 Merged into the
3000 <link linkend='ref-classes-image-live'><filename>image-live</filename></link>
3001 class.
3002 The <filename>bootimg</filename> class was rarely
3003 directly used.
3004 Consequently, this change should not cause any issues.
3005 </para></listitem>
3006 <listitem><para><filename>packageinfo</filename>:
3007 Removed due to its limited use by the Hob UI, which has
3008 itself been removed.
3009 </para></listitem>
3010 </itemizedlist>
3011 </para>
3012 </section>
3013
3014 <section id='migration-2.1-build-system-ui-changes'>
3015 <title>Build System User Interface Changes</title>
3016
3017 <para>
3018 The following changes have been made to the build system user
3019 interface:
3020 <itemizedlist>
3021 <listitem><para><emphasis>Hob GTK+-based UI</emphasis>:
3022 Removed because it is unmaintained and based on the
3023 outdated GTK+ 2 library.
3024 The Toaster web-based UI is much more capable and is
3025 actively maintained.
3026 See the
3027 "<ulink url='&YOCTO_DOCS_TOAST_URL;#using-the-toaster-web-interface'>Using the Toaster Web Interface</ulink>"
Brad Bishop316dfdd2018-06-25 12:45:53 -04003028 section in the Toaster User Manual for more
Patrick Williamsd8c66bc2016-06-20 12:57:21 -05003029 information on this interface.
3030 </para></listitem>
3031 <listitem><para><emphasis>"puccho" BitBake UI</emphasis>:
3032 Removed because is unmaintained and no longer useful.
3033 </para></listitem>
3034 </itemizedlist>
3035 </para>
3036 </section>
3037
3038 <section id='migration-2.1-adt-removed'>
3039 <title>ADT Removed</title>
3040
3041 <para>
3042 The Application Development Toolkit (ADT) has been removed
3043 because its functionality almost completely overlapped with the
3044 <ulink url='&YOCTO_DOCS_SDK_URL;#sdk-using-the-standard-sdk'>standard SDK</ulink>
3045 and the
3046 <ulink url='&YOCTO_DOCS_SDK_URL;#sdk-extensible'>extensible SDK</ulink>.
3047 For information on these SDKs and how to build and use them, see the
Brad Bishop316dfdd2018-06-25 12:45:53 -04003048 <ulink url='&YOCTO_DOCS_SDK_URL;'>Yocto Project Application Development and the Extensible Software Development Kit (eSDK)</ulink>
3049 manual.
Patrick Williamsc0f7c042017-02-23 20:41:17 -06003050 <note>
3051 The Yocto Project Eclipse IDE Plug-in is still supported and
3052 is not affected by this change.
3053 </note>
Patrick Williamsd8c66bc2016-06-20 12:57:21 -05003054 </para>
3055 </section>
3056
3057 <section id='migration-2.1-poky-reference-distribution-changes'>
3058 <title>Poky Reference Distribution Changes</title>
3059
3060 <para>
3061 The following changes have been made for the Poky distribution:
3062 <itemizedlist>
3063 <listitem><para>
3064 The <filename>meta-yocto</filename> layer has been renamed
3065 to <filename>meta-poky</filename> to better match its
3066 purpose, which is to provide the Poky reference
3067 distribution.
3068 The <filename>meta-yocto-bsp</filename> layer retains its
3069 original name since it provides reference machines for
3070 the Yocto Project and it is otherwise unrelated to Poky.
3071 References to <filename>meta-yocto</filename> in your
3072 <filename>conf/bblayers.conf</filename> should
3073 automatically be updated, so you should not need to change
3074 anything unless you are relying on this naming elsewhere.
3075 </para></listitem>
3076 <listitem><para>
3077 The
3078 <link linkend='ref-classes-uninative'><filename>uninative</filename></link>
3079 class is now enabled by default in Poky.
3080 This class attempts to isolate the build system from the
3081 host distribution's C library and makes re-use of native
3082 shared state artifacts across different host distributions
3083 practical.
3084 With this class enabled, a tarball containing a pre-built
3085 C library is downloaded at the start of the build.</para>
3086
3087 <para>The <filename>uninative</filename> class is enabled
3088 through the
3089 <filename>meta/conf/distro/include/yocto-uninative.inc</filename>
3090 file, which for those not using the Poky distribution, can
3091 include to easily enable the same functionality.</para>
3092
3093 <para>Alternatively, if you wish to build your own
3094 <filename>uninative</filename> tarball, you can do so by
3095 building the <filename>uninative-tarball</filename> recipe,
3096 making it available to your build machines
3097 (e.g. over HTTP/HTTPS) and setting a similar configuration
3098 as the one set by <filename>yocto-uninative.inc</filename>.
3099 </para></listitem>
3100 <listitem><para>
3101 Static library generation, for most cases, is now disabled
3102 by default in the Poky distribution.
3103 Disabling this generation saves some build time as well
3104 as the size used for build output artifacts.</para>
3105
3106 <para>Disabling this library generation is accomplished
3107 through a
3108 <filename>meta/conf/distro/include/no-static-libs.inc</filename>,
3109 which for those not using the Poky distribution can
3110 easily include to enable the same functionality.</para>
3111
3112 <para>Any recipe that needs to opt-out of having the
3113 "--disable-static" option specified on the configure
3114 command line either because it is not a supported option
3115 for the configure script or because static libraries are
3116 needed should set the following variable:
3117 <literallayout class='monospaced'>
3118 DISABLE_STATIC = ""
3119 </literallayout>
3120 </para></listitem>
3121 <listitem><para>
3122 The separate <filename>poky-tiny</filename> distribution
3123 now uses the musl C library instead of a heavily pared
3124 down <filename>glibc</filename>.
Patrick Williamsc0f7c042017-02-23 20:41:17 -06003125 Using musl results in a smaller
Patrick Williamsd8c66bc2016-06-20 12:57:21 -05003126 distribution and facilitates much greater maintainability
3127 because musl is designed to have a small footprint.</para>
3128
3129 <para>If you have used <filename>poky-tiny</filename> and
3130 have customized the <filename>glibc</filename>
3131 configuration you will need to redo those customizations
3132 with musl when upgrading to the new release.
3133 </para></listitem>
3134 </itemizedlist>
3135 </para>
3136 </section>
3137
3138 <section id='migration-2.1-packaging-changes'>
3139 <title>Packaging Changes</title>
3140
3141 <para>
3142 The following changes have been made to packaging:
3143 <itemizedlist>
3144 <listitem><para>
3145 The <filename>runuser</filename> and
3146 <filename>mountpoint</filename> binaries, which were
3147 previously in the main <filename>util-linux</filename>
3148 package, have been split out into the
3149 <filename>util-linux-runuser</filename> and
3150 <filename>util-linux-mountpoint</filename> packages,
3151 respectively.
3152 </para></listitem>
3153 <listitem><para>
3154 The <filename>python-elementtree</filename> package has
3155 been merged into the <filename>python-xml</filename>
3156 package.
3157 </para></listitem>
3158 </itemizedlist>
3159 </para>
3160 </section>
3161
3162 <section id='migration-2.1-tuning-file-changes'>
3163 <title>Tuning File Changes</title>
3164
3165 <para>
3166 The following changes have been made to the tuning files:
3167 <itemizedlist>
3168 <listitem><para>
3169 The "no-thumb-interwork" tuning feature has been dropped
3170 from the ARM tune include files.
3171 Because interworking is required for ARM EABI, attempting
3172 to disable it through a tuning feature no longer makes
3173 sense.
3174 <note>
3175 Support for ARM OABI was deprecated in gcc 4.7.
3176 </note>
3177 </para></listitem>
3178 <listitem><para>
3179 The <filename>tune-cortexm*.inc</filename> and
3180 <filename>tune-cortexr4.inc</filename> files have been
3181 removed because they are poorly tested.
3182 Until the OpenEmbedded build system officially gains
3183 support for CPUs without an MMU, these tuning files would
3184 probably be better maintained in a separate layer
3185 if needed.
3186 </para></listitem>
3187 </itemizedlist>
3188 </para>
3189 </section>
3190
Patrick Williamsc0f7c042017-02-23 20:41:17 -06003191 <section id='migration-2.1-supporting-gobject-introspection'>
3192 <title>Supporting GObject Introspection</title>
3193
3194 <para>
3195 This release supports generation of GLib Introspective
3196 Repository (GIR) files through GObject introspection, which is
3197 the standard mechanism for accessing GObject-based software from
3198 runtime environments.
3199 You can enable, disable, and test the generation of this data.
3200 See the
3201 "<ulink url='&YOCTO_DOCS_DEV_URL;#enabling-gobject-introspection-support'>Enabling GObject Introspection Support</ulink>"
Brad Bishopd7bf8c12018-02-25 22:55:05 -05003202 section in the Yocto Project Development Tasks Manual
3203 for more information.
Patrick Williamsc0f7c042017-02-23 20:41:17 -06003204 </para>
3205 </section>
3206
Patrick Williamsd8c66bc2016-06-20 12:57:21 -05003207 <section id='migration-2.1-miscellaneous-changes'>
3208 <title>Miscellaneous Changes</title>
3209
3210 <para>
3211 These additional changes exist:
3212 <itemizedlist>
3213 <listitem><para>
3214 The minimum Git version has been increased to 1.8.3.1.
3215 If your host distribution does not provide a sufficiently
3216 recent version, you can install the buildtools, which
3217 will provide it.
Patrick Williamsc0f7c042017-02-23 20:41:17 -06003218 See the
3219 "<link linkend='required-git-tar-and-python-versions'>Required Git, tar, and Python Versions</link>"
3220 section for more information on the buildtools tarball.
Patrick Williamsd8c66bc2016-06-20 12:57:21 -05003221 </para></listitem>
3222 <listitem><para>
3223 The buggy and incomplete support for the RPM version 4
3224 package manager has been removed.
3225 The well-tested and maintained support for RPM version 5
3226 remains.
3227 </para></listitem>
3228 <listitem><para>
Patrick Williamsc0f7c042017-02-23 20:41:17 -06003229 Previously, the following list of packages were removed
3230 if package-management was not in
3231 <link linkend='var-IMAGE_FEATURES'><filename>IMAGE_FEATURES</filename></link>,
3232 regardless of any dependencies:
3233 <literallayout class='monospaced'>
3234 update-rc.d
3235 base-passwd
3236 shadow
3237 update-alternatives
3238 run-postinsts
3239 </literallayout>
3240 With the Yocto Project 2.1 release, these packages are only
3241 removed if "read-only-rootfs" is in
3242 <filename>IMAGE_FEATURES</filename>, since they might
3243 still be needed for a read-write image even in the absence
3244 of a package manager (e.g. if users need to be added,
3245 modified, or removed at runtime).
3246 </para></listitem>
3247 <listitem><para>
Patrick Williamsd8c66bc2016-06-20 12:57:21 -05003248 The
3249 <ulink url='&YOCTO_DOCS_SDK_URL;#sdk-devtool-use-devtool-modify-to-modify-the-source-of-an-existing-component'><filename>devtool modify</filename></ulink>
3250 command now defaults to extracting the source since that
3251 is most commonly expected.
3252 The "-x" or "--extract" options are now no-ops.
3253 If you wish to provide your own existing source tree, you
3254 will now need to specify either the "-n" or
Patrick Williamsc0f7c042017-02-23 20:41:17 -06003255 "--no-extract" options when running
Patrick Williamsd8c66bc2016-06-20 12:57:21 -05003256 <filename>devtool modify</filename>.
3257 </para></listitem>
3258 <listitem><para>
3259 If the formfactor for a machine is either not supplied
3260 or does not specify whether a keyboard is attached, then
3261 the default is to assume a keyboard is attached rather
3262 than assume no keyboard.
Patrick Williamsc0f7c042017-02-23 20:41:17 -06003263 This change primarily affects the Sato UI.
3264 </para></listitem>
Patrick Williamsd8c66bc2016-06-20 12:57:21 -05003265 <listitem><para>
3266 The <filename>.debug</filename> directory packaging is
3267 now automatic.
3268 If your recipe builds software that installs binaries into
3269 directories other than the standard ones, you no longer
3270 need to take care of setting
3271 <filename>FILES_${PN}-dbg</filename> to pick up the
3272 resulting <filename>.debug</filename> directories as these
3273 directories are automatically found and added.
3274 </para></listitem>
3275 <listitem><para>
3276 Inaccurate disk and CPU percentage data has been dropped
3277 from <filename>buildstats</filename> output.
3278 This data has been replaced with
3279 <filename>getrusage()</filename> data and corrected IO
3280 statistics.
Patrick Williamsc0f7c042017-02-23 20:41:17 -06003281 You will probably need to update any custom code that reads
3282 the <filename>buildstats</filename> data.
Patrick Williamsd8c66bc2016-06-20 12:57:21 -05003283 </para></listitem>
3284 <listitem><para>
3285 The
3286 <filename>meta/conf/distro/include/package_regex.inc</filename>
3287 is now deprecated.
3288 The contents of this file have been moved to individual
3289 recipes.
3290 <note><title>Tip</title>
3291 Because this file will likely be removed in a future
3292 Yocto Project release, it is suggested that you remove
3293 any references to the file that might be in your
3294 configuration.
3295 </note>
3296 </para></listitem>
3297 <listitem><para>
3298 The <filename>v86d/uvesafb</filename> has been removed from
3299 the <filename>genericx86</filename> and
3300 <filename>genericx86-64</filename> reference machines,
3301 which are provided by the
3302 <filename>meta-yocto-bsp</filename> layer.
3303 Most modern x86 boards do not rely on this file and it only
3304 adds kernel error messages during startup.
Patrick Williamsc0f7c042017-02-23 20:41:17 -06003305 If you do still need to support
3306 <filename>uvesafb</filename>, you can
3307 simply add <filename>v86d</filename> to your image.
3308 </para></listitem>
3309 <listitem><para>
3310 Build sysroot paths are now removed from debug symbol
3311 files.
3312 Removing these paths means that remote GDB using an
3313 unstripped build system sysroot will no longer work
3314 (although this was never documented to work).
3315 The supported method to accomplish something similar is
3316 to set <filename>IMAGE_GEN_DEBUGFS</filename> to "1",
3317 which will generate a companion debug image
3318 containing unstripped binaries and associated debug
3319 sources alongside the image.
3320 </para></listitem>
3321 </itemizedlist>
3322 </para>
3323 </section>
3324</section>
3325
3326<section id='moving-to-the-yocto-project-2.2-release'>
3327 <title>Moving to the Yocto Project 2.2 Release</title>
3328
3329 <para>
3330 This section provides migration information for moving to the
3331 Yocto Project 2.2 Release from the prior release.
3332 </para>
3333
3334 <section id='migration-2.2-minimum-kernel-version'>
3335 <title>Minimum Kernel Version</title>
3336
3337 <para>
3338 The minimum kernel version for the target system and for SDK
3339 is now 3.2.0, due to the upgrade
3340 to <filename>glibc 2.24</filename>.
3341 Specifically, for AArch64-based targets the version is
3342 3.14.
3343 For Nios II-based targets, the minimum kernel version is 3.19.
3344 <note>
3345 For x86 and x86_64, you can reset
3346 <link linkend='var-OLDEST_KERNEL'><filename>OLDEST_KERNEL</filename></link>
3347 to anything down to 2.6.32 if desired.
3348 </note>
3349 </para>
3350 </section>
3351
3352 <section id='migration-2.2-staging-directories-in-sysroot-simplified'>
3353 <title>Staging Directories in Sysroot Has Been Simplified</title>
3354
3355 <para>
3356 The way directories are staged in sysroot has been simplified and
3357 introduces the new
3358 <link linkend='var-SYSROOT_DIRS'><filename>SYSROOT_DIRS</filename></link>,
3359 <link linkend='var-SYSROOT_DIRS_NATIVE'><filename>SYSROOT_DIRS_NATIVE</filename></link>,
3360 and
3361 <link linkend='var-SYSROOT_DIRS_BLACKLIST'><filename>SYSROOT_DIRS_BLACKLIST</filename></link>.
3362 See the
3363 <ulink url='http://lists.openembedded.org/pipermail/openembedded-core/2016-May/121365.html'>v2 patch series on the OE-Core Mailing List</ulink>
3364 for additional information.
3365 </para>
3366 </section>
3367
3368 <section id='migration-2.2-removal-of-old-images-from-tmp-deploy-now-enabled'>
3369 <title>Removal of Old Images and Other Files in <filename>tmp/deploy</filename> Now Enabled</title>
3370
3371 <para>
3372 Removal of old images and other files in
3373 <filename>tmp/deploy/</filename> is now enabled by default due
3374 to a new staging method used for those files.
3375 As a result of this change, the
3376 <filename>RM_OLD_IMAGE</filename> variable is now redundant.
3377 </para>
3378 </section>
3379
3380 <section id='migration-2.2-python-changes'>
3381 <title>Python Changes</title>
3382
3383 <para>
3384 The following changes for Python occurred:
3385 </para>
3386
3387 <section id='migration-2.2-bitbake-now-requires-python-3.4'>
3388 <title>BitBake Now Requires Python 3.4+</title>
3389
3390 <para>
3391 BitBake requires Python 3.4 or greater.
3392 </para>
3393 </section>
3394
3395 <section id='migration-2.2-utf-8-locale-required-on-build-host'>
3396 <title>UTF-8 Locale Required on Build Host</title>
3397
3398 <para>
3399 A UTF-8 locale is required on the build host due to Python 3.
3400 Since C.UTF-8 is not a standard, the default is en_US.UTF-8.
3401 </para>
3402 </section>
3403
3404 <section id='migration-2.2-metadata-now-must-use-python-3-syntax'>
3405 <title>Metadata Must Now Use Python 3 Syntax</title>
3406
3407 <para>
3408 The metadata is now required to use Python 3 syntax.
3409 For help preparing metadata, see any of the many Python 3 porting
3410 guides available.
3411 Alternatively, you can reference the conversion commits for Bitbake
Brad Bishopd7bf8c12018-02-25 22:55:05 -05003412 and you can use
3413 <link linkend='oe-core'>OE-Core</link> as a guide for changes.
Patrick Williamsc0f7c042017-02-23 20:41:17 -06003414 Following are particular areas of interest:
3415 <literallayout class='monospaced'>
3416 * subprocess command-line pipes needing locale decoding
3417 * the syntax for octal values changed
3418 * the <filename>iter*()</filename> functions changed name
3419 * iterators now return views, not lists
3420 * changed names for Python modules
3421 </literallayout>
3422 </para>
3423 </section>
3424
3425 <section id='migration-2.2-target-python-recipes-switched-to-python-3'>
3426 <title>Target Python Recipes Switched to Python 3</title>
3427
3428 <para>
3429 Most target Python recipes have now been switched to Python 3.
3430 Unfortunately, systems using RPM as a package manager and
3431 providing online package-manager support through SMART still
3432 require Python 2.
3433 <note>
3434 Python 2 and recipes that use it can still be built for the
3435 target as with previous versions.
3436 </note>
3437 </para>
3438 </section>
3439
3440 <section id='migration-2.2-buildtools-tarball-includes-python-3'>
3441 <title><filename>buildtools-tarball</filename> Includes Python 3</title>
3442
3443 <para>
3444 <filename>buildtools-tarball</filename> now includes Python 3.
3445 </para>
3446 </section>
3447 </section>
3448
3449 <section id='migration-2.2-uclibc-replaced-by-musl'>
3450 <title>uClibc Replaced by musl</title>
3451
3452 <para>
3453 uClibc has been removed in favor of musl.
3454 Musl has matured, is better maintained, and is compatible with a
3455 wider range of applications as compared to uClibc.
3456 </para>
3457 </section>
3458
3459 <section id='migration-2.2-B-no-longer-default-working-directory-for-tasks'>
3460 <title><filename>${B}</filename> No Longer Default Working Directory for Tasks</title>
3461
3462 <para>
3463 <filename>${</filename><link linkend='var-B'><filename>B</filename></link><filename>}</filename>
3464 is no longer the default working directory for tasks.
3465 Consequently, any custom tasks you define now need to either
3466 have the
3467 <filename>[</filename><ulink url='&YOCTO_DOCS_BB_URL;#variable-flags'><filename>dirs</filename></ulink><filename>]</filename> flag set, or the task needs to change into the
3468 appropriate working directory manually (e.g using
3469 <filename>cd</filename> for a shell task).
3470 <note>
3471 The preferred method is to use the
3472 <filename>[dirs]</filename> flag.
3473 </note>
3474 </para>
3475 </section>
3476
3477 <section id='migration-2.2-runqemu-ported-to-python'>
3478 <title><filename>runqemu</filename> Ported to Python</title>
3479
3480 <para>
3481 <filename>runqemu</filename> has been ported to Python and has
3482 changed behavior in some cases.
Brad Bishop37a0e4d2017-12-04 01:01:44 -05003483 Previous usage patterns continue to be supported.
Patrick Williamsc0f7c042017-02-23 20:41:17 -06003484 </para>
3485
3486 <para>
3487 The new <filename>runqemu</filename> is a Python script.
3488 Machine knowledge is no longer hardcoded into
3489 <filename>runqemu</filename>.
3490 You can choose to use the <filename>qemuboot</filename>
3491 configuration file to define the BSP's own arguments and to make
3492 it bootable with <filename>runqemu</filename>.
3493 If you use a configuration file, use the following form:
3494 <literallayout class='monospaced'>
3495 <replaceable>image-name</replaceable>-<replaceable>machine</replaceable>.qemuboot.conf
3496 </literallayout>
3497 The configuration file enables fine-grained tuning of options
3498 passed to QEMU without the <filename>runqemu</filename> script
3499 hard-coding any knowledge about different machines.
3500 Using a configuration file is particularly convenient when trying
3501 to use QEMU with machines other than the
Brad Bishopd7bf8c12018-02-25 22:55:05 -05003502 <filename>qemu*</filename> machines in
3503 <link linkend='oe-core'>OE-Core</link>.
Patrick Williamsc0f7c042017-02-23 20:41:17 -06003504 The <filename>qemuboot.conf</filename> file is generated by the
3505 <filename>qemuboot</filename>
3506 class when the root filesystem is being build (i.e.
3507 build rootfs).
3508 QEMU boot arguments can be set in BSP's configuration file and
3509 the <filename>qemuboot</filename> class will save them to
3510 <filename>qemuboot.conf</filename>.
3511 </para>
3512
3513
3514 <para>
3515 If you want to use <filename>runqemu</filename> without a
3516 configuration file, use the following command form:
3517 <literallayout class='monospaced'>
3518 $ runqemu <replaceable>machine</replaceable> <replaceable>rootfs</replaceable> <replaceable>kernel</replaceable> [<replaceable>options</replaceable>]
3519 </literallayout>
3520 Supported <replaceable>machines</replaceable> are as follows:
3521 <literallayout class='monospaced'>
3522 qemuarm
3523 qemuarm64
3524 qemux86
3525 qemux86-64
3526 qemuppc
3527 qemumips
3528 qemumips64
3529 qemumipsel
3530 qemumips64el
3531 </literallayout>
3532 Consider the following example, which uses the
3533 <filename>qemux86-64</filename> machine,
3534 provides a root filesystem, provides an image, and uses
3535 the <filename>nographic</filename> option:
3536 <literallayout class='monospaced'>
3537$ runqemu qemux86-64 tmp/deploy/images/qemux86-64/core-image-minimal-qemux86-64.ext4 tmp/deploy/images/qemux86-64/bzImage nographic
3538 </literallayout>
3539 </para>
3540
3541 <para>
3542 Following is a list of variables that can be set in configuration
3543 files such as <filename>bsp.conf</filename> to enable the BSP
3544 to be booted by <filename>runqemu</filename>:
3545 <note>
3546 "QB" means "QEMU Boot".
3547 </note>
3548 <literallayout class='monospaced'>
3549 QB_SYSTEM_NAME: QEMU name (e.g. "qemu-system-i386")
3550 QB_OPT_APPEND: Options to append to QEMU (e.g. "-show-cursor")
3551 QB_DEFAULT_KERNEL: Default kernel to boot (e.g. "bzImage")
3552 QB_DEFAULT_FSTYPE: Default FSTYPE to boot (e.g. "ext4")
3553 QB_MEM: Memory (e.g. "-m 512")
3554 QB_MACHINE: QEMU machine (e.g. "-machine virt")
3555 QB_CPU: QEMU cpu (e.g. "-cpu qemu32")
3556 QB_CPU_KVM: Similar to QB_CPU except used for kvm support (e.g. "-cpu kvm64")
3557 QB_KERNEL_CMDLINE_APPEND: Options to append to the kernel's -append
3558 option (e.g. "console=ttyS0 console=tty")
3559 QB_DTB: QEMU dtb name
3560 QB_AUDIO_DRV: QEMU audio driver (e.g. "alsa", set it when support audio)
3561 QB_AUDIO_OPT: QEMU audio option (e.g. "-soundhw ac97,es1370"), which is used
3562 when QB_AUDIO_DRV is set.
3563 QB_KERNEL_ROOT: Kernel's root (e.g. /dev/vda)
3564 QB_TAP_OPT: Network option for 'tap' mode (e.g.
3565 "-netdev tap,id=net0,ifname=@TAP@,script=no,downscript=no -device virtio-net-device,netdev=net0").
3566 runqemu will replace "@TAP@" with the one that is used, such as tap0, tap1 ...
3567 QB_SLIRP_OPT: Network option for SLIRP mode (e.g. "-netdev user,id=net0 -device virtio-net-device,netdev=net0")
3568 QB_ROOTFS_OPT: Used as rootfs (e.g.
3569 "-drive id=disk0,file=@ROOTFS@,if=none,format=raw -device virtio-blk-device,drive=disk0").
3570 runqemu will replace "@ROOTFS@" with the one which is used, such as
3571 core-image-minimal-qemuarm64.ext4.
3572 QB_SERIAL_OPT: Serial port (e.g. "-serial mon:stdio")
3573 QB_TCPSERIAL_OPT: tcp serial port option (e.g.
3574 " -device virtio-serial-device -chardev socket,id=virtcon,port=@PORT@,host=127.0.0.1 -device virtconsole,chardev=virtcon"
3575 runqemu will replace "@PORT@" with the port number which is used.
3576 </literallayout>
3577 </para>
3578
3579 <para>
3580 To use <filename>runqemu</filename>, set
3581 <link linkend='var-IMAGE_CLASSES'><filename>IMAGE_CLASSES</filename></link>
3582 as follows and run <filename>runqemu</filename>:
3583 <note>
3584 For command-line syntax, use
3585 <filename>runqemu help</filename>.
3586 </note>
3587 <literallayout class='monospaced'>
3588 IMAGE_CLASSES += "qemuboot"
3589 </literallayout>
3590 </para>
3591 </section>
3592
3593 <section id='migration-2.2-default-linker-hash-style-changed'>
3594 <title>Default Linker Hash Style Changed</title>
3595
3596 <para>
3597 The default linker hash style for <filename>gcc-cross</filename>
3598 is now "sysv" in order to catch recipes that are building software
3599 without using the OpenEmbedded
3600 <link linkend='var-LDFLAGS'><filename>LDFLAGS</filename></link>.
3601 This change could result in seeing some "No GNU_HASH in the elf
3602 binary" QA issues when building such recipes.
3603 You need to fix these recipes so that they use the expected
3604 <filename>LDFLAGS</filename>.
3605 Depending on how the software is built, the build system used by
3606 the software (e.g. a Makefile) might need to be patched.
3607 However, sometimes making this fix is as simple as adding the
3608 following to the recipe:
3609 <literallayout class='monospaced'>
3610 TARGET_CC_ARCH += "${LDFLAGS}"
3611 </literallayout>
3612 </para>
3613 </section>
3614
Brad Bishop37a0e4d2017-12-04 01:01:44 -05003615 <section id='migration-2.2-kernel-image-base-name-no-longer-uses-kernel-imagetype'>
3616 <title><filename>KERNEL_IMAGE_BASE_NAME</filename> no Longer Uses <filename>KERNEL_IMAGETYPE</filename></title>
3617
3618 <para>
3619 The
Brad Bishop1a4b7ee2018-12-16 17:11:34 -08003620 <filename>KERNEL_IMAGE_BASE_NAME</filename>
Brad Bishop37a0e4d2017-12-04 01:01:44 -05003621 variable no longer uses the
3622 <link linkend='var-KERNEL_IMAGETYPE'><filename>KERNEL_IMAGETYPE</filename></link>
3623 variable to create the image's base name.
3624 Because the OpenEmbedded build system can now build multiple kernel
3625 image types, this part of the kernel image base name as been
3626 removed leaving only the following:
3627 <literallayout class='monospaced'>
3628 KERNEL_IMAGE_BASE_NAME ?= "${PKGE}-${PKGV}-${PKGR}-${MACHINE}-${DATETIME}
3629 </literallayout>
3630 If you have recipes or classes that use
3631 <filename>KERNEL_IMAGE_BASE_NAME</filename> directly, you might
3632 need to update the references to ensure they continue to work.
3633 </para>
3634 </section>
3635
Patrick Williamsc0f7c042017-02-23 20:41:17 -06003636 <section id='migration-2.2-bitbake-changes'>
3637 <title>BitBake Changes</title>
3638
3639 <para>
3640 The following changes took place for BitBake:
3641 <itemizedlist>
3642 <listitem><para>
3643 The "goggle" UI and standalone image-writer tool have
3644 been removed as they both require GTK+ 2.0 and
3645 were not being maintained.
3646 </para></listitem>
3647 <listitem><para>
3648 The Perforce fetcher now supports
3649 <link linkend='var-SRCREV'><filename>SRCREV</filename></link>
3650 for specifying the source revision to use, be it
3651 <filename>${</filename><link linkend='var-AUTOREV'><filename>AUTOREV</filename></link><filename>}</filename>,
3652 changelist number, p4date, or label, in preference to
3653 separate
3654 <link linkend='var-SRC_URI'><filename>SRC_URI</filename></link>
3655 parameters to specify these.
3656 This change is more in-line with how the other fetchers
3657 work for source control systems.
3658 Recipes that fetch from Perforce will need to be updated
3659 to use <filename>SRCREV</filename> in place of specifying
3660 the source revision within
3661 <filename>SRC_URI</filename>.
3662 </para></listitem>
3663 <listitem><para>
3664 Some of BitBake's internal code structures for accessing
3665 the recipe cache needed to be changed to support the new
3666 multi-configuration functionality.
3667 These changes will affect external tools that use BitBake's
3668 tinfoil module.
3669 For information on these changes, see the changes made to
3670 the scripts supplied with OpenEmbedded-Core:
3671 <ulink url='http://git.yoctoproject.org/cgit/cgit.cgi/poky/commit/?id=189371f8393971d00bca0fceffd67cc07784f6ee'>1</ulink>
3672 and
3673 <ulink url='http://git.yoctoproject.org/cgit/cgit.cgi/poky/commit/?id=4a5aa7ea4d07c2c90a1654b174873abb018acc67'>2</ulink>.
3674 </para></listitem>
3675 <listitem><para>
3676 The task management code has been rewritten to avoid using
3677 ID indirection in order to improve performance.
3678 This change is unlikely to cause any problems for most
3679 users.
3680 However, the setscene verification function as pointed to
3681 by <filename>BB_SETSCENE_VERIFY_FUNCTION</filename>
3682 needed to change signature.
3683 Consequently, a new variable named
Brad Bishop6e60e8b2018-02-01 10:27:11 -05003684 <filename>BB_SETSCENE_VERIFY_FUNCTION2</filename>
Patrick Williamsc0f7c042017-02-23 20:41:17 -06003685 has been added allowing multiple versions of BitBake
3686 to work with suitably written metadata, which includes
3687 OpenEmbedded-Core and Poky.
3688 Anyone with custom BitBake task scheduler code might also
3689 need to update the code to handle the new structure.
3690 </para></listitem>
3691 </itemizedlist>
3692 </para>
3693 </section>
3694
3695 <section id='migration-2.2-swabber-has-been-removed'>
3696 <title>Swabber has Been Removed</title>
3697
3698 <para>
3699 Swabber, a tool that was intended to detect host contamination in
3700 the build process, has been removed, as it has been unmaintained
3701 and unused for some time and was never particularly effective.
3702 The OpenEmbedded build system has since incorporated a number of
3703 mechanisms including enhanced QA checks that mean that there is
3704 less of a need for such a tool.
3705 </para>
3706 </section>
3707
3708 <section id='migration-2.2-removed-recipes'>
3709 <title>Removed Recipes</title>
3710
3711 <para>
3712 The following recipes have been removed:
3713 <itemizedlist>
3714 <listitem><para>
3715 <filename>augeas</filename>:
3716 No longer needed and has been moved to
3717 <filename>meta-oe</filename>.
3718 </para></listitem>
3719 <listitem><para>
3720 <filename>directfb</filename>:
3721 Unmaintained and has been moved to
3722 <filename>meta-oe</filename>.
3723 </para></listitem>
3724 <listitem><para>
3725 <filename>gcc</filename>:
3726 Removed 4.9 version.
3727 Versions 5.4 and 6.2 are still present.
3728 </para></listitem>
3729 <listitem><para>
3730 <filename>gnome-doc-utils</filename>:
3731 No longer needed.
3732 </para></listitem>
3733 <listitem><para>
3734 <filename>gtk-doc-stub</filename>:
3735 Replaced by <filename>gtk-doc</filename>.
3736 </para></listitem>
3737 <listitem><para>
3738 <filename>gtk-engines</filename>:
3739 No longer needed and has been moved to
3740 <filename>meta-gnome</filename>.
3741 </para></listitem>
3742 <listitem><para>
3743 <filename>gtk-sato-engine</filename>:
3744 Became obsolete.
3745 </para></listitem>
3746 <listitem><para>
3747 <filename>libglade</filename>:
3748 No longer needed and has been moved to
3749 <filename>meta-oe</filename>.
3750 </para></listitem>
3751 <listitem><para>
3752 <filename>libmad</filename>:
3753 Unmaintained and functionally replaced by
3754 <filename>libmpg123</filename>.
3755 <filename>libmad</filename> has been moved to
3756 <filename>meta-oe</filename>.
3757 </para></listitem>
3758 <listitem><para>
3759 <filename>libowl</filename>:
3760 Became obsolete.
3761 </para></listitem>
3762 <listitem><para>
3763 <filename>libxsettings-client</filename>:
3764 No longer needed.
3765 </para></listitem>
3766 <listitem><para>
3767 <filename>oh-puzzles</filename>:
3768 Functionally replaced by
3769 <filename>puzzles</filename>.
3770 </para></listitem>
3771 <listitem><para>
3772 <filename>oprofileui</filename>:
3773 Became obsolete.
3774 OProfile has been largely supplanted by perf.
3775 </para></listitem>
3776 <listitem><para>
3777 <filename>packagegroup-core-directfb.bb</filename>:
3778 Removed.
3779 </para></listitem>
3780 <listitem><para>
3781 <filename>core-image-directfb.bb</filename>:
3782 Removed.
3783 </para></listitem>
3784 <listitem><para>
3785 <filename>pointercal</filename>:
3786 No longer needed and has been moved to
3787 <filename>meta-oe</filename>.
3788 </para></listitem>
3789 <listitem><para>
3790 <filename>python-imaging</filename>:
3791 No longer needed and moved to
3792 <filename>meta-python</filename>
3793 </para></listitem>
3794 <listitem><para>
3795 <filename>python-pyrex</filename>:
3796 No longer needed and moved to
3797 <filename>meta-python</filename>.
3798 </para></listitem>
3799 <listitem><para>
3800 <filename>sato-icon-theme</filename>:
3801 Became obsolete.
3802 </para></listitem>
3803 <listitem><para>
3804 <filename>swabber-native</filename>:
3805 Swabber has been removed.
3806 See the
3807 <link linkend='migration-2.2-swabber-has-been-removed'>entry on Swabber</link>.
3808 </para></listitem>
3809 <listitem><para>
3810 <filename>tslib</filename>:
3811 No longer needed and has been moved to
3812 <filename>meta-oe</filename>.
3813 </para></listitem>
3814 <listitem><para>
3815 <filename>uclibc</filename>:
3816 Removed in favor of musl.
3817 </para></listitem>
3818 <listitem><para>
3819 <filename>xtscal</filename>:
3820 No longer needed and moved to
3821 <filename>meta-oe</filename>
3822 </para></listitem>
3823 </itemizedlist>
3824 </para>
3825 </section>
3826
3827 <section id='migration-2.2-removed-classes'>
3828 <title>Removed Classes</title>
3829
3830 <para>
3831 The following classes have been removed:
3832 <itemizedlist>
3833 <listitem><para>
3834 <filename>distutils-native-base</filename>:
3835 No longer needed.
3836 </para></listitem>
3837 <listitem><para>
3838 <filename>distutils3-native-base</filename>:
3839 No longer needed.
3840 </para></listitem>
3841 <listitem><para>
3842 <filename>sdl</filename>:
3843 Only set
3844 <link linkend='var-DEPENDS'><filename>DEPENDS</filename></link>
3845 and
3846 <link linkend='var-SECTION'><filename>SECTION</filename></link>,
3847 which are better set within the recipe instead.
3848 </para></listitem>
3849 <listitem><para>
3850 <filename>sip</filename>:
3851 Mostly unused.
3852 </para></listitem>
3853 <listitem><para>
3854 <filename>swabber</filename>:
3855 See the
3856 <link linkend='migration-2.2-swabber-has-been-removed'>entry on Swabber</link>.
3857 </para></listitem>
3858 </itemizedlist>
3859 </para>
3860 </section>
3861
3862 <section id='migration-2.2-minor-packaging-changes'>
3863 <title>Minor Packaging Changes</title>
3864
3865 <para>
3866 The following minor packaging changes have occurred:
3867 <itemizedlist>
3868 <listitem><para>
3869 <filename>grub</filename>:
3870 Split <filename>grub-editenv</filename> into its own
3871 package.
3872 </para></listitem>
3873 <listitem><para>
3874 <filename>systemd</filename>:
3875 Split container and vm related units into a new package,
3876 systemd-container.
3877 </para></listitem>
3878 <listitem><para>
3879 <filename>util-linux</filename>:
3880 Moved <filename>prlimit</filename> to a separate
3881 <filename>util-linux-prlimit</filename> package.
3882 </para></listitem>
3883 </itemizedlist>
3884 </para>
3885 </section>
3886
3887 <section id='migration-2.2-miscellaneous-changes'>
3888 <title>Miscellaneous Changes</title>
3889
3890 <para>
3891 The following miscellaneous changes have occurred:
3892 <itemizedlist>
3893 <listitem><para>
3894 <filename>package_regex.inc</filename>:
3895 Removed because the definitions
3896 <filename>package_regex.inc</filename> previously contained
3897 have been moved to their respective recipes.
3898 </para></listitem>
3899 <listitem><para>
3900 Both <filename>devtool add</filename> and
3901 <filename>recipetool create</filename> now use a fixed
3902 <link linkend='var-SRCREV'><filename>SRCREV</filename></link>
3903 by default when fetching from a Git repository.
3904 You can override this in either case to use
3905 <filename>${</filename><link linkend='var-AUTOREV'><filename>AUTOREV</filename></link><filename>}</filename>
3906 instead by using the <filename>-a</filename> or
3907 <filename>&dash;&dash;autorev</filename> command-line
3908 option
3909 </para></listitem>
3910 <listitem><para>
3911 <filename>distcc</filename>:
3912 GTK+ UI is now disabled by default.
3913 </para></listitem>
3914 <listitem><para>
3915 <filename>packagegroup-core-tools-testapps</filename>:
3916 Removed Piglit.
3917 </para></listitem>
3918 <listitem><para>
3919 <filename>image.bbclass</filename>:
3920 Renamed COMPRESS(ION) to CONVERSION.
3921 This change means that
3922 <filename>COMPRESSIONTYPES</filename>,
3923 <filename>COMPRESS_DEPENDS</filename> and
3924 <filename>COMPRESS_CMD</filename> are deprecated in favor
3925 of <filename>CONVERSIONTYPES</filename>,
3926 <filename>CONVERSION_DEPENDS</filename> and
3927 <filename>CONVERSION_CMD</filename>.
3928 The <filename>COMPRESS*</filename> variable names will
3929 still work in the 2.2 release but metadata that does not
3930 need to be backwards-compatible should be changed to
3931 use the new names as the <filename>COMPRESS*</filename>
3932 ones will be removed in a future release.
3933 </para></listitem>
3934 <listitem><para>
3935 <filename>gtk-doc</filename>:
3936 A full version of <filename>gtk-doc</filename> is now
3937 made available.
3938 However, some old software might not be capable of using
3939 the current version of <filename>gtk-doc</filename>
3940 to build documentation.
3941 You need to change recipes that build such software so that
3942 they explicitly disable building documentation with
3943 <filename>gtk-doc</filename>.
Patrick Williamsd8c66bc2016-06-20 12:57:21 -05003944 </para></listitem>
3945 </itemizedlist>
3946 </para>
3947 </section>
3948</section>
Patrick Williamsf1e5d692016-03-30 15:21:19 -05003949
Brad Bishop6e60e8b2018-02-01 10:27:11 -05003950<section id='moving-to-the-yocto-project-2.3-release'>
3951 <title>Moving to the Yocto Project 2.3 Release</title>
3952
3953 <para>
3954 This section provides migration information for moving to the
3955 Yocto Project 2.3 Release from the prior release.
3956 </para>
3957
3958 <section id='migration-2.3-recipe-specific-sysroots'>
3959 <title>Recipe-specific Sysroots</title>
3960
3961 <para>
3962 The OpenEmbedded build system now uses one sysroot per
3963 recipe to resolve long-standing issues with configuration
3964 script auto-detection of undeclared dependencies.
3965 Consequently, you might find that some of your previously
3966 written custom recipes are missing declared dependencies,
3967 particularly those dependencies that are incidentally built
3968 earlier in a typical build process and thus are already likely
3969 to be present in the shared sysroot in previous releases.
3970 </para>
3971
3972 <para>
3973 Consider the following:
3974 <itemizedlist>
3975 <listitem><para>
3976 <emphasis>Declare Build-Time Dependencies:</emphasis>
3977 Because of this new feature, you must explicitly
3978 declare all build-time dependencies for your recipe.
3979 If you do not declare these dependencies, they are not
3980 populated into the sysroot for the recipe.
3981 </para></listitem>
3982 <listitem><para>
3983 <emphasis>Specify Pre-Installation and Post-Installation
3984 Native Tool Dependencies:</emphasis>
3985 You must specifically specify any special native tool
3986 dependencies of <filename>pkg_preinst</filename> and
3987 <filename>pkg_postinst</filename> scripts by using the
3988 <link linkend='var-PACKAGE_WRITE_DEPS'><filename>PACKAGE_WRITE_DEPS</filename></link>
3989 variable.
3990 Specifying these dependencies ensures that these tools
3991 are available if these scripts need to be run on the
3992 build host during the
3993 <link linkend='ref-tasks-rootfs'><filename>do_rootfs</filename></link>
3994 task.</para>
3995
3996 <para>As an example, see the <filename>dbus</filename>
3997 recipe.
3998 You will see that this recipe has a
3999 <filename>pkg_postinst</filename> that calls
4000 <filename>systemctl</filename> if "systemd" is in
4001 <link linkend='var-DISTRO_FEATURES'><filename>DISTRO_FEATURES</filename></link>.
4002 In the example,
4003 <filename>systemd-systemctl-native</filename> is added to
4004 <filename>PACKAGE_WRITE_DEPS</filename>, which is also
4005 conditional on "systemd" being in
4006 <filename>DISTRO_FEATURES</filename>.
4007 </para></listitem>
4008 <listitem><para>
4009 <emphasis>Examine Recipes that Use
4010 <filename>SSTATEPOSTINSTFUNCS</filename>:</emphasis>
4011 You need to examine any recipe that uses
4012 <filename>SSTATEPOSTINSTFUNCS</filename> and determine
4013 steps to take.</para>
4014
4015 <para>Functions added to
4016 <filename>SSTATEPOSTINSTFUNCS</filename> are still
4017 called as they were in previous Yocto Project releases.
4018 However, since a separate sysroot is now being populated
4019 for every recipe and if existing functions being called
4020 through <filename>SSTATEPOSTINSTFUNCS</filename> are
4021 doing relocation, then you will need to change these
4022 to use a post-installation script that is installed by a
4023 function added to
4024 <link linkend='var-SYSROOT_PREPROCESS_FUNCS'><filename>SYSROOT_PREPROCESS_FUNCS</filename></link>.
4025 </para>
4026
4027 <para>For an example, see the
4028 <filename>pixbufcache</filename> class in
4029 <filename>meta/classes/</filename> in the Yocto Project
Brad Bishop316dfdd2018-06-25 12:45:53 -04004030 <ulink url='&YOCTO_DOCS_OM_URL;#source-repositories'>Source Repositories</ulink>.
Brad Bishop6e60e8b2018-02-01 10:27:11 -05004031 <note>
4032 The <filename>SSTATEPOSTINSTFUNCS</filename> variable
4033 itself is now deprecated in favor of the
4034 <filename>do_populate_sysroot[postfuncs]</filename>
4035 task.
4036 Consequently, if you do still have any function or
4037 functions that need to be called after the sysroot
4038 component is created for a recipe, then you would be
4039 well advised to take steps to use a post installation
4040 script as described previously.
4041 Taking these steps prepares your code for when
4042 <filename>SSTATEPOSTINSTFUNCS</filename> is
4043 removed in a future Yocto Project release.
4044 </note>
4045 </para></listitem>
4046 <listitem><para>
4047 <emphasis>Specify the Sysroot when Using Certain
4048 External Scripts:</emphasis>
4049 Because the shared sysroot is now gone, the scripts
4050 <filename>oe-find-native-sysroot</filename> and
4051 <filename>oe-run-native</filename> have been changed such
4052 that you need to specify which recipe's
4053 <link linkend='var-STAGING_DIR_NATIVE'><filename>STAGING_DIR_NATIVE</filename></link>
4054 is used.
4055 </para></listitem>
4056 </itemizedlist>
4057 <note>
4058 You can find more information on how recipe-specific sysroots
4059 work in the
4060 "<link linkend='ref-classes-staging'><filename>staging.bbclass</filename></link>"
4061 section.
4062 </note>
4063 </para>
4064 </section>
4065
4066 <section id='migration-2.3-path-variable'>
4067 <title><filename>PATH</filename> Variable</title>
4068
4069 <para>
4070 Within the environment used to run build tasks, the environment
4071 variable <filename>PATH</filename> is now sanitized such that
4072 the normal native binary paths
4073 (<filename>/bin</filename>, <filename>/sbin</filename>,
4074 <filename>/usr/bin</filename> and so forth) are
4075 removed and a directory containing symbolic links linking only
4076 to the binaries from the host mentioned in the
4077 <link linkend='var-HOSTTOOLS'><filename>HOSTTOOLS</filename></link>
4078 and
4079 <link linkend='var-HOSTTOOLS_NONFATAL'><filename>HOSTTOOLS_NONFATAL</filename></link>
4080 variables is added to <filename>PATH</filename>.
4081 </para>
4082
4083 <para>
4084 Consequently, any native binaries provided by the host that you
4085 need to call needs to be in one of these two variables at
4086 the configuration level.
4087 </para>
4088
4089 <para>
4090 Alternatively, you can add a native recipe (i.e.
4091 <filename>-native</filename>) that provides the
4092 binary to the recipe's
4093 <link linkend='var-DEPENDS'><filename>DEPENDS</filename></link>
4094 value.
4095 <note>
4096 <filename>PATH</filename> is not sanitized in the same way
4097 within <filename>devshell</filename>.
4098 If it were, you would have difficulty running host tools for
4099 development and debugging within the shell.
4100 </note>
4101 </para>
4102 </section>
4103
4104 <section id='migration-2.3-scripts'>
4105 <title>Changes to Scripts</title>
4106
4107 <para>
4108 The following changes to scripts took place:
4109 <itemizedlist>
4110 <listitem><para>
4111 <emphasis><filename>oe-find-native-sysroot</filename>:</emphasis>
4112 The usage for the
4113 <filename>oe-find-native-sysroot</filename> script has
4114 changed to the following:
4115 <literallayout class='monospaced'>
4116 $ . oe-find-native-sysroot <replaceable>recipe</replaceable>
4117 </literallayout>
4118 You must now supply a recipe for
4119 <replaceable>recipe</replaceable> as part of the command.
4120 Prior to the Yocto Project &DISTRO; release, it was not
4121 necessary to provide the script with the command.
4122 </para></listitem>
4123 <listitem><para>
4124 <emphasis><filename>oe-run-native</filename>:</emphasis>
4125 The usage for the
4126 <filename>oe-run-native</filename> script has changed
4127 to the following:
4128 <literallayout class='monospaced'>
4129 $ oe-run-native <replaceable>native_recipe</replaceable> <replaceable>tool</replaceable>
4130 </literallayout>
4131 You must supply the name of the native recipe and the tool
4132 you want to run as part of the command.
4133 Prior to the Yocto Project &DISTRO; release, it was not
4134 necessary to provide the native recipe with the command.
4135 </para></listitem>
4136 <listitem><para>
4137 <emphasis><filename>cleanup-workdir</filename>:</emphasis>
4138 The <filename>cleanup-workdir</filename> script has been
4139 removed because the script was found to be deleting
4140 files it should not have, which lead to broken build
4141 trees.
4142 Rather than trying to delete portions of
4143 <link linkend='var-TMPDIR'><filename>TMPDIR</filename></link>
4144 and getting it wrong, it is recommended that you
4145 delete <filename>TMPDIR</filename> and have it restored
4146 from shared state (sstate) on subsequent builds.
4147 </para></listitem>
4148 <listitem><para>
4149 <emphasis><filename>wipe-sysroot</filename>:</emphasis>
4150 The <filename>wipe-sysroot</filename> script has been
4151 removed as it is no longer needed with recipe-specific
4152 sysroots.
4153 </para></listitem>
4154 </itemizedlist>
4155 </para>
4156 </section>
4157
4158 <section id='migration-2.3-functions'>
4159 <title>Changes to Functions</title>
4160
4161 <para>
4162 The previously deprecated
4163 <filename>bb.data.getVar()</filename>,
4164 <filename>bb.data.setVar()</filename>, and
4165 related functions have been removed in favor of
4166 <filename>d.getVar()</filename>,
4167 <filename>d.setVar()</filename>, and so forth.
4168 </para>
4169
4170 <para>
4171 You need to fix any references to these old functions.
4172 </para>
4173 </section>
4174
4175 <section id='migration-2.3-bitbake-changes'>
4176 <title>BitBake Changes</title>
4177
4178 <para>
4179 The following changes took place for BitBake:
4180 <itemizedlist>
4181 <listitem><para>
4182 <emphasis>BitBake's Graphical Dependency Explorer UI Replaced:</emphasis>
4183 BitBake's graphical dependency explorer UI
4184 <filename>depexp</filename> was replaced by
4185 <filename>taskexp</filename> ("Task Explorer"), which
4186 provides a graphical way of exploring the
4187 <filename>task-depends.dot</filename> file.
4188 The data presented by Task Explorer is much more
4189 accurate than the data that was presented by
4190 <filename>depexp</filename>.
4191 Being able to visualize the data is an often requested
4192 feature as standard <filename>*.dot</filename> file
4193 viewers cannot usual cope with the size of
4194 the <filename>task-depends.dot</filename> file.
4195 </para></listitem>
4196 <listitem><para>
4197 <emphasis>BitBake "-g" Output Changes:</emphasis>
4198 The <filename>package-depends.dot</filename> and
4199 <filename>pn-depends.dot</filename> files as previously
4200 generated using the <filename>bitbake -g</filename> command
4201 have been removed.
4202 A <filename>recipe-depends.dot</filename> file
4203 is now generated as a collapsed version of
4204 <filename>task-depends.dot</filename> instead.
4205 </para>
4206
4207 <para>The reason for this change is because
4208 <filename>package-depends.dot</filename> and
4209 <filename>pn-depends.dot</filename> largely date back
4210 to a time before task-based execution and do not take
4211 into account task-level dependencies between recipes,
4212 which could be misleading.
4213 </para></listitem>
4214 <listitem><para>
4215 <emphasis>Mirror Variable Splitting Changes:</emphasis>
4216 Mirror variables including
4217 <link linkend='var-MIRRORS'><filename>MIRRORS</filename></link>,
4218 <link linkend='var-PREMIRRORS'><filename>PREMIRRORS</filename></link>,
4219 and
4220 <link linkend='var-SSTATE_MIRRORS'><filename>SSTATE_MIRRORS</filename></link>
4221 can now separate values entirely with spaces.
4222 Consequently, you no longer need "\\n".
4223 BitBake looks for pairs of values, which simplifies usage.
4224 There should be no change required to existing mirror
4225 variable values themselves.
4226 </para></listitem>
4227 <listitem><para>
4228 <emphasis>The Subversion (SVN) Fetcher Uses an "ssh" Parameter and Not an "rsh" Parameter:</emphasis>
4229 The SVN fetcher now takes an "ssh" parameter instead of an
4230 "rsh" parameter.
4231 This new optional parameter is used when the "protocol"
4232 parameter is set to "svn+ssh".
4233 You can only use the new parameter to specify the
4234 <filename>ssh</filename> program used by SVN.
4235 The SVN fetcher passes the new parameter through the
4236 <filename>SVN_SSH</filename> environment variable during
4237 the
4238 <link linkend='ref-tasks-fetch'><filename>do_fetch</filename></link>
4239 task.</para>
4240
4241 <para>See the
4242 "<ulink url='&YOCTO_DOCS_BB_URL;#svn-fetcher'>Subversion (SVN) Fetcher (svn://)</ulink>"
Brad Bishop316dfdd2018-06-25 12:45:53 -04004243 section in the BitBake User Manual for additional
4244 information.
Brad Bishop6e60e8b2018-02-01 10:27:11 -05004245 </para></listitem>
4246 <listitem><para>
4247 <emphasis><filename>BB_SETSCENE_VERIFY_FUNCTION</filename>
4248 and <filename>BB_SETSCENE_VERIFY_FUNCTION2</filename>
4249 Removed:</emphasis>
4250 Because the mechanism they were part of is no longer
4251 necessary with recipe-specific sysroots, the
4252 <filename>BB_SETSCENE_VERIFY_FUNCTION</filename> and
4253 <filename>BB_SETSCENE_VERIFY_FUNCTION2</filename>
4254 variables have been removed.
4255 </para></listitem>
4256 </itemizedlist>
4257 </para>
4258 </section>
4259
4260 <section id='migration-2.3-absolute-symlinks'>
4261 <title>Absolute Symbolic Links</title>
4262
4263 <para>
4264 Absolute symbolic links (symlinks) within staged files are no
4265 longer permitted and now trigger an error.
4266 Any explicit creation of symlinks can use the
4267 <filename>lnr</filename> script, which is a replacement for
4268 <filename>ln -r</filename>.
4269 </para>
4270
4271 <para>
4272 If the build scripts in the software that the recipe is building
4273 are creating a number of absolute symlinks that need to be
4274 corrected, you can inherit
4275 <filename>relative_symlinks</filename> within the recipe to turn
4276 those absolute symlinks into relative symlinks.
4277 </para>
4278 </section>
4279
4280 <section id='migration-2.3-gplv2-and-gplv3-moves'>
4281 <title>GPLv2 Versions of GPLv3 Recipes Moved</title>
4282
4283 <para>
4284 Older GPLv2 versions of GPLv3 recipes have moved to a
4285 separate <filename>meta-gplv2</filename> layer.
4286 </para>
4287
4288 <para>
4289 If you use
4290 <link linkend='var-INCOMPATIBLE_LICENSE'><filename>INCOMPATIBLE_LICENSE</filename></link>
4291 to exclude GPLv3 or set
4292 <link linkend='var-PREFERRED_VERSION'><filename>PREFERRED_VERSION</filename></link>
4293 to substitute a GPLv2 version of a GPLv3 recipe, then you must add
4294 the <filename>meta-gplv2</filename> layer to your configuration.
4295 <note>
4296 You can find <filename>meta-gplv2</filename> layer in the
4297 OpenEmbedded layer index at
4298 <ulink url='https://layers.openembedded.org/layerindex/branch/master/layer/meta-gplv2/'></ulink>.
4299 </note>
4300 </para>
4301
4302 <para>
4303 These relocated GPLv2 recipes do not receive the same level of
4304 maintenance as other core recipes.
4305 The recipes do not get security fixes and upstream no longer
4306 maintains them.
4307 In fact, the upstream community is actively hostile towards people
4308 that use the old versions of the recipes.
4309 Moving these recipes into a separate layer both makes the different
4310 needs of the recipes clearer and clearly identifies the number of
4311 these recipes.
4312 <note>
4313 The long-term solution might be to move to BSD-licensed
4314 replacements of the GPLv3 components for those that need to
4315 exclude GPLv3-licensed components from the target system.
4316 This solution will be investigated for future Yocto
4317 Project releases.
4318 </note>
4319 </para>
4320 </section>
4321
4322 <section id='migration-2.3-package-management-changes'>
4323 <title>Package Management Changes</title>
4324
4325 <para>
4326 The following package management changes took place:
4327 <itemizedlist>
4328 <listitem><para>
4329 Smart package manager is replaced by DNF package manager.
4330 Smart has become unmaintained upstream, is not ported
4331 to Python 3.x.
4332 Consequently, Smart needed to be replaced.
4333 DNF is the only feasible candidate.</para>
4334 <para>The change in functionality is that the on-target
4335 runtime package management from remote package feeds is
4336 now done with a different tool that has a
4337 different set of command-line options.
4338 If you have scripts that call the
4339 tool directly, or use its API, they need to be fixed.</para>
4340 <para>For more information, see the
4341 <ulink url='http://dnf.readthedocs.io/en/latest/'>DNF Documentation</ulink>.
4342 </para></listitem>
4343 <listitem><para>
4344 Rpm 5.x is replaced with Rpm 4.x.
4345 This is done for two major reasons:
4346 <itemizedlist>
4347 <listitem><para>
4348 DNF is API-incompatible with Rpm 5.x and porting
4349 it and maintaining the port is non-trivial.
4350 </para></listitem>
4351 <listitem><para>
4352 Rpm 5.x itself has limited maintenance upstream,
4353 and the Yocto Project is one of the very few
4354 remaining users.
4355 </para></listitem>
4356 </itemizedlist>
4357 </para></listitem>
4358 <listitem><para>
4359 Berkeley DB 6.x is removed and Berkeley DB 5.x becomes
4360 the default:
4361 <itemizedlist>
4362 <listitem><para>
4363 Version 6.x of Berkeley DB has largely been
4364 rejected by the open source community due to its
4365 AGPLv3 license.
4366 As a result, most mainstream open source projects
4367 that require DB are still developed and tested with
4368 DB 5.x.
4369 </para></listitem>
4370 <listitem><para>
4371 In OE-core, the only thing that was requiring
4372 DB 6.x was Rpm 5.x.
4373 Thus, no reason exists to continue carrying DB 6.x
4374 in OE-core.
4375 </para></listitem>
4376 </itemizedlist>
4377 </para></listitem>
4378 <listitem><para>
4379 <filename>createrepo</filename> is replaced with
4380 <filename>createrepo_c</filename>.</para>
4381 <para><filename>createrepo_c</filename> is the current
4382 incarnation of the tool that generates remote repository
4383 metadata.
4384 It is written in C as compared to
4385 <filename>createrepo</filename>, which is written in
4386 Python.
4387 <filename>createrepo_c</filename> is faster and is
4388 maintained.
4389 </para></listitem>
4390 <listitem><para>
4391 Architecture-independent RPM packages are "noarch"
4392 instead of "all".</para>
4393 <para>This change was made because too many places in
4394 DNF/RPM4 stack already make that assumption.
4395 Only the filenames and the architecture tag has changed.
4396 Nothing else has changed in OE-core system, particularly
4397 in the
4398 <link linkend='ref-classes-allarch'><filename>allarch.bbclass</filename></link>
4399 class.
4400 </para></listitem>
4401 <listitem><para>
4402 Signing of remote package feeds using
4403 <filename>PACKAGE_FEED_SIGN</filename>
4404 is not currently supported.
4405 This issue will be fully addressed in a future
4406 Yocto Project release.
4407 See <ulink url='https://bugzilla.yoctoproject.org/show_bug.cgi?id=11209'>defect 11209</ulink>
4408 for more information on a solution to package feed
4409 signing with RPM in the Yocto Project 2.3 release.
4410 </para></listitem>
4411 <listitem><para>
4412 OPKG now uses the libsolv backend for resolving package
4413 dependencies by default.
4414 This is vastly superior to OPKG's internal ad-hoc solver
4415 that was previously used.
4416 This change does have a small impact on disk (around
4417 500 KB) and memory footprint.
4418 <note>
4419 For further details on this change, see the
4420 <ulink url='http://git.yoctoproject.org/cgit/cgit.cgi/poky/commit/?
4421id=f4d4f99cfbc2396e49c1613a7d237b9e57f06f81'>commit message</ulink>.
4422 </note>
4423 </para></listitem>
4424 </itemizedlist>
4425 </para>
4426 </section>
4427
4428 <section id='migration-2.3-removed-recipes'>
4429 <title>Removed Recipes</title>
4430
4431 <para>
4432 The following recipes have been removed:
4433 <itemizedlist>
4434 <listitem><para>
4435 <emphasis><filename>linux-yocto 4.8:</filename></emphasis>
4436 Version 4.8 has been removed.
4437 Versions 4.1 (LTSI), 4.4 (LTS), 4.9 (LTS/LTSI) and 4.10
4438 are now present.
4439 </para></listitem>
4440 <listitem><para>
4441 <emphasis><filename>python-smartpm:</filename></emphasis>
4442 Functionally replaced by <filename>dnf</filename>.
4443 </para></listitem>
4444 <listitem><para>
4445 <emphasis><filename>createrepo:</filename></emphasis>
4446 Replaced by the <filename>createrepo-c</filename> recipe.
4447 </para></listitem>
4448 <listitem><para>
4449 <emphasis><filename>rpmresolve:</filename></emphasis>
4450 No longer needed with the move to RPM 4 as RPM itself is
4451 used instead.
4452 </para></listitem>
4453 <listitem><para>
4454 <emphasis><filename>gstreamer:</filename></emphasis>
4455 Removed the GStreamer Git version recipes as they have
4456 been stale.
4457 <filename>1.10.</filename><replaceable>x</replaceable>
4458 recipes are still present.
4459 </para></listitem>
4460 <listitem><para>
4461 <emphasis><filename>alsa-conf-base:</filename></emphasis>
4462 Merged into <filename>alsa-conf</filename> since
4463 <filename>libasound</filename> depended on both.
4464 Essentially, no way existed to install only one of these.
4465 </para></listitem>
4466 <listitem><para>
4467 <emphasis><filename>tremor:</filename></emphasis>
4468 Moved to <filename>meta-multimedia</filename>.
4469 Fixed-integer Vorbis decoding is not
4470 needed by current hardware.
4471 Thus, GStreamer's ivorbis plugin has been disabled
4472 by default eliminating the need for the
Brad Bishopd7bf8c12018-02-25 22:55:05 -05004473 <filename>tremor</filename> recipe in
4474 <link linkend='oe-core'>OE-Core</link>.
Brad Bishop6e60e8b2018-02-01 10:27:11 -05004475 </para></listitem>
4476 <listitem><para>
4477 <emphasis><filename>gummiboot:</filename></emphasis>
4478 Replaced by <filename>systemd-boot</filename>.
4479 </para></listitem>
4480 </itemizedlist>
4481 </para>
4482 </section>
4483
4484 <section id='migration-2.3-wic-changes'>
4485 <title>Wic Changes</title>
4486
4487 <para>
4488 The following changes have been made to Wic:
4489 <note>
4490 For more information on Wic, see the
Brad Bishopd7bf8c12018-02-25 22:55:05 -05004491 "<ulink url='&YOCTO_DOCS_DEV_URL;#creating-partitioned-images-using-wic'>Creating Partitioned Images Using Wic</ulink>"
4492 section in the Yocto Project Development Tasks Manual.
Brad Bishop6e60e8b2018-02-01 10:27:11 -05004493 </note>
4494 <itemizedlist>
4495 <listitem><para>
4496 <emphasis>Default Output Directory Changed:</emphasis>
4497 Wic's default output directory is now the current directory
4498 by default instead of the unusual
4499 <filename>/var/tmp/wic</filename>.</para>
4500
4501 <para>The "-o" and "--outdir" options remain unchanged
4502 and are used to specify your preferred output directory
4503 if you do not want to use the default directory.
4504 </para></listitem>
4505 <listitem><para>
4506 <emphasis>fsimage Plug-in Removed:</emphasis>
Brad Bishopc342db32019-05-15 21:57:59 -04004507 The Wic fsimage plugin has been removed as it duplicates
4508 functionality of the rawcopy plugin.
Brad Bishop6e60e8b2018-02-01 10:27:11 -05004509 </para></listitem>
4510 </itemizedlist>
4511 </para>
4512 </section>
4513
4514 <section id='migration-2.3-qa-changes'>
4515 <title>QA Changes</title>
4516
4517 <para>
4518 The following QA checks have changed:
4519 <itemizedlist>
4520 <listitem><para>
4521 <emphasis><filename>unsafe-references-in-binaries</filename>:</emphasis>
4522 The <filename>unsafe-references-in-binaries</filename>
4523 QA check, which was disabled by default, has now been
4524 removed.
4525 This check was intended to detect binaries in
4526 <filename>/bin</filename> that link to libraries in
4527 <filename>/usr/lib</filename> and have the case where
4528 the user has <filename>/usr</filename> on a separate
4529 filesystem to <filename>/</filename>.</para>
4530
4531 <para>The removed QA check was buggy.
4532 Additionally, <filename>/usr</filename> residing on a
4533 separate partition from <filename>/</filename> is now
4534 a rare configuration.
4535 Consequently,
4536 <filename>unsafe-references-in-binaries</filename> was
4537 removed.
4538 </para></listitem>
4539 <listitem><para>
4540 <emphasis><filename>file-rdeps</filename>:</emphasis>
4541 The <filename>file-rdeps</filename> QA check is now an
4542 error by default instead of a warning.
4543 Because it is an error instead of a warning, you need to
4544 address missing runtime dependencies.</para>
4545
4546 <para>For additional information, see the
4547 <link linkend='ref-classes-insane'><filename>insane</filename></link>
4548 class and the
4549 "<link linkend='qa-errors-and-warnings'>Errors and Warnings</link>"
4550 section.
4551 </para></listitem>
4552 </itemizedlist>
4553 </para>
4554 </section>
4555
4556 <section id='migration-2.3-miscellaneous-changes'>
4557 <title>Miscellaneous Changes</title>
4558
4559 <para>
4560 The following miscellaneous changes have occurred:
4561 <itemizedlist>
4562 <listitem><para>
4563 In this release, a number of recipes have been changed to
4564 ignore the <filename>largefile</filename>
4565 <link linkend='var-DISTRO_FEATURES'><filename>DISTRO_FEATURES</filename></link>
4566 item, enabling large file support unconditionally.
4567 This feature has always been enabled by default.
4568 Disabling the feature has not been widely tested.
4569 <note>
4570 Future releases of the Yocto Project will remove
4571 entirely the ability to disable the
4572 <filename>largefile</filename> feature,
4573 which would make it unconditionally enabled everywhere.
4574 </note>
4575 </para></listitem>
4576 <listitem><para>
4577 If the
4578 <link linkend='var-DISTRO_VERSION'><filename>DISTRO_VERSION</filename></link>
4579 value contains the value of the
4580 <link linkend='var-DATE'><filename>DATE</filename></link>
4581 variable, which is the default between Poky releases,
4582 the <filename>DATE</filename> value is explicitly excluded
4583 from <filename>/etc/issue</filename> and
4584 <filename>/etc/issue.net</filename>, which is displayed at
4585 the login prompt, in order to avoid conflicts with
4586 Multilib enabled.
4587 Regardless, the <filename>DATE</filename> value is
4588 inaccurate if the <filename>base-files</filename>
4589 recipe is restored from shared state (sstate) rather
4590 than rebuilt.</para>
4591
4592 <para>If you need the build date recorded in
4593 <filename>/etc/issue*</filename> or anywhere else in your
4594 image, a better method is to define a post-processing
4595 function to do it and have the function called from
4596 <link linkend='var-ROOTFS_POSTPROCESS_COMMAND'><filename>ROOTFS_POSTPROCESS_COMMAND</filename></link>.
4597 Doing so ensures the value is always up-to-date with the
4598 created image.
4599 </para></listitem>
4600 <listitem><para>
4601 Dropbear's <filename>init</filename> script now disables
4602 DSA host keys by default.
4603 This change is in line with the systemd service
4604 file, which supports RSA keys only, and with recent
4605 versions of OpenSSH, which deprecates DSA host keys.
4606 </para></listitem>
4607 <listitem><para>
4608 The
4609 <link linkend='ref-classes-buildhistory'><filename>buildhistory</filename></link>
4610 class now correctly uses tabs as separators between all
4611 columns in <filename>installed-package-sizes.txt</filename>
4612 in order to aid import into other tools.
4613 </para></listitem>
4614 <listitem><para>
4615 The <filename>USE_LDCONFIG</filename> variable has been
4616 replaced with the "ldconfig"
Brad Bishop316dfdd2018-06-25 12:45:53 -04004617 <filename>DISTRO_FEATURES</filename> feature.
Brad Bishop6e60e8b2018-02-01 10:27:11 -05004618 Distributions that previously set:
4619 <literallayout class='monospaced'>
4620 USE_LDCONFIG = "0"
4621 </literallayout>
4622 should now instead use the following:
4623 <literallayout class='monospaced'>
4624 DISTRO_FEATURES_BACKFILL_CONSIDERED_append = " ldconfig"
4625 </literallayout>
4626 </para></listitem>
4627 <listitem><para>
4628 The default value of
4629 <link linkend='var-COPYLEFT_LICENSE_INCLUDE'><filename>COPYLEFT_LICENSE_INCLUDE</filename></link>
4630 now includes all versions of AGPL licenses in addition
4631 to GPL and LGPL.
4632 <note>
4633 The default list is not intended to be guaranteed
4634 as a complete safe list.
4635 You should seek legal advice based on what you are
4636 distributing if you are unsure.
4637 </note>
4638 </para></listitem>
4639 <listitem><para>
4640 Kernel module packages are now suffixed with the kernel
4641 version in order to allow module packages from multiple
4642 kernel versions to co-exist on a target system.
4643 If you wish to return to the previous naming scheme
4644 that does not include the version suffix, use the
4645 following:
4646 <literallayout class='monospaced'>
4647 KERNEL_MODULE_PACKAGE_SUFFIX to ""
4648 </literallayout>
4649 </para></listitem>
4650 <listitem><para>
4651 Removal of <filename>libtool</filename>
4652 <filename>*.la</filename> files is now enabled by default.
4653 The <filename>*.la</filename> files are not actually
4654 needed on Linux and relocating them is an unnecessary
4655 burden.</para>
4656
4657 <para>If you need to preserve these
4658 <filename>.la</filename> files (e.g. in a custom
4659 distribution), you must change
4660 <link linkend='var-INHERIT_DISTRO'><filename>INHERIT_DISTRO</filename></link>
4661 such that "remove-libtool" is not included in the value.
4662 </para></listitem>
4663 <listitem><para>
4664 Extensible SDKs built for GCC 5+ now refuse to install on a
4665 distribution where the host GCC version is 4.8 or 4.9.
4666 This change resulted from the fact that the installation
4667 is known to fail due to the way the
4668 <filename>uninative</filename> shared state (sstate)
4669 package is built.
4670 See the
4671 <link linkend='ref-classes-uninative'><filename>uninative</filename></link>
4672 class for additional information.
4673 </para></listitem>
4674 <listitem><para>
4675 All native and nativesdk recipes now use a separate
Brad Bishop316dfdd2018-06-25 12:45:53 -04004676 <filename>DISTRO_FEATURES</filename> value instead of
4677 sharing the value used by recipes for the target, in order
4678 to avoid unnecessary rebuilds.</para>
Brad Bishop6e60e8b2018-02-01 10:27:11 -05004679
4680 <para>The <filename>DISTRO_FEATURES</filename> for
4681 <filename>native</filename> recipes is
4682 <link linkend='var-DISTRO_FEATURES_NATIVE'><filename>DISTRO_FEATURES_NATIVE</filename></link>
4683 added to an intersection of
4684 <filename>DISTRO_FEATURES</filename> and
4685 <link linkend='var-DISTRO_FEATURES_FILTER_NATIVE'><filename>DISTRO_FEATURES_FILTER_NATIVE</filename></link>.
4686 </para>
4687
4688 <para>For nativesdk recipes, the
4689 corresponding variables are
4690 <link linkend='var-DISTRO_FEATURES_NATIVESDK'><filename>DISTRO_FEATURES_NATIVESDK</filename></link>
4691 and
4692 <link linkend='var-DISTRO_FEATURES_FILTER_NATIVESDK'><filename>DISTRO_FEATURES_FILTER_NATIVESDK</filename></link>.
4693 </para></listitem>
4694 <listitem><para>
4695 The <filename>FILESDIR</filename>
4696 variable, which was previously deprecated and rarely used,
4697 has now been removed.
4698 You should change any recipes that set
4699 <filename>FILESDIR</filename> to set
4700 <link linkend='var-FILESPATH'><filename>FILESPATH</filename></link>
4701 instead.
4702 </para></listitem>
4703 <listitem><para>
4704 The <filename>MULTIMACH_HOST_SYS</filename>
4705 variable has been removed as it is no longer needed
4706 with recipe-specific sysroots.
4707 </para></listitem>
4708 </itemizedlist>
4709 </para>
4710 </section>
4711</section>
Brad Bishopd7bf8c12018-02-25 22:55:05 -05004712
4713<section id='moving-to-the-yocto-project-2.4-release'>
4714 <title>Moving to the Yocto Project 2.4 Release</title>
4715
4716 <para>
4717 This section provides migration information for moving to the
4718 Yocto Project 2.4 Release from the prior release.
4719 </para>
4720
4721 <section id='migration-2.4-memory-resident-mode'>
4722 <title>Memory Resident Mode</title>
4723
4724 <para>
4725 A persistent mode is now available in BitBake's default operation,
4726 replacing its previous "memory resident mode" (i.e.
4727 <filename>oe-init-build-env-memres</filename>).
4728 Now you only need to set
Brad Bishop316dfdd2018-06-25 12:45:53 -04004729 <link linkend='var-BB_SERVER_TIMEOUT'><filename>BB_SERVER_TIMEOUT</filename></link>
4730 to a timeout (in seconds) and BitBake's server stays resident for
4731 that amount of time between invocations.
Brad Bishopd7bf8c12018-02-25 22:55:05 -05004732 The <filename>oe-init-build-env-memres</filename> script has been
4733 removed since a separate environment setup script is no longer
4734 needed.
4735 </para>
4736 </section>
4737
4738 <section id='migration-2.4-packaging-changes'>
4739 <title>Packaging Changes</title>
4740
4741 <para>
4742 This section provides information about packaging changes that have
4743 ocurred:
4744 <itemizedlist>
4745 <listitem><para>
4746 <emphasis><filename>python3</filename> Changes:</emphasis>
4747 <itemizedlist>
4748 <listitem><para>
4749 The main "python3" package now brings in all of the
4750 standard Python 3 distribution rather than a subset.
4751 This behavior matches what is expected based on
4752 traditional Linux distributions.
4753 If you wish to install a subset of Python 3, specify
4754 <filename>python-core</filename> plus one or more of
4755 the individual packages that are still produced.
4756 </para></listitem>
4757 <listitem><para>
4758 <emphasis><filename>python3</filename>:</emphasis>
4759 The <filename>bz2.py</filename>,
4760 <filename>lzma.py</filename>, and
4761 <filename>_compression.py</filename> scripts have
4762 been moved from the
4763 <filename>python3-misc</filename> package to
4764 the <filename>python3-compression</filename> package.
4765 </para></listitem>
4766 </itemizedlist>
4767 </para></listitem>
4768 <listitem><para>
4769 <emphasis><filename>binutils</filename>:</emphasis>
4770 The <filename>libbfd</filename> library is now packaged in
4771 a separate "libbfd" package.
4772 This packaging saves space when certain tools
4773 (e.g. <filename>perf</filename>) are installed.
4774 In such cases, the tools only need
4775 <filename>libbfd</filename> rather than all the packages in
4776 <filename>binutils</filename>.
4777 </para></listitem>
4778 <listitem><para>
4779 <emphasis><filename>util-linux</filename> Changes:</emphasis>
4780 <itemizedlist>
4781 <listitem><para>
4782 The <filename>su</filename> program is now packaged
4783 in a separate "util-linux-su" package, which is only
4784 built when "pam" is listed in the
4785 <link linkend='var-DISTRO_FEATURES'><filename>DISTRO_FEATURES</filename></link>
4786 variable.
4787 <filename>util-linux</filename> should not be
4788 installed unless it is needed because
4789 <filename>su</filename> is normally provided through
4790 the shadow file format.
4791 The main <filename>util-linux</filename> package has
4792 runtime dependencies (i.e.
4793 <link linkend='var-RDEPENDS'><filename>RDEPENDS</filename></link>)
4794 on the <filename>util-linux-su</filename> package
4795 when "pam" is in
Brad Bishop316dfdd2018-06-25 12:45:53 -04004796 <filename>DISTRO_FEATURES</filename>.
Brad Bishopd7bf8c12018-02-25 22:55:05 -05004797 </para></listitem>
4798 <listitem><para>
4799 The <filename>switch_root</filename> program is now
4800 packaged in a separate "util-linux-switch-root"
4801 package for small initramfs images that do not need
4802 the whole <filename>util-linux</filename> package or
4803 the busybox binary, which are both much larger than
4804 <filename>switch_root</filename>.
4805 The main <filename>util-linux</filename> package has
4806 a recommended runtime dependency (i.e.
4807 <link linkend='var-RRECOMMENDS'><filename>RRECOMMENDS</filename></link>)
4808 on the <filename>util-linux-switch-root</filename> package.
4809 </para></listitem>
4810 <listitem><para>
4811 The <filename>ionice</filename> program is now
4812 packaged in a separate "util-linux-ionice" package.
4813 The main <filename>util-linux</filename> package has
4814 a recommended runtime dependency (i.e.
Brad Bishop316dfdd2018-06-25 12:45:53 -04004815 <filename>RRECOMMENDS</filename>)
Brad Bishopd7bf8c12018-02-25 22:55:05 -05004816 on the <filename>util-linux-ionice</filename> package.
4817 </para></listitem>
4818 </itemizedlist>
4819 </para></listitem>
4820 <listitem><para>
4821 <emphasis><filename>initscripts</filename>:</emphasis>
4822 The <filename>sushell</filename> program is now packaged in
4823 a separate "initscripts-sushell" package.
4824 This packaging change allows systems to pull
4825 <filename>sushell</filename> in when
4826 <filename>selinux</filename> is enabled.
4827 The change also eliminates needing to pull in the entire
4828 <filename>initscripts</filename> package.
4829 The main <filename>initscripts</filename> package has a
Brad Bishop316dfdd2018-06-25 12:45:53 -04004830 runtime dependency (i.e. <filename>RDEPENDS</filename>)
Brad Bishopd7bf8c12018-02-25 22:55:05 -05004831 on the <filename>sushell</filename> package when
Brad Bishop316dfdd2018-06-25 12:45:53 -04004832 "selinux" is in <filename>DISTRO_FEATURES</filename>.
Brad Bishopd7bf8c12018-02-25 22:55:05 -05004833 </para></listitem>
4834 <listitem><para>
4835 <emphasis><filename>glib-2.0</filename>:</emphasis>
4836 The <filename>glib-2.0</filename> package now has a
4837 recommended runtime dependency (i.e.
Brad Bishop316dfdd2018-06-25 12:45:53 -04004838 <filename>RRECOMMENDS</filename>) on the
Brad Bishopd7bf8c12018-02-25 22:55:05 -05004839 <filename>shared-mime-info</filename> package, since large
4840 portions of GIO are not useful without the MIME database.
4841 You can remove the dependency by using the
4842 <link linkend='var-BAD_RECOMMENDATIONS'><filename>BAD_RECOMMENDATIONS</filename></link>
4843 variable if <filename>shared-mime-info</filename> is too
4844 large and is not required.
4845 </para></listitem>
4846 <listitem><para>
4847 <emphasis>Go Standard Runtime:</emphasis>
4848 The Go standard runtime has been split out from the main
4849 <filename>go</filename> recipe into a separate
4850 <filename>go-runtime</filename> recipe.
4851 </para></listitem>
4852 </itemizedlist>
4853 </para>
4854 </section>
4855
4856 <section id='migration-2.4-removed-recipes'>
4857 <title>Removed Recipes</title>
4858
4859 <para>
4860 The following recipes have been removed:
4861 <itemizedlist>
4862 <listitem><para>
4863 <emphasis><filename>acpitests</filename>:</emphasis>
4864 This recipe is not maintained.
4865 </para></listitem>
4866 <listitem><para>
4867 <emphasis><filename>autogen-native</filename>:</emphasis>
4868 No longer required by Grub, oe-core, or meta-oe.
4869 </para></listitem>
4870 <listitem><para>
4871 <emphasis><filename>bdwgc</filename>:</emphasis>
4872 Nothing in OpenEmbedded-Core requires this recipe.
4873 It has moved to meta-oe.
4874 </para></listitem>
4875 <listitem><para>
4876 <emphasis><filename>byacc</filename>:</emphasis>
4877 This recipe was only needed by rpm 5.x and has moved to
4878 meta-oe.
4879 </para></listitem>
4880 <listitem><para>
4881 <emphasis><filename>gcc (5.4)</filename>:</emphasis>
4882 The 5.4 series dropped the recipe in favor of 6.3 / 7.2.
4883 </para></listitem>
4884 <listitem><para>
4885 <emphasis><filename>gnome-common</filename>:</emphasis>
4886 Deprecated upstream and no longer needed.
4887 </para></listitem>
4888 <listitem><para>
4889 <emphasis><filename>go-bootstrap-native</filename>:</emphasis>
4890 Go 1.9 does its own bootstrapping so this recipe has been
4891 removed.
4892 </para></listitem>
4893 <listitem><para>
4894 <emphasis><filename>guile</filename>:</emphasis>
4895 This recipe was only needed by
4896 <filename>autogen-native</filename> and
4897 <filename>remake</filename>.
4898 The recipe is no longer needed by either of these programs.
4899 </para></listitem>
4900 <listitem><para>
4901 <emphasis><filename>libclass-isa-perl</filename>:</emphasis>
4902 This recipe was previously needed for LSB 4, no longer
4903 needed.
4904 </para></listitem>
4905 <listitem><para>
4906 <emphasis><filename>libdumpvalue-perl</filename>:</emphasis>
4907 This recipe was previously needed for LSB 4, no longer
4908 needed.
4909 </para></listitem>
4910 <listitem><para>
4911 <emphasis><filename>libenv-perl</filename>:</emphasis>
4912 This recipe was previously needed for LSB 4, no longer
4913 needed.
4914 </para></listitem>
4915 <listitem><para>
4916 <emphasis><filename>libfile-checktree-perl</filename>:</emphasis>
4917 This recipe was previously needed for LSB 4, no longer
4918 needed.
4919 </para></listitem>
4920 <listitem><para>
4921 <emphasis><filename>libi18n-collate-perl</filename>:</emphasis>
4922 This recipe was previously needed for LSB 4, no longer
4923 needed.
4924 </para></listitem>
4925 <listitem><para>
4926 <emphasis><filename>libiconv</filename>:</emphasis>
4927 This recipe was only needed for <filename>uclibc</filename>,
4928 which was removed in the previous release.
4929 <filename>glibc</filename> and <filename>musl</filename>
4930 have their own implementations.
4931 <filename>meta-mingw</filename> still needs
4932 <filename>libiconv</filename>, so it has
4933 been moved to <filename>meta-mingw</filename>.
4934 </para></listitem>
4935 <listitem><para>
4936 <emphasis><filename>libpng12</filename>:</emphasis>
4937 This recipe was previously needed for LSB. The current
4938 <filename>libpng</filename> is 1.6.x.
4939 </para></listitem>
4940 <listitem><para>
4941 <emphasis><filename>libpod-plainer-perl</filename>:</emphasis>
4942 This recipe was previously needed for LSB 4, no longer
4943 needed.
4944 </para></listitem>
4945 <listitem><para>
4946 <emphasis><filename>linux-yocto (4.1)</filename>:</emphasis>
4947 This recipe was removed in favor of 4.4, 4.9, 4.10 and 4.12.
4948 </para></listitem>
4949 <listitem><para>
4950 <emphasis><filename>mailx</filename>:</emphasis>
4951 This recipe was previously only needed for LSB
4952 compatibility, and upstream is defunct.
4953 </para></listitem>
4954 <listitem><para>
4955 <emphasis><filename>mesa (git version only)</filename>:</emphasis>
4956 The git version recipe was stale with respect to the release
4957 version.
4958 </para></listitem>
4959 <listitem><para>
4960 <emphasis><filename>ofono (git version only)</filename>:</emphasis>
4961 The git version recipe was stale with respect to the release
4962 version.
4963 </para></listitem>
4964 <listitem><para>
4965 <emphasis><filename>portmap</filename>:</emphasis>
4966 This recipe is obsolete and is superseded by
4967 <filename>rpcbind</filename>.
4968 </para></listitem>
4969 <listitem><para>
4970 <emphasis><filename>python3-pygpgme</filename>:</emphasis>
4971 This recipe is old and unmaintained. It was previously
4972 required by <filename>dnf</filename>, which has switched
4973 to official <filename>gpgme</filename> Python bindings.
4974 </para></listitem>
4975 <listitem><para>
4976 <emphasis><filename>python-async</filename>:</emphasis>
4977 This recipe has been removed in favor of the Python 3
4978 version.
4979 </para></listitem>
4980 <listitem><para>
4981 <emphasis><filename>python-gitdb</filename>:</emphasis>
4982 This recipe has been removed in favor of the Python 3
4983 version.
4984 </para></listitem>
4985 <listitem><para>
4986 <emphasis><filename>python-git</filename>:</emphasis>
4987 This recipe was removed in favor of the Python 3
4988 version.
4989 </para></listitem>
4990 <listitem><para>
4991 <emphasis><filename>python-mako</filename>:</emphasis>
4992 This recipe was removed in favor of the Python 3
4993 version.
4994 </para></listitem>
4995 <listitem><para>
4996 <emphasis><filename>python-pexpect</filename>:</emphasis>
4997 This recipe was removed in favor of the Python 3 version.
4998 </para></listitem>
4999 <listitem><para>
5000 <emphasis><filename>python-ptyprocess</filename>:</emphasis>
5001 This recipe was removed in favor of Python the 3 version.
5002 </para></listitem>
5003 <listitem><para>
5004 <emphasis><filename>python-pycurl</filename>:</emphasis>
5005 Nothing is using this recipe in OpenEmbedded-Core
5006 (i.e. <filename>meta-oe</filename>).
5007 </para></listitem>
5008 <listitem><para>
5009 <emphasis><filename>python-six</filename>:</emphasis>
5010 This recipe was removed in favor of the Python 3 version.
5011 </para></listitem>
5012 <listitem><para>
5013 <emphasis><filename>python-smmap</filename>:</emphasis>
5014 This recipe was removed in favor of the Python 3 version.
5015 </para></listitem>
5016 <listitem><para>
5017 <emphasis><filename>remake</filename>:</emphasis>
5018 Using <filename>remake</filename> as the provider of
5019 <filename>virtual/make</filename> is broken.
5020 Consequently, this recipe is not needed in OpenEmbedded-Core.
5021 </para></listitem>
5022 </itemizedlist>
5023 </para>
5024 </section>
5025
5026 <section id='migration-2.4-kernel-device-tree-move'>
5027 <title>Kernel Device Tree Move</title>
5028
5029 <para>
5030 Kernel Device Tree support is now easier to enable in a kernel
5031 recipe.
5032 The Device Tree code has moved to a
Brad Bishop316dfdd2018-06-25 12:45:53 -04005033 <link linkend='ref-classes-kernel-devicetree'><filename>kernel-devicetree</filename></link>
5034 class.
Brad Bishopd7bf8c12018-02-25 22:55:05 -05005035 Functionality is automatically enabled for any recipe that inherits
5036 the
5037 <link linkend='ref-classes-kernel'><filename>kernel</filename></link>
5038 class and sets the
5039 <link linkend='var-KERNEL_DEVICETREE'><filename>KERNEL_DEVICETREE</filename></link>
5040 variable.
5041 The previous mechanism for doing this,
5042 <filename>meta/recipes-kernel/linux/linux-dtb.inc</filename>,
5043 is still available to avoid breakage, but triggers a
5044 deprecation warning.
5045 Future releases of the Yocto Project will remove
5046 <filename>meta/recipes-kernel/linux/linux-dtb.inc</filename>.
5047 It is advisable to remove any <filename>require</filename>
5048 statements that request
5049 <filename>meta/recipes-kernel/linux/linux-dtb.inc</filename>
5050 from any custom kernel recipes you might have.
5051 This will avoid breakage in post 2.4 releases.
5052 </para>
5053 </section>
5054
5055 <section id='migration-2.4-package-qa-changes'>
5056 <title>Package QA Changes</title>
5057
5058 <para>
5059 The following package QA changes took place:
5060 <itemizedlist>
5061 <listitem><para>
5062 The "unsafe-references-in-scripts" QA check has been
5063 removed.
5064 </para></listitem>
5065 <listitem><para>
5066 If you refer to <filename>${COREBASE}/LICENSE</filename>
5067 within
5068 <link linkend='var-LIC_FILES_CHKSUM'><filename>LIC_FILES_CHKSUM</filename></link>
5069 you receive a warning because this file is a description of
5070 the license for OE-Core.
5071 Use <filename>${COMMON_LICENSE_DIR}/MIT</filename>
5072 if your recipe is MIT-licensed and you cannot use the
5073 preferred method of referring to a file within the source
5074 tree.
5075 </para></listitem>
5076 </itemizedlist>
5077 </para>
5078 </section>
5079
5080 <section id='migration-2.4-readme-changes'>
5081 <title><filename>README</filename> File Changes</title>
5082
5083 <para>
5084 The following are changes to <filename>README</filename> files:
5085 <itemizedlist>
5086 <listitem><para>
5087 The main Poky <filename>README</filename> file has been
5088 moved to the <filename>meta-poky</filename> layer and
5089 has been renamed <filename>README.poky</filename>.
5090 A symlink has been created so that references to the old
5091 location work.
5092 </para></listitem>
5093 <listitem><para>
5094 The <filename>README.hardware</filename> file has been moved
5095 to <filename>meta-yocto-bsp</filename>.
5096 A symlink has been created so that references to the old
5097 location work.
5098 </para></listitem>
5099 <listitem><para>
5100 A <filename>README.qemu</filename> file has been created
5101 with coverage of the <filename>qemu*</filename> machines.
5102 </para></listitem>
5103 </itemizedlist>
5104 </para>
5105 </section>
5106
5107 <section id='migration-2.4-miscellaneous-changes'>
5108 <title>Miscellaneous Changes</title>
5109
5110 <para>
5111 The following are additional changes:
5112 <itemizedlist>
5113 <listitem><para>
5114 The <filename>ROOTFS_PKGMANAGE_BOOTSTRAP</filename>
5115 variable and any references to it have been removed.
5116 You should remove this variable from any custom recipes.
5117 </para></listitem>
5118 <listitem><para>
5119 The <filename>meta-yocto</filename> directory has been
5120 removed.
5121 <note>
5122 In the Yocto Project 2.1 release
5123 <filename>meta-yocto</filename> was renamed to
5124 <filename>meta-poky</filename> and the
5125 <filename>meta-yocto</filename> subdirectory remained
5126 to avoid breaking existing configurations.
5127 </note>
5128 </para></listitem>
5129 <listitem><para>
5130 The <filename>maintainers.inc</filename> file, which tracks
5131 maintainers by listing a primary person responsible for each
5132 recipe in OE-Core, has been moved from
5133 <filename>meta-poky</filename> to OE-Core (i.e. from
5134 <filename>meta-poky/conf/distro/include</filename> to
5135 <filename>meta/conf/distro/include</filename>).
5136 </para></listitem>
5137 <listitem><para>
5138 The
5139 <link linkend='ref-classes-buildhistory'><filename>buildhistory</filename></link>
5140 class now makes a single commit per build rather than one
5141 commit per subdirectory in the repository.
5142 This behavior assumes the commits are enabled with
5143 <link linkend='var-BUILDHISTORY_COMMIT'><filename>BUILDHISTORY_COMMIT</filename></link>
5144 = "1", which is typical.
5145 Previously, the <filename>buildhistory</filename> class made
5146 one commit per subdirectory in the repository in order to
5147 make it easier to see the changes for a particular
5148 subdirectory.
5149 To view a particular change, specify that subdirectory as
5150 the last parameter on the <filename>git show</filename>
5151 or <filename>git diff</filename> commands.
5152 </para></listitem>
5153 <listitem><para>
5154 The <filename>x86-base.inc</filename> file, which is
5155 included by all x86-based machine configurations, now sets
5156 <link linkend='var-IMAGE_FSTYPES'><filename>IMAGE_FSTYPES</filename></link>
5157 using <filename>?=</filename> to "live" rather than
5158 appending with <filename>+=</filename>.
5159 This change makes the default easier to override.
5160 </para></listitem>
5161 <listitem><para>
5162 BitBake fires multiple "BuildStarted" events when
5163 multiconfig is enabled (one per configuration).
5164 For more information, see the
5165 "<ulink url='&YOCTO_DOCS_BB_URL;#events'>Events</ulink>"
Brad Bishop316dfdd2018-06-25 12:45:53 -04005166 section in the BitBake User Manual.
Brad Bishopd7bf8c12018-02-25 22:55:05 -05005167 </para></listitem>
5168 <listitem><para>
5169 By default, the <filename>security_flags.inc</filename> file
Brad Bishop316dfdd2018-06-25 12:45:53 -04005170 sets a
5171 <link linkend='var-GCCPIE'><filename>GCCPIE</filename></link>
5172 variable with an option to enable Position Independent
5173 Executables (PIE) within <filename>gcc</filename>.
Brad Bishopd7bf8c12018-02-25 22:55:05 -05005174 Enabling PIE in the GNU C Compiler (GCC), makes Return
5175 Oriented Programming (ROP) attacks much more difficult to
5176 execute.
5177 </para></listitem>
5178 <listitem><para>
5179 OE-Core now provides a
5180 <filename>bitbake-layers</filename> plugin that implements
5181 a "create-layer" subcommand.
5182 The implementation of this subcommand has resulted in the
5183 <filename>yocto-layer</filename> script being deprecated and
5184 will likely be removed in the next Yocto Project release.
5185 </para></listitem>
5186 <listitem><para>
5187 The <filename>vmdk</filename>, <filename>vdi</filename>,
5188 and <filename>qcow2</filename> image file types are now
5189 used in conjunction with the "wic" image type through
5190 <filename>CONVERSION_CMD</filename>.
5191 Consequently, the equivalent image types are now
5192 <filename>wic.vmdk</filename>, <filename>wic.vdi</filename>,
5193 and <filename>wic.qcow2</filename>, respectively.
5194 </para></listitem>
5195 <listitem><para>
5196 <filename>do_image_&lt;type&gt;[depends]</filename> has
5197 replaced <filename>IMAGE_DEPENDS_&lt;type&gt;</filename>.
5198 If you have your own classes that implement custom image
5199 types, then you need to update them.
5200 </para></listitem>
5201 <listitem><para>
5202 OpenSSL 1.1 has been introduced.
5203 However, the default is still 1.0.x through the
5204 <link linkend='var-PREFERRED_VERSION'><filename>PREFERRED_VERSION</filename></link>
5205 variable.
5206 This preference is set is due to the remaining compatibility
5207 issues with other software.
5208 The
5209 <link linkend='var-PROVIDES'><filename>PROVIDES</filename></link>
5210 variable in the openssl 1.0 recipe now includes "openssl10"
5211 as a marker that can be used in
5212 <link linkend='var-DEPENDS'><filename>DEPENDS</filename></link>
5213 within recipes that build software that still depend on
5214 OpenSSL 1.0.
5215 </para></listitem>
5216 <listitem><para>
5217 To ensure consistent behavior, BitBake's "-r" and "-R"
5218 options (i.e. prefile and postfile), which are used to
5219 read or post-read additional configuration files from the
5220 command line, now only affect the current BitBake command.
5221 Before these BitBake changes, these options would "stick"
5222 for future executions.
5223 </para></listitem>
5224 </itemizedlist>
5225 </para>
5226 </section>
5227</section>
Brad Bishop316dfdd2018-06-25 12:45:53 -04005228
5229<section id='moving-to-the-yocto-project-2.5-release'>
5230 <title>Moving to the Yocto Project 2.5 Release</title>
5231
5232 <para>
5233 This section provides migration information for moving to the
5234 Yocto Project 2.5 Release from the prior release.
5235 </para>
5236
5237 <section id='migration-2.5-packaging-changes'>
5238 <title>Packaging Changes</title>
5239
5240 <para>
5241 This section provides information about packaging changes that have
5242 occurred:
5243 <itemizedlist>
5244 <listitem><para>
5245 <emphasis><filename>bind-libs</filename>:</emphasis>
5246 The libraries packaged by the bind recipe are in a
5247 separate <filename>bind-libs</filename> package.
5248 </para></listitem>
5249 <listitem><para>
5250 <emphasis><filename>libfm-gtk</filename>:</emphasis>
5251 The <filename>libfm</filename> GTK+ bindings are split into
5252 a separate <filename>libfm-gtk</filename> package.
5253 </para></listitem>
5254 <listitem><para>
5255 <emphasis><filename>flex-libfl</filename>:</emphasis>
5256 The flex recipe splits out libfl into a separate
5257 <filename>flex-libfl</filename> package to avoid too many
5258 dependencies being pulled in where only the library is
5259 needed.
5260 </para></listitem>
5261 <listitem><para>
5262 <emphasis><filename>grub-efi</filename>:</emphasis>
5263 The <filename>grub-efi</filename> configuration is split
5264 into a separate <filename>grub-bootconf</filename>
5265 recipe.
5266 However, the dependency relationship from
5267 <filename>grub-efi</filename> is through a
5268 virtual/grub-bootconf provider making it possible to have
5269 your own recipe provide the dependency.
5270 Alternatively, you can use a BitBake append file to bring
5271 the configuration back into the
5272 <filename>grub-efi</filename> recipe.
5273 </para></listitem>
5274 <listitem><para>
5275 <emphasis>armv7a Legacy Package Feed Support:</emphasis>
5276 Legacy support is removed for transitioning from
5277 <filename>armv7a</filename> to
5278 <filename>armv7a-vfp-neon</filename> in package feeds,
5279 which was previously enabled by setting
5280 <filename>PKGARCHCOMPAT_ARMV7A</filename>.
5281 This transition occurred in 2011 and active package feeds
5282 should by now be updated to the new naming.
5283 </para></listitem>
5284 </itemizedlist>
5285 </para>
5286 </section>
5287
5288 <section id='migration-2.5-removed-recipes'>
5289 <title>Removed Recipes</title>
5290
5291 <para>
5292 The following recipes have been removed:
5293 <itemizedlist>
5294 <listitem><para>
5295 <emphasis><filename>gcc</filename>:</emphasis>
5296 The version 6.4 recipes are replaced by 7.x.
5297 </para></listitem>
5298 <listitem><para>
5299 <emphasis><filename>gst-player</filename>:</emphasis>
5300 Renamed to <filename>gst-examples</filename> as per
5301 upstream.
5302 </para></listitem>
5303 <listitem><para>
5304 <emphasis><filename>hostap-utils</filename>:</emphasis>
5305 This software package is obsolete.
5306 </para></listitem>
5307 <listitem><para>
5308 <emphasis><filename>latencytop</filename>:</emphasis>
5309 This recipe is no longer maintained upstream.
5310 The last release was in 2009.
5311 </para></listitem>
5312 <listitem><para>
5313 <emphasis><filename>libpfm4</filename>:</emphasis>
5314 The only file that requires this recipe is
5315 <filename>oprofile</filename>, which has been removed.
5316 </para></listitem>
5317 <listitem><para>
5318 <emphasis><filename>linux-yocto</filename>:</emphasis>
5319 The version 4.4, 4.9, and 4.10 recipes have been removed.
5320 Versions 4.12, 4.14, and 4.15 remain.
5321 </para></listitem>
5322 <listitem><para>
5323 <emphasis><filename>man</filename>:</emphasis>
5324 This recipe has been replaced by modern
5325 <filename>man-db</filename>
5326 </para></listitem>
5327 <listitem><para>
5328 <emphasis><filename>mkelfimage</filename>:</emphasis>
5329 This tool has been removed in the upstream coreboot project,
5330 and is no longer needed with the removal of the ELF image
5331 type.
5332 </para></listitem>
5333 <listitem><para>
5334 <emphasis><filename>nativesdk-postinst-intercept</filename>:</emphasis>
5335 This recipe is not maintained.
5336 </para></listitem>
5337 <listitem><para>
5338 <emphasis><filename>neon</filename>:</emphasis>
5339 This software package is no longer maintained upstream and
5340 is no longer needed by anything in OpenEmbedded-Core.
5341 </para></listitem>
5342 <listitem><para>
5343 <emphasis><filename>oprofile</filename>:</emphasis>
5344 The functionality of this recipe is replaced by
5345 <filename>perf</filename> and keeping compatibility on
5346 an ongoing basis with <filename>musl</filename> is
5347 difficult.
5348 </para></listitem>
5349 <listitem><para>
5350 <emphasis><filename>pax</filename>:</emphasis>
5351 This software package is obsolete.
5352 </para></listitem>
5353 <listitem><para>
5354 <emphasis><filename>stat</filename>:</emphasis>
5355 This software package is not maintained upstream.
5356 <filename>coreutils</filename> provides a modern stat binary.
5357 </para></listitem>
5358 <listitem><para>
5359 <emphasis><filename>zisofs-tools-native</filename>:</emphasis>
5360 This recipe is no longer needed because the compressed
5361 ISO image feature has been removed.
5362 </para></listitem>
5363 </itemizedlist>
5364 </para>
5365 </section>
5366
5367 <section id='migration-2.5-scripts-and-tools-changes'>
5368 <title>Scripts and Tools Changes</title>
5369
5370 <para>
5371 The following are changes to scripts and tools:
5372 <itemizedlist>
5373 <listitem><para>
5374 <emphasis><filename>yocto-bsp</filename>,
5375 <filename>yocto-kernel</filename>, and
5376 <filename>yocto-layer</filename></emphasis>:
5377 The <filename>yocto-bsp</filename>,
5378 <filename>yocto-kernel</filename>, and
5379 <filename>yocto-layer</filename> scripts previously shipped
5380 with poky but not in OpenEmbedded-Core have been removed.
5381 These scripts are not maintained and are outdated.
5382 In many cases, they are also limited in scope.
5383 The <filename>bitbake-layers create-layer</filename> command
5384 is a direct replacement for <filename>yocto-layer</filename>.
5385 See the documentation to create a BSP or kernel recipe in
5386 the
5387 "<ulink url='&YOCTO_DOCS_BSP_URL;#bsp-kernel-recipe-example'>BSP Kernel Recipe Example</ulink>"
5388 section.
5389 </para></listitem>
5390 <listitem><para>
5391 <emphasis><filename>devtool finish</filename>:</emphasis>
5392 <filename>devtool finish</filename> now exits with an error
5393 if there are uncommitted changes or a rebase/am in progress
5394 in the recipe's source repository.
5395 If this error occurs, there might be uncommitted changes
5396 that will not be included in updates to the patches applied
5397 by the recipe.
5398 A -f/--force option is provided for situations that the
5399 uncommitted changes are inconsequential and you want to
5400 proceed regardless.
5401 </para></listitem>
5402 <listitem><para>
5403 <emphasis><filename>scripts/oe-setup-rpmrepo</filename> script:</emphasis>
5404 The functionality of
5405 <filename>scripts/oe-setup-rpmrepo</filename> is replaced by
5406 <filename>bitbake package-index</filename>.
5407 </para></listitem>
5408 <listitem><para>
5409 <emphasis><filename>scripts/test-dependencies.sh</filename> script:</emphasis>
5410 The script is largely made obsolete by the
5411 recipe-specific sysroots functionality introduced in the
5412 previous release.
5413 </para></listitem>
5414 </itemizedlist>
5415 </para>
5416 </section>
5417
5418 <section id='migration-2.5-bitbake-changes'>
5419 <title>BitBake Changes</title>
5420
5421 <para>
5422 The following are BitBake changes:
5423 <itemizedlist>
5424 <listitem><para>
5425 The <filename>--runall</filename> option has changed.
5426 There are two different behaviors people might want:
5427 <itemizedlist>
5428 <listitem><para>
5429 <emphasis>Behavior A:</emphasis>
5430 For a given target (or set of targets) look through
5431 the task graph and run task X only if it is present
5432 and will be built.
5433 </para></listitem>
5434 <listitem><para>
5435 <emphasis>Behavior B:</emphasis>
5436 For a given target (or set of targets) look through
5437 the task graph and run task X if any recipe in the
5438 taskgraph has such a target, even if it is not in
5439 the original task graph.
5440 </para></listitem>
5441 </itemizedlist>
5442 The <filename>--runall</filename> option now performs
5443 "Behavior B".
5444 Previously <filename>--runall</filename> behaved like
5445 "Behavior A".
5446 A <filename>--runonly</filename> option has been added to
5447 retain the ability to perform "Behavior A".
5448 </para></listitem>
5449 <listitem><para>
5450 Several explicit "run this task for all recipes in the
5451 dependency tree" tasks have been removed (e.g.
5452 <filename>fetchall</filename>,
5453 <filename>checkuriall</filename>, and the
5454 <filename>*all</filename> tasks provided by the
5455 <filename>distrodata</filename> and
5456 <filename>archiver</filename> classes).
5457 There is a BitBake option to complete this for any arbitrary
5458 task. For example:
5459 <literallayout class='monospaced'>
5460 bitbake &lt;target&gt; -c fetchall
5461 </literallayout>
5462 should now be replaced with:
5463 <literallayout class='monospaced'>
5464 bitbake &lt;target&gt; --runall=fetch
5465 </literallayout>
5466 </para></listitem>
5467 </itemizedlist>
5468 </para>
5469 </section>
5470
5471 <section id='migration-2.5-python-and-python3-changes'>
5472 <title>Python and Python 3 Changes</title>
5473
5474 <para>
5475 The following are auto-packaging changes to Python and Python 3:
5476 </para>
5477 <para>
5478 The script-managed <filename>python-*-manifest.inc</filename> files
5479 that were previously used to generate Python and Python 3
5480 packages have been replaced with a JSON-based file that is
5481 easier to read and maintain.
5482 A new task is available for maintainers of the Python recipes to
5483 update the JSON file when upgrading to new Python versions.
5484 You can now edit the file directly instead of having to edit a
5485 script and run it to update the file.
5486 </para>
5487 <para>
5488 One particular change to note is that the Python recipes no longer
5489 have build-time provides for their packages.
5490 This assumes <filename>python-foo</filename> is one of the packages
5491 provided by the Python recipe.
5492 You can no longer run <filename>bitbake python-foo</filename> or
5493 have a <ulink url='&YOCTO_DOCS_REF_URL;#var-DEPENDS'><filename>DEPENDS</filename></ulink> on
5494 <filename>python-foo</filename>, but doing either of the following
5495 causes the package to work as expected:
5496 <literallayout class='monospaced'>
5497 IMAGE_INSTALL_append = " python-foo"
5498 </literallayout>
5499 or
5500 <literallayout class='monospaced'>
5501 RDEPENDS_${PN} = "python-foo"
5502 </literallayout>
5503 The earlier build-time provides behavior was a quirk of the way the
5504 Python manifest file was created.
5505 For more information on this change please see
5506 <ulink url='http://git.yoctoproject.org/cgit/cgit.cgi/poky/commit/?id=8d94b9db221d1def42f091b991903faa2d1651ce'>this commit</ulink>.
5507 </para>
5508 </section>
5509
5510 <section id='migration-2.5-miscellaneous-changes'>
5511 <title>Miscellaneous Changes</title>
5512
5513 <para>
5514 The following are additional changes:
5515 <itemizedlist>
5516 <listitem><para>
5517 The <filename>kernel</filename> class supports building
5518 packages for multiple kernels.
5519 If your kernel recipe or <filename>.bbappend</filename> file
5520 mentions packaging at all, you should replace references to
5521 the kernel in package names with
5522 <filename>${KERNEL_PACKAGE_NAME}</filename>.
5523 For example, if you disable automatic installation of the
5524 kernel image using
5525 <filename>RDEPENDS_kernel-base = ""</filename> you can avoid
5526 warnings using
5527 <filename>RDEPENDS_${KERNEL_PACKAGE_NAME}-base = ""</filename>
5528 instead.
5529 </para></listitem>
5530 <listitem><para>
5531 The <filename>buildhistory</filename> class commits changes
5532 to the repository by default so you no longer need to set
5533 <filename>BUILDHISTORY_COMMIT = "1"</filename>.
5534 If you want to disable commits you need to set
5535 <filename>BUILDHISTORY_COMMIT = "0"</filename> in your
5536 configuration.
5537 </para></listitem>
5538 <listitem><para>
5539 The <filename>beaglebone</filename> reference machine has
5540 been renamed to <filename>beaglebone-yocto</filename>.
5541 The <filename>beaglebone-yocto</filename> BSP is a reference
5542 implementation using only mainline components available in
5543 OpenEmbedded-Core and <filename>meta-yocto-bsp</filename>,
5544 whereas Texas Instruments maintains a full-featured BSP in
5545 the <filename>meta-ti</filename> layer.
5546 This rename avoids the previous name clash that existed
5547 between the two BSPs.
5548 </para></listitem>
5549 <listitem><para>
5550 The <filename>update-alternatives</filename> class no longer
5551 works with SysV <filename>init</filename> scripts because
5552 this usage has been problematic.
5553 Also, the <filename>sysklogd</filename> recipe no longer
5554 uses <filename>update-alternatives</filename> because it is
5555 incompatible with other implementations.
5556 </para></listitem>
5557 <listitem><para>
Brad Bishop1a4b7ee2018-12-16 17:11:34 -08005558 By default, the
5559 <link linkend='ref-classes-cmake'><filename>cmake</filename></link>
5560 class uses <filename>ninja</filename> instead of
Brad Bishop316dfdd2018-06-25 12:45:53 -04005561 <filename>make</filename> for building.
5562 This improves build performance.
5563 If a recipe is broken with <filename>ninja</filename>, then
5564 the recipe can set
5565 <filename>OECMAKE_GENERATOR = "Unix Makefiles"</filename>
5566 to change back to <filename>make</filename>.
5567 </para></listitem>
5568 <listitem><para>
5569 The previously deprecated <filename>base_*</filename>
5570 functions have been removed in favor of their replacements
5571 in <filename>meta/lib/oe</filename> and
5572 <filename>bitbake/lib/bb</filename>.
5573 These are typically used from recipes and classes.
5574 Any references to the old functions must be updated.
5575 The following table shows the removed functions and their
5576 replacements:
5577
5578 <literallayout class='monospaced'>
5579 <emphasis>Removed</emphasis> <emphasis>Replacement</emphasis>
5580 ============================ ============================
5581 base_path_join() oe.path.join()
5582 base_path_relative() oe.path.relative()
5583 base_path_out() oe.path.format_display()
5584 base_read_file() oe.utils.read_file()
5585 base_ifelse() oe.utils.ifelse()
5586 base_conditional() oe.utils.conditional()
5587 base_less_or_equal() oe.utils.less_or_equal()
5588 base_version_less_or_equal() oe.utils.version_less_or_equal()
5589 base_contains() bb.utils.contains()
5590 base_both_contain() oe.utils.both_contain()
5591 base_prune_suffix() oe.utils.prune_suffix()
5592 oe_filter() oe.utils.str_filter()
5593 oe_filter_out() oe.utils.str_filter_out() (or use the _remove operator).
5594 </literallayout>
5595 </para></listitem>
5596 <listitem><para>
5597 Using <filename>exit 1</filename> to explicitly defer a
5598 postinstall script until first boot is now deprecated since
5599 it is not an obvious mechanism and can mask actual errors.
5600 If you want to explicitly defer a postinstall to first boot
5601 on the target rather than at <filename>rootfs</filename>
5602 creation time, use
5603 <filename>pkg_postinst_ontarget()</filename>
5604 or call
5605 <filename>postinst-intercepts defer_to_first_boot</filename>
5606 from <filename>pkg_postinst()</filename>.
5607 Any failure of a <filename>pkg_postinst()</filename>
5608 script (including <filename>exit 1</filename>)
5609 will trigger a warning during
Brad Bishop1a4b7ee2018-12-16 17:11:34 -08005610 <filename>do_rootfs</filename>.</para>
5611
5612 <para>For more information, see the
5613 "<ulink url='&YOCTO_DOCS_DEV_URL;#new-recipe-post-installation-scripts'>Post-Installation Scripts</ulink>"
5614 section in the Yocto Project Development Tasks Manual.
Brad Bishop316dfdd2018-06-25 12:45:53 -04005615 </para></listitem>
5616 <listitem><para>
5617 The <filename>elf</filename> image type has been removed.
5618 This image type was removed because the
5619 <filename>mkelfimage</filename> tool
5620 that was required to create it is no longer provided by
5621 coreboot upstream and required updating every time
5622 <filename>binutils</filename> updated.
5623 </para></listitem>
5624 <listitem><para>
5625 Support for .iso image compression (previously enabled
5626 through <filename>COMPRESSISO = "1"</filename>) has been
5627 removed.
5628 The userspace tools (<filename>zisofs-tools</filename>) are
5629 unmaintained and <filename>squashfs</filename> provides
5630 better performance and compression.
5631 In order to build a live image with squashfs+lz4 compression
5632 enabled you should now set
5633 <filename>LIVE_ROOTFS_TYPE = "squashfs-lz4"</filename>
5634 and ensure that <filename>live</filename>
5635 is in <filename>IMAGE_FSTYPES</filename>.
5636 </para></listitem>
5637 <listitem><para>
5638 Recipes with an unconditional dependency on
5639 <filename>libpam</filename> are only buildable with
5640 <filename>pam</filename> in
5641 <filename>DISTRO_FEATURES</filename>.
5642 If the dependency is truly optional then it is recommended
5643 that the dependency be conditional upon
5644 <filename>pam</filename> being in
5645 <filename>DISTRO_FEATURES</filename>.
5646 </para></listitem>
5647 <listitem><para>
5648 For EFI-based machines, the bootloader
5649 (<filename>grub-efi</filename> by default) is installed into
5650 the image at /boot.
5651 Wic can be used to split the bootloader into separate boot
5652 and rootfs partitions if necessary.
5653 </para></listitem>
5654 <listitem><para>
5655 Patches whose context does not match exactly (i.e. where
5656 patch reports "fuzz" when applying) will generate a
5657 warning.
5658 For an example of this see
5659 <ulink url='http://git.yoctoproject.org/cgit/cgit.cgi/poky/commit/?id=cc97bc08125b63821ce3f616771830f77c456f57'>this commit</ulink>.
5660 </para></listitem>
5661 <listitem><para>
5662 Layers are expected to set
5663 <filename>LAYERSERIES_COMPAT_layername</filename>
5664 to match the version(s) of OpenEmbedded-Core they are
5665 compatible with.
5666 This is specified as codenames using spaces to separate
5667 multiple values (e.g. "rocko sumo").
5668 If a layer does not set
5669 <filename>LAYERSERIES_COMPAT_layername</filename>, a warning
5670 will is shown.
5671 If a layer sets a value that does not include the current
5672 version ("sumo" for the 2.5 release), then an error will be
5673 produced.
5674 </para></listitem>
5675 <listitem><para>
5676 The <filename>TZ</filename> environment variable is set to
5677 "UTC" within the build environment in order to fix
5678 reproducibility problems in some recipes.
5679 </para></listitem>
5680 </itemizedlist>
5681 </para>
5682 </section>
5683</section>
Brad Bishop1a4b7ee2018-12-16 17:11:34 -08005684
5685<section id='moving-to-the-yocto-project-2.6-release'>
5686 <title>Moving to the Yocto Project 2.6 Release</title>
5687
5688 <para>
5689 This section provides migration information for moving to the
5690 Yocto Project 2.6 Release from the prior release.
5691 </para>
5692
5693 <section id='migration-2.6-gcc-changes'>
5694 <title>GCC 8.2 is Now Used by Default</title>
5695
5696 <para>
5697 The GNU Compiler Collection version 8.2 is now used by default
5698 for compilation.
5699 For more information on what has changed in the GCC 8.x release,
5700 see
5701 <ulink url='https://gcc.gnu.org/gcc-8/changes.html'></ulink>.
5702 </para>
5703
5704 <para>
5705 If you still need to compile with version 7.x, GCC 7.3 is
5706 also provided.
5707 You can select this version by setting the
5708 and can be selected by setting the
5709 <link linkend='var-GCCVERSION'><filename>GCCVERSION</filename></link>
5710 variable to "7.%" in your configuration.
5711 </para>
5712 </section>
5713
5714 <section id='migration-2.6-removed-recipes'>
5715 <title>Removed Recipes</title>
5716
5717 <para>
5718 The following recipes have been removed:
5719 <literallayout class='monospaced'>
5720 <emphasis><filename>beecrypt</filename>:</emphasis> No longer needed since moving to RPM 4.
5721 <emphasis><filename>bigreqsproto</filename>:</emphasis> Replaced by <filename>xorgproto</filename>.
5722 <emphasis><filename>calibrateproto</filename>:</emphasis> Removed in favor of <filename>xinput</filename>.
5723 <emphasis><filename>compositeproto</filename>:</emphasis> Replaced by <filename>xorgproto</filename>.
5724 <emphasis><filename>damageproto</filename>:</emphasis> Replaced by <filename>xorgproto</filename>.
5725 <emphasis><filename>dmxproto</filename>:</emphasis> Replaced by <filename>xorgproto</filename>.
5726 <emphasis><filename>dri2proto</filename>:</emphasis> Replaced by <filename>xorgproto</filename>.
5727 <emphasis><filename>dri3proto</filename>:</emphasis> Replaced by <filename>xorgproto</filename>.
5728 <emphasis><filename>eee-acpi-scripts</filename>:</emphasis> Became obsolete.
5729 <emphasis><filename>fixesproto</filename>:</emphasis> Replaced by <filename>xorgproto</filename>.
5730 <emphasis><filename>fontsproto</filename>:</emphasis> Replaced by <filename>xorgproto</filename>.
5731 <emphasis><filename>fstests</filename>:</emphasis> Became obsolete.
5732 <emphasis><filename>gccmakedep</filename>:</emphasis> No longer used.
5733 <emphasis><filename>glproto</filename>:</emphasis> Replaced by <filename>xorgproto</filename>.
5734 <emphasis><filename>gnome-desktop3</filename>:</emphasis> No longer needed. This recipe has moved to <filename>meta-oe</filename>.
5735 <emphasis><filename>icon-naming-utils</filename>:</emphasis> No longer used since the Sato theme was removed in 2016.
5736 <emphasis><filename>inputproto</filename>:</emphasis> Replaced by <filename>xorgproto</filename>.
5737 <emphasis><filename>kbproto</filename>:</emphasis> Replaced by <filename>xorgproto</filename>.
5738 <emphasis><filename>libusb-compat</filename>:</emphasis> Became obsolete.
5739 <emphasis><filename>libuser</filename>:</emphasis> Became obsolete.
5740 <emphasis><filename>libnfsidmap</filename>:</emphasis> No longer an external requirement since <filename>nfs-utils</filename> 2.2.1. <filename>libnfsidmap</filename> is now integrated.
5741 <emphasis><filename>libxcalibrate</filename>:</emphasis> No longer needed with <filename>xinput</filename>
5742 <emphasis><filename>mktemp</filename>:</emphasis> Became obsolete. The <filename>mktemp</filename> command is provided by both <filename>busybox</filename> and <filename>coreutils</filename>.
5743 <emphasis><filename>ossp-uuid</filename>:</emphasis> Is not being maintained and has mostly been replaced by <filename>uuid.h</filename> in <filename>util-linux</filename>.
5744 <emphasis><filename>pax-utils</filename>:</emphasis> No longer needed. Previous QA tests that did use this recipe are now done at build time.
5745 <emphasis><filename>pcmciautils</filename>:</emphasis> Became obsolete.
5746 <emphasis><filename>pixz</filename>:</emphasis> No longer needed. <filename>xz</filename> now supports multi-threaded compression.
5747 <emphasis><filename>presentproto</filename>:</emphasis> Replaced by <filename>xorgproto</filename>.
5748 <emphasis><filename>randrproto</filename>:</emphasis> Replaced by <filename>xorgproto</filename>.
5749 <emphasis><filename>recordproto</filename>:</emphasis> Replaced by <filename>xorgproto</filename>.
5750 <emphasis><filename>renderproto</filename>:</emphasis> Replaced by <filename>xorgproto</filename>.
5751 <emphasis><filename>resourceproto</filename>:</emphasis> Replaced by <filename>xorgproto</filename>.
5752 <emphasis><filename>scrnsaverproto</filename>:</emphasis> Replaced by <filename>xorgproto</filename>.
5753 <emphasis><filename>trace-cmd</filename>:</emphasis> Became obsolete. <filename>perf</filename> replaced this recipe's functionally.
5754 <emphasis><filename>videoproto</filename>:</emphasis> Replaced by <filename>xorgproto</filename>.
5755 <emphasis><filename>wireless-tools</filename>:</emphasis> Became obsolete. Superseded by <filename>iw</filename>.
5756 <emphasis><filename>xcmiscproto</filename>:</emphasis> Replaced by <filename>xorgproto</filename>.
5757 <emphasis><filename>xextproto</filename>:</emphasis> Replaced by <filename>xorgproto</filename>.
5758 <emphasis><filename>xf86dgaproto</filename>:</emphasis> Replaced by <filename>xorgproto</filename>.
5759 <emphasis><filename>xf86driproto</filename>:</emphasis> Replaced by <filename>xorgproto</filename>.
5760 <emphasis><filename>xf86miscproto</filename>:</emphasis> Replaced by <filename>xorgproto</filename>.
5761 <emphasis><filename>xf86-video-omapfb</filename>:</emphasis> Became obsolete. Use kernel modesetting driver instead.
5762 <emphasis><filename>xf86-video-omap</filename>:</emphasis> Became obsolete. Use kernel modesetting driver instead.
5763 <emphasis><filename>xf86vidmodeproto</filename>:</emphasis> Replaced by <filename>xorgproto</filename>.
5764 <emphasis><filename>xineramaproto</filename>:</emphasis> Replaced by <filename>xorgproto</filename>.
5765 <emphasis><filename>xproto</filename>:</emphasis> Replaced by <filename>xorgproto</filename>.
5766 <emphasis><filename>yasm</filename>:</emphasis> No longer needed since previous usages are now satisfied by <filename>nasm</filename>.
5767 </literallayout>
5768 </para>
5769 </section>
5770
5771 <section id='migration-2.6-packaging-changes'>
5772 <title>Packaging Changes</title>
5773
5774 <para>
5775 The following packaging changes have been made:
5776 <itemizedlist>
5777 <listitem><para>
5778 <emphasis><filename>cmake</filename>:</emphasis>
5779 <filename>cmake.m4</filename> and
5780 <filename>toolchain</filename> files have been moved to the
5781 main package.
5782 </para></listitem>
5783 <listitem><para>
5784 <emphasis><filename>iptables</filename>:</emphasis>
5785 The <filename>iptables</filename> modules have been split
5786 into separate packages.
5787 </para></listitem>
5788 <listitem><para>
5789 <emphasis><filename>alsa-lib</filename>:</emphasis>
5790 <filename>libasound</filename> is now in the main
5791 <filename>alsa-lib</filename> package instead of
5792 <filename>libasound</filename>.
5793 </para></listitem>
5794 <listitem><para>
5795 <emphasis><filename>glibc</filename>:</emphasis>
5796 <filename>libnss-db</filename> is now in its own package
5797 along with a <filename>/var/db/makedbs.sh</filename>
5798 script to update databases.
5799 </para></listitem>
5800 <listitem><para>
5801 <emphasis><filename>python</filename> and <filename>python3</filename>:</emphasis>
5802 The main package has been removed from the recipe.
5803 You must install specific packages or
5804 <filename>python-modules</filename> /
5805 <filename>python3-modules</filename> for everything.
5806 </para></listitem>
5807 <listitem><para>
5808 <emphasis><filename>systemtap</filename>:</emphasis>
5809 Moved <filename>systemtap-exporter</filename> into its own
5810 package.
5811 </para></listitem>
5812 </itemizedlist>
5813 </para>
5814 </section>
5815
5816 <section id='migration-2.6-xorg-protocol-dependencies'>
5817 <title>XOrg Protocol dependencies</title>
5818
5819 <para>
5820 The "*proto" upstream repositories have been combined into one
5821 "xorgproto" repository.
5822 Thus, the corresponding recipes have also been combined into a
5823 single <filename>xorgproto</filename> recipe.
5824 Any recipes that depend upon the older <filename>*proto</filename>
5825 recipes need to be changed to depend on the newer
5826 <filename>xorgproto</filename> recipe instead.
5827 </para>
5828
5829 <para>
5830 For names of recipes removed because of this repository change,
5831 see the
5832 <link linkend="migration-2.6-removed-recipes">Removed Recipes</link>
5833 section.
5834 </para>
5835 </section>
5836
5837 <section id='migration-2.6-distutils-distutils3-fetching-dependencies'>
5838 <title><filename>distutils</filename> and <filename>distutils3</filename> Now Prevent Fetching Dependencies During the <filename>do_configure</filename> Task</title>
5839
5840 <para>
5841 Previously, it was possible for Python recipes that inherited
5842 the
5843 <link linkend='ref-classes-distutils'><filename>distutils</filename></link>
5844 and
5845 <link linkend='ref-classes-distutils3'><filename>distutils3</filename></link>
5846 classes to fetch code during the
5847 <link linkend='ref-tasks-configure'><filename>do_configure</filename></link>
5848 task to satisfy dependencies mentioned in
5849 <filename>setup.py</filename> if those dependencies were not
5850 provided in the sysroot (i.e. recipes providing the dependencies
5851 were missing from
5852 <link linkend='var-DEPENDS'><filename>DEPENDS</filename></link>).
5853 <note>
5854 This change affects classes beyond just the two mentioned
5855 (i.e. <filename>distutils</filename> and
5856 <filename>distutils3</filename>).
5857 Any recipe that inherits <filename>distutils*</filename>
5858 classes are affected.
5859 For example, the <filename>setuptools</filename> and
5860 <filename>setuptools3</filename> recipes are affected since
5861 they inherit the <filename>distutils*</filename> classes.
5862 </note>
5863 </para>
5864
5865 <para>
5866 Fetching these types of dependencies that are not provided in the
5867 sysroot negatively affects the ability to reproduce builds.
5868 This type of fetching is now explicitly disabled.
5869 Consequently, any missing dependencies in Python recipes that
5870 use these classes now result in an error during the
5871 <filename>do_configure</filename> task.
5872 </para>
5873 </section>
5874
5875 <section id='migration-2.6-linux-yocto-configuration-audit-issues-now-correctly-reported'>
5876 <title><filename>linux-yocto</filename> Configuration Audit Issues Now Correctly Reported</title>
5877
5878 <para>
5879 Due to a bug, the kernel configuration audit functionality was
5880 not writing out any resulting warnings during the build.
5881 This issue is now corrected.
5882 You might notice these warnings now if you have a custom kernel
5883 configuration with a <filename>linux-yocto</filename> style
5884 kernel recipe.
5885 </para>
5886 </section>
5887
5888 <section id='migration-2.6-image-kernel-artifact-naming-changes'>
5889 <title>Image/Kernel Artifact Naming Changes</title>
5890
5891 <para>
5892 The following changes have been made:
5893 <itemizedlist>
5894 <listitem><para>
5895 Name variables (e.g.
5896 <link linkend='var-IMAGE_NAME'><filename>IMAGE_NAME</filename></link>)
5897 use a new <filename>IMAGE_VERSION_SUFFIX</filename>
5898 variable instead of
5899 <link linkend='var-DATETIME'><filename>DATETIME</filename></link>.
5900 Using <filename>IMAGE_VERSION_SUFFIX</filename> allows
5901 easier and more direct changes.</para>
5902
5903 <para>The <filename>IMAGE_VERSION_SUFFIX</filename>
5904 variable is set in the
5905 <filename>bitbake.conf</filename> configuration file as
5906 follows:
5907 <literallayout class='monospaced'>
5908 IMAGE_VERSION_SUFFIX = "-${DATETIME}"
5909 </literallayout>
5910 </para></listitem>
5911 <listitem><para>
5912 Several variables have changed names for consistency:
5913 <literallayout class='monospaced'>
5914 Old Variable Name New Variable Name
5915 ========================================================
5916 KERNEL_IMAGE_BASE_NAME <link linkend='var-KERNEL_IMAGE_NAME'>KERNEL_IMAGE_NAME</link>
5917 KERNEL_IMAGE_SYMLINK_NAME <link linkend='var-KERNEL_IMAGE_LINK_NAME'>KERNEL_IMAGE_LINK_NAME</link>
5918 MODULE_TARBALL_BASE_NAME <link linkend='var-MODULE_TARBALL_NAME'>MODULE_TARBALL_NAME</link>
5919 MODULE_TARBALL_SYMLINK_NAME <link linkend='var-MODULE_TARBALL_LINK_NAME'>MODULE_TARBALL_LINK_NAME</link>
5920 INITRAMFS_BASE_NAME <link linkend='var-INITRAMFS_NAME'>INITRAMFS_NAME</link>
5921 </literallayout>
5922 </para></listitem>
5923 <listitem><para>
5924 The <filename>MODULE_IMAGE_BASE_NAME</filename> variable
5925 has been removed.
5926 The module tarball name is now controlled directly with the
5927 <link linkend='var-MODULE_TARBALL_NAME'><filename>MODULE_TARBALL_NAME</filename></link>
5928 variable.
5929 </para></listitem>
5930 <listitem><para>
5931 The
5932 <link linkend='var-KERNEL_DTB_NAME'><filename>KERNEL_DTB_NAME</filename></link>
5933 and
5934 <link linkend='var-KERNEL_DTB_LINK_NAME'><filename>KERNEL_DTB_LINK_NAME</filename></link>
5935 variables have been introduced to control kernel Device
5936 Tree Binary (DTB) artifact names instead of mangling
5937 <filename>KERNEL_IMAGE_*</filename> variables.
5938 </para></listitem>
5939 <listitem><para>
5940 The
5941 <link linkend='var-KERNEL_FIT_NAME'><filename>KERNEL_FIT_NAME</filename></link>
5942 and
5943 <link linkend='var-KERNEL_FIT_LINK_NAME'><filename>KERNEL_FIT_LINK_NAME</filename></link>
5944 variables have been introduced to specify the name of
5945 flattened image tree (FIT) kernel images similar to other
5946 deployed artifacts.
5947 </para></listitem>
5948 <listitem><para>
5949 The
5950 <link linkend='var-MODULE_TARBALL_NAME'><filename>MODULE_TARBALL_NAME</filename></link>
5951 and
5952 <link linkend='var-MODULE_TARBALL_LINK_NAME'><filename>MODULE_TARBALL_LINK_NAME</filename></link>
5953 variable values no longer include the "module-" prefix or
5954 ".tgz" suffix.
5955 These parts are now hardcoded so that the values are
5956 consistent with other artifact naming variables.
5957 </para></listitem>
5958 <listitem><para>
5959 Added the
5960 <link linkend='var-INITRAMFS_LINK_NAME'><filename>INITRAMFS_LINK_NAME</filename></link>
5961 variable so that the symlink can be controlled similarly
5962 to other artifact types.
5963 </para></listitem>
5964 <listitem><para>
5965 <link linkend='var-INITRAMFS_NAME'><filename>INITRAMFS_NAME</filename></link>
5966 now uses
5967 "${PKGE}-${PKGV}-${PKGR}-${MACHINE}${IMAGE_VERSION_SUFFIX}"
5968 instead of
5969 "${PV}-${PR}-${MACHINE}-${DATETIME}", which
5970 makes it consistent with other variables.
5971 </para></listitem>
5972 </itemizedlist>
5973 </para>
5974 </section>
5975
5976 <section id='migration-2.6-serial-console-deprecated'>
5977 <title><filename>SERIAL_CONSOLE</filename> Deprecated</title>
5978
5979 <para>
5980 The
5981 <link linkend='var-SERIAL_CONSOLE'><filename>SERIAL_CONSOLE</filename></link>
5982 variable has been functionally replaced by the
5983 <link linkend='var-SERIAL_CONSOLES'><filename>SERIAL_CONSOLES</filename></link>
5984 variable for some time.
5985 With the Yocto Project 2.6 release,
5986 <filename>SERIAL_CONSOLE</filename> has been officially deprecated.
5987 </para>
5988
5989 <para>
5990 <filename>SERIAL_CONSOLE</filename> will continue to work as
5991 before for the 2.6 release.
5992 However, for the sake of future compatibility, it is recommended
5993 that you replace all instances of
5994 <filename>SERIAL_CONSOLE</filename> with
5995 <filename>SERIAL_CONSOLES</filename>.
5996 <note>
5997 The only difference in usage is that
5998 <filename>SERIAL_CONSOLES</filename> expects entries to be
5999 separated using semicolons as compared to
6000 <filename>SERIAL_CONSOLE</filename>, which expects spaces.
6001 </note>
6002 </para>
6003 </section>
6004
6005 <section id='migration-2.6-poky-sets-unknown-configure-option-to-qa-error'>
6006 <title>Configure Script Reports Unknown Options as Errors</title>
6007
6008 <para>
6009 If the configure script reports an unknown option, this now
6010 triggers a QA error instead of a warning.
6011 Any recipes that previously got away with specifying such unknown
6012 options now need to be fixed.
6013 </para>
6014 </section>
6015
6016 <section id='migration-2.6-override-changes'>
6017 <title>Override Changes</title>
6018
6019 <para>
6020 The following changes have occurred:
6021 <itemizedlist>
6022 <listitem><para>
6023 <emphasis>The <filename>virtclass-native</filename> and
6024 <filename>virtclass-nativesdk</filename> Overrides Have
6025 Been Removed:</emphasis>
6026 The <filename>virtclass-native</filename> and
6027 <filename>virtclass-nativesdk</filename> overrides have
6028 been deprecated since 2012 in favor of
6029 <filename>class-native</filename> and
6030 <filename>class-nativesdk</filename>, respectively.
6031 Both <filename>virtclass-native</filename> and
6032 <filename>virtclass-nativesdk</filename> are now dropped.
6033 <note>
6034 The <filename>virtclass-multilib-</filename> overrides
6035 for multilib are still valid.
6036 </note>
6037 </para></listitem>
6038 <listitem><para>
6039 <emphasis>The <filename>forcevariable</filename>
6040 Override Now Has a Higher Priority Than
6041 <filename>libc</filename> Overrides:</emphasis>
6042 The <filename>forcevariable</filename> override is
6043 documented to be the highest priority override.
6044 However, due to a long-standing quirk of how
6045 <link linkend='var-OVERRIDES'><filename>OVERRIDES</filename></link>
6046 is set, the <filename>libc</filename> overrides (e.g.
6047 <filename>libc-glibc</filename>,
6048 <filename>libc-musl</filename>, and so forth) erroneously
6049 had a higher priority.
6050 This issue is now corrected.</para>
6051
6052 <para>It is likely this change will not cause any
6053 problems.
6054 However, it is possible with some unusual configurations
6055 that you might see a change in behavior if you were
6056 relying on the previous behavior.
6057 Be sure to check how you use
6058 <filename>forcevariable</filename> and
6059 <filename>libc-*</filename> overrides in your custom
6060 layers and configuration files to ensure they make sense.
6061 </para></listitem>
6062 <listitem><para>
6063 <emphasis>The <filename>build-${BUILD_OS}</filename>
6064 Override Has Been Removed:</emphasis>
6065 The <filename>build-${BUILD_OS}</filename>, which is
6066 typically <filename>build-linux</filename>, override has
6067 been removed because building on a host operating system
6068 other than a recent version of Linux is neither supported
6069 nor recommended.
6070 Dropping the override avoids giving the impression that
6071 other host operating systems might be supported.
6072 </para></listitem>
6073 <listitem><para>
6074 The "_remove" operator now preserves whitespace.
6075 Consequently, when specifying list items to remove, be
6076 aware that leading and trailing whitespace resulting from
6077 the removal is retained.</para>
6078
6079 <para>See the
6080 "<ulink url='&YOCTO_DOCS_BB_URL;#removing-override-style-syntax'>Removal (Override Style Syntax)</ulink>"
6081 section in the BitBake User Manual for a detailed example.
6082 </para></listitem>
6083 </itemizedlist>
6084 </para>
6085 </section>
6086
6087 <section id='migration-2.6-systemd-configuration-now-split-out-to-system-conf'>
6088 <title><filename>systemd</filename> Configuration is Now Split Into <filename>systemd-conf</filename></title>
6089
6090 <para>
6091 The configuration for the <filename>systemd</filename> recipe
6092 has been moved into a <filename>system-conf</filename> recipe.
6093 Moving this configuration to a separate recipe avoids the
6094 <filename>systemd</filename> recipe from becoming machine-specific
6095 for cases where machine-specific configurations need to be applied
6096 (e.g. for <filename>qemu*</filename> machines).
6097 </para>
6098
6099 <para>
6100 Currently, the new recipe packages the following files:
6101 <literallayout class='monospaced'>
6102 ${sysconfdir}/machine-id
6103 ${sysconfdir}/systemd/coredump.conf
6104 ${sysconfdir}/systemd/journald.conf
6105 ${sysconfdir}/systemd/logind.conf
6106 ${sysconfdir}/systemd/system.conf
6107 ${sysconfdir}/systemd/user.conf
6108 </literallayout>
6109 If you previously used bbappend files to append the
6110 <filename>systemd</filename> recipe to change any of the
6111 listed files, you must do so for the
6112 <filename>systemd-conf</filename> recipe instead.
6113 </para>
6114 </section>
6115
6116 <section id='migration-2.6-automatic-testing-changes'>
6117 <title>Automatic Testing Changes</title>
6118
6119 <para>
6120 This section provides information about automatic testing
6121 changes:
6122 <itemizedlist>
6123 <listitem><para>
6124 <emphasis><filename>TEST_IMAGE</filename> Variable Removed:</emphasis>
6125 Prior to this release, you set the
6126 <filename>TEST_IMAGE</filename> variable to "1" to
6127 enable automatic testing for successfully built images.
6128 The <filename>TEST_IMAGE</filename> variable no longer
6129 exists and has been replaced by the
6130 <link linkend='var-TESTIMAGE_AUTO'><filename>TESTIMAGE_AUTO</filename></link>
6131 variable.
6132 </para></listitem>
6133 <listitem><para>
6134 <emphasis>Inheriting the <filename>testimage</filename> and
6135 <filename>testsdk</filename> Classes:</emphasis>
6136 Best practices now dictate that you use the
6137 <link linkend='var-IMAGE_CLASSES'><filename>IMAGE_CLASSES</filename></link>
6138 variable rather than the
6139 <link linkend='var-INHERIT'><filename>INHERIT</filename></link>
6140 variable when you inherit the
6141 <link linkend='ref-classes-testimage*'><filename>testimage</filename></link>
6142 and
6143 <link linkend='ref-classes-testsdk'><filename>testsdk</filename></link>
6144 classes used for automatic testing.
6145 </para></listitem>
6146 </itemizedlist>
6147 </para>
6148 </section>
6149
6150 <section id='migration-2.6-openssl-changes'>
6151 <title>OpenSSL Changes</title>
6152
6153 <para>
6154 <ulink url='https://www.openssl.org/'>OpenSSL</ulink> has been
6155 upgraded from 1.0 to 1.1.
6156 By default, this upgrade could cause problems for recipes that
6157 have both versions in their dependency chains.
6158 The problem is that both versions cannot be installed together
6159 at build time.
6160 <note>
6161 It is possible to have both versions of the library at runtime.
6162 </note>
6163 </para>
6164 </section>
6165
6166 <section id='migration-2.6-bitbake-changes'>
6167 <title>BitBake Changes</title>
6168
6169 <para>
6170 The server logfile <filename>bitbake-cookerdaemon.log</filename> is
6171 now always placed in the
6172 <link linkend='build-directory'>Build Directory</link>
6173 instead of the current directory.
6174 </para>
6175 </section>
6176
6177 <section id='migration-2.6-security-changes'>
6178 <title>Security Changes</title>
6179
6180 <para>
6181 The Poky distribution now uses security compiler flags by
6182 default.
6183 Inclusion of these flags could cause new failures due to stricter
6184 checking for various potential security issues in code.
6185 </para>
6186 </section>
6187
6188 <section id='migration-2.6-post-installation-changes'>
6189 <title>Post Installation Changes</title>
6190
6191 <para>
6192 You must explicitly mark post installs to defer to the target.
6193 If you want to explicitly defer a postinstall to first boot on
6194 the target rather than at rootfs creation time, use
6195 <filename>pkg_postinst_ontarget()</filename> or call
6196 <filename>postinst-intercepts defer_to_first_boot</filename> from
6197 <filename>pkg_postinst()</filename>.
6198 Any failure of a <filename>pkg_postinst()</filename> script
6199 (including exit 1) triggers an error during the
6200 <link linkend='ref-tasks-rootfs'><filename>do_rootfs</filename></link> task.
6201 </para>
6202
6203 <para>
6204 For more information on post-installation behavior, see the
6205 "<ulink url='&YOCTO_DOCS_DEV_URL;#new-recipe-post-installation-scripts'>Post-Installation Scripts</ulink>"
6206 section in the Yocto Project Development Tasks Manual.
6207 </para>
6208 </section>
6209
6210 <section id='migration-2.6-python-3-profile-guided-optimizations'>
6211 <title>Python 3 Profile-Guided Optimization</title>
6212
6213 <para>
6214 The <filename>python3</filename> recipe now enables profile-guided
6215 optimization.
6216 Using this optimization requires a little extra build time in
6217 exchange for improved performance on the target at runtime.
6218 Additionally, the optimization is only enabled if the current
6219 <link linkend='var-MACHINE'><filename>MACHINE</filename></link>
6220 has support for user-mode emulation in QEMU (i.e. "qemu-usermode"
6221 is in
6222 <link linkend='var-MACHINE_FEATURES'><filename>MACHINE_FEATURES</filename></link>,
6223 which it is by default).
6224 </para>
6225
6226 <para>
6227 If you wish to disable Python profile-guided optimization
6228 regardless of the value of
6229 <filename>MACHINE_FEATURES</filename>, then ensure that
6230 <link linkend='var-PACKAGECONFIG'><filename>PACKAGECONFIG</filename></link>
6231 for the <filename>python3</filename> recipe does not contain "pgo".
6232 You could accomplish the latter using the following at the
6233 configuration level:
6234 <literallayout class='monospaced'>
6235 PACKAGECONFIG_remove_pn-python3 = "pgo"
6236 </literallayout>
6237 Alternatively, you can set
6238 <filename>PACKAGECONFIG</filename> using an append file for the
6239 <filename>python3</filename> recipe.
6240 </para>
6241 </section>
6242
6243 <section id='migration-2.6-miscellaneous-changes'>
6244 <title>Miscellaneous Changes</title>
6245
6246 <para>
6247 The following miscellaneous changes occurred:
6248 <itemizedlist>
6249 <listitem><para>
6250 Default to using the Thumb-2 instruction set for armv7a
6251 and above.
6252 If you have any custom recipes that build software that
6253 needs to be built with the ARM instruction set, change the
6254 recipe to set the instruction set as follows:
6255 <literallayout class='monospaced'>
6256 ARM_INSTRUCTION_SET = "arm"
6257 </literallayout>
6258 </para></listitem>
6259 <listitem><para>
6260 <filename>run-postinsts</filename> no longer uses
6261 <filename>/etc/*-postinsts</filename> for
6262 <filename>dpkg/opkg</filename> in favor of built-in
6263 postinst support.
6264 RPM behavior remains unchanged.
6265 </para></listitem>
6266 <listitem><para>
6267 The <filename>NOISO</filename> and
6268 <filename>NOHDD</filename> variables are no longer used.
6269 You now control building <filename>*.iso</filename> and
6270 <filename>*.hddimg</filename> image types directly
6271 by using the
6272 <link linkend='var-IMAGE_FSTYPES'><filename>IMAGE_FSTYPES</filename></link>
6273 variable.
6274 </para></listitem>
6275 <listitem><para>
6276 The <filename>scripts/contrib/mkefidisk.sh</filename>
6277 has been removed in favor of Wic.
6278 </para></listitem>
6279 <listitem><para>
6280 <filename>kernel-modules</filename> has been removed from
6281 <link linkend='var-RRECOMMENDS'><filename>RRECOMMENDS</filename></link>
6282 for <filename>qemumips</filename> and
6283 <filename>qemumips64</filename> machines.
6284 Removal also impacts the <filename>x86-base.inc</filename>
6285 file.
6286 <note>
6287 <filename>genericx86</filename> and
6288 <filename>genericx86-64</filename> retain
6289 <filename>kernel-modules</filename> as part of the
6290 <filename>RRECOMMENDS</filename> variable setting.
6291 </note>
6292 </para></listitem>
6293 <listitem><para>
6294 The <filename>LGPLv2_WHITELIST_GPL-3.0</filename>
6295 variable has been removed.
6296 If you are setting this variable in your configuration,
6297 set or append it to the
6298 <filename>WHITELIST_GPL-3.0</filename> variable instead.
6299 </para></listitem>
6300 <listitem><para>
6301 <filename>${ASNEEDED}</filename> is now included in
6302 the
6303 <link linkend='var-TARGET_LDFLAGS'><filename>TARGET_LDFLAGS</filename></link>
6304 variable directly.
6305 The remaining definitions from
6306 <filename>meta/conf/distro/include/as-needed.inc</filename>
6307 have been moved to corresponding recipes.
6308 </para></listitem>
6309 <listitem><para>
6310 Support for DSA host keys has been dropped from the
6311 OpenSSH recipes.
6312 If you are still using DSA keys, you must switch over to a
6313 more secure algorithm as recommended by OpenSSH upstream.
6314 </para></listitem>
6315 <listitem><para>
6316 The <filename>dhcp</filename> recipe now uses the
6317 <filename>dhcpd6.conf</filename> configuration file in
6318 <filename>dhcpd6.service</filename> for IPv6 DHCP rather
6319 than re-using <filename>dhcpd.conf</filename>, which is
6320 now reserved for IPv4.
6321 </para></listitem>
6322 </itemizedlist>
6323 </para>
6324 </section>
6325</section>
Brad Bishopc342db32019-05-15 21:57:59 -04006326
6327<section id='moving-to-the-yocto-project-2.7-release'>
6328 <title>Moving to the Yocto Project 2.7 Release</title>
6329
6330 <para>
6331 This section provides migration information for moving to the
6332 Yocto Project 2.7 Release from the prior release.
6333 </para>
6334
6335 <section id='migration-2.7-bitbake-changes'>
6336 <title>BitBake Changes</title>
6337
6338 <para>
6339 The following changes have been made to BitBake:
6340 <itemizedlist>
6341 <listitem><para>
6342 BitBake now checks anonymous Python functions and pure
6343 Python functions (e.g. <filename>def funcname:</filename>)
6344 in the metadata for tab indentation.
6345 If found, BitBake produces a warning.
6346 </para></listitem>
6347 <listitem><para>
6348 Bitbake now checks
6349 <link linkend='var-BBFILE_COLLECTIONS'><filename>BBFILE_COLLECTIONS</filename></link>
6350 for duplicate entries and triggers an error if any are
6351 found.
6352 </para></listitem>
6353 </itemizedlist>
6354 </para>
6355 </section>
6356
6357 <section id='migration-2.7-eclipse-support-dropped'>
6358 <title><trademark class='trade'>Eclipse</trademark> Support Removed</title>
6359
6360 <para>
6361 Support for the Eclipse IDE has been removed.
6362 Support continues for those releases prior to 2.7 that did include
6363 support.
6364 The 2.7 release does not include the Eclipse Yocto plugin.
6365 </para>
6366 </section>
6367
6368 <section id='migration-2.7-qemu-native-splits-system-and-user-mode-parts'>
6369 <title><filename>qemu-native</filename> Splits the System and User-Mode Parts</title>
6370
6371 <para>
6372 The system and user-mode parts of <filename>qemu-native</filename>
6373 are now split.
6374 <filename>qemu-native</filename> provides the user-mode components
6375 and <filename>qemu-system-native</filename> provides the system
6376 components.
6377 If you have recipes that depend on QEMU's system emulation
6378 functionality at build time, they should now depend upon
6379 <filename>qemu-system-native</filename> instead of
6380 <filename>qemu-native</filename>.
6381 </para>
6382 </section>
6383
6384 <section id='migration-2.7-upstream-tracking.inc-removed'>
6385 <title>The <filename>upstream-tracking.inc</filename> File Has Been Removed</title>
6386
6387 <para>
6388 The previously deprecated <filename>upstream-tracking.inc</filename>
6389 file is now removed.
6390 Any <filename>UPSTREAM_TRACKING*</filename> variables are now set
6391 in the corresponding recipes instead.
6392 </para>
6393
6394 <para>
6395 Remove any references you have to the
6396 <filename>upstream-tracking.inc</filename> file in your
6397 configuration.
6398 </para>
6399 </section>
6400
6401 <section id='migration-2.7-distro-features-libc-removed'>
6402 <title>The <filename>DISTRO_FEATURES_LIBC</filename> Variable Has Been Removed</title>
6403
6404 <para>
6405 The <filename>DISTRO_FEATURES_LIBC</filename> variable is no
6406 longer used.
6407 The ability to configure glibc using kconfig has been removed
6408 for quite some time making the <filename>libc-*</filename> features
6409 set no longer effective.
6410 </para>
6411
6412 <para>
6413 Remove any references you have to
6414 <filename>DISTRO_FEATURES_LIBC</filename> in your own layers.
6415 </para>
6416 </section>
6417
6418 <section id='migration-2.7-license-values'>
6419 <title>License Value Corrections</title>
6420
6421 <para>
6422 The following corrections have been made to the
6423 <link linkend='var-LICENSE'><filename>LICENSE</filename></link>
6424 values set by recipes:
6425 <literallayout class='monospaced'>
6426 <emphasis>socat</emphasis>: Corrected <filename>LICENSE</filename> to be "GPLv2" rather than
6427 "GPLv2+".
6428
6429 <emphasis>libgfortran</emphasis>: Set license to "GPL-3.0-with-GCC-exception".
6430
6431 <emphasis>elfutils</emphasis>: Removed "Elfutils-Exception" and set to "GPLv2" for shared
6432 libraries
6433 </literallayout>
6434 </para>
6435 </section>
6436
6437 <section id='migration-2.7-packaging-changes'>
6438 <title>Packaging Changes</title>
6439
6440 <para>
6441 This section provides information about packaging changes.
6442 <itemizedlist>
6443 <listitem><para>
6444 <filename>bind</filename>: The
6445 <filename>nsupdate</filename> binary has been moved to
6446 the <filename>bind-utils</filename> package.
6447 </para></listitem>
6448 <listitem><para>
6449 Debug split: The default debug split has been changed to
6450 create separate source packages (i.e.
6451 <replaceable>package_name</replaceable><filename>-dbg</filename>
6452 and
6453 <replaceable>package_name</replaceable><filename>-src</filename>).
6454 If you are currently using <filename>dbg-pkgs</filename>
6455 in
6456 <link linkend='var-IMAGE_FEATURES'><filename>IMAGE_FEATURES</filename></link>
6457 to bring in debug symbols and you still need the sources,
6458 you must now also add <filename>src-pkgs</filename> to
6459 <filename>IMAGE_FEATURES</filename>.
6460 Source packages remain in the target portion of the SDK
6461 by default, unless you have set your own value for
6462 <link linkend='var-SDKIMAGE_FEATURES'><filename>SDKIMAGE_FEATURES</filename></link>
6463 that does not include <filename>src-pkgs</filename>.
6464 </para></listitem>
6465 <listitem><para>
6466 Mount all using <filename>util-linux</filename>:
6467 <filename>/etc/default/mountall</filename> has
6468 moved into the -mount sub-package.
6469 </para></listitem>
6470 <listitem><para>
6471 Splitting binaries using <filename>util-linux</filename>:
6472 <filename>util-linux</filename> now splits each binary into
6473 its own package for fine-grained control.
6474 The main <filename>util-linux</filename> package pulls in
6475 the individual binary packages using the
6476 <link linkend='var-RRECOMMENDS'><filename>RRECOMMENDS</filename></link>
6477 and
6478 <link linkend='var-RDEPENDS'><filename>RDEPENDS</filename></link>
6479 variables.
6480 As a result, existing images should not see any changes
6481 assuming
6482 <link linkend='var-NO_RECOMMENDATIONS'><filename>NO_RECOMMENDATIONS</filename></link>
6483 is not set.
6484 </para></listitem>
6485 <listitem><para>
6486 <filename>netbase/base-files</filename>:
6487 <filename>/etc/hosts</filename> has moved from
6488 <filename>netbase</filename> to
6489 <filename>base-files</filename>.
6490 </para></listitem>
6491 <listitem><para>
6492 <filename>tzdata</filename>: The main package has been
6493 converted to an empty meta package that pulls in all
6494 <filename>tzdata</filename> packages by default.
6495 </para></listitem>
6496 <listitem><para>
6497 <filename>lrzsz</filename>: This package has been removed
6498 from <filename>packagegroup-self-hosted</filename> and
6499 <filename>packagegroup-core-tools-testapps</filename>.
6500 The X/Y/ZModem support is less likely to be needed on
6501 modern systems.
6502 If you are relying on these packagegroups to include the
6503 <filename>lrzsz</filename> package in your image, you
6504 now need to explicitly add the package.
6505 </para></listitem>
6506 </itemizedlist>
6507 </para>
6508 </section>
6509
6510 <section id='migration-2.7-removed-recipes'>
6511 <title>Removed Recipes</title>
6512
6513 <para>
6514 The following recipes have been removed:
6515 <literallayout class='monospaced'>
6516 <emphasis>gcc</emphasis>: Drop version 7.3 recipes. Version 8.3 now remains.
6517
6518 <emphasis>linux-yocto</emphasis>: Drop versions 4.14 and 4.18 recipes. Versions 4.19 and 5.0 remain.
6519
6520 <emphasis>go</emphasis>: Drop version 1.9 recipes. Versions 1.11 and 1.12 remain.
6521
6522 <emphasis>xvideo-tests</emphasis>: Became obsolete.
6523
6524 <emphasis>libart-lgpl</emphasis>: Became obsolete.
6525
6526 <emphasis>gtk-icon-utils-native</emphasis>: These tools are now provided by gtk+3-native
6527
6528 <emphasis>gcc-cross-initial</emphasis>: No longer needed. gcc-cross/gcc-crosssdk is now used instead.
6529
6530 <emphasis>gcc-crosssdk-initial</emphasis>: No longer needed. gcc-cross/gcc-crosssdk is now used instead.
6531
6532 <emphasis>glibc-initial</emphasis>: Removed because the benefits of having it for site_config are
6533 currently outweighed by the cost of building the recipe.
6534 </literallayout>
6535 </para>
6536 </section>
6537
6538 <section id='migration-2.7-removed-classes'>
6539 <title>Removed Classes</title>
6540
6541 <para>
6542 The following classes have been removed:
6543 <literallayout class='monospaced'>
6544 <emphasis>distutils-tools</emphasis>: This class was never used.
6545
6546 <emphasis>bugzilla.bbclass</emphasis>: Became obsolete.
6547
6548 <emphasis>distrodata</emphasis>: This functionally has been replaced by a more modern
6549 tinfoil-based implementation.
6550 </literallayout>
6551 </para>
6552 </section>
6553
6554 <section id='migration-2.7-miscellaneous-changes'>
6555 <title>Miscellaneous Changes</title>
6556
6557 <para>
6558 The following miscellaneous changes occurred:
6559 <itemizedlist>
6560 <listitem><para>
6561 The <filename>distro</filename> subdirectory of the Poky
6562 repository has been removed from the top-level
6563 <filename>scripts</filename> directory.
6564 </para></listitem>
6565 <listitem><para>
6566 Perl now builds for the target using
6567 <ulink url='http://arsv.github.io/perl-cross/'><filename>perl-cross</filename></ulink>
6568 for better maintainability and improved build performance.
6569 This change should not present any problems unless you have
6570 heavily customized your Perl recipe.
6571 </para></listitem>
6572 <listitem><para>
6573 <filename>arm-tunes</filename>: Removed the "-march"
6574 option if mcpu is already added.
6575 </para></listitem>
6576 <listitem><para>
6577 <filename>update-alternatives</filename>: Convert file
6578 renames to
6579 <link linkend='var-PACKAGE_PREPROCESS_FUNCS'><filename>PACKAGE_PREPROCESS_FUNCS</filename></link>
6580 </para></listitem>
6581 <listitem><para>
6582 <filename>base/pixbufcache</filename>: Obsolete
6583 <filename>sstatecompletions</filename> code has been
6584 removed.
6585 </para></listitem>
6586 <listitem><para>
6587 <link linkend='ref-classes-native'><filename>native</filename></link>
6588 class:
6589 <link linkend='var-RDEPENDS'><filename>RDEPENDS</filename></link>
6590 handling has been enabled.
6591 </para></listitem>
6592 <listitem><para>
6593 <filename>inetutils</filename>: This recipe has rsh
6594 disabled.
6595 </para></listitem>
6596 </itemizedlist>
6597 </para>
6598 </section>
6599</section>
Patrick Williamsc124f4f2015-09-15 14:41:29 -05006600</chapter>
6601<!--
6602vim: expandtab tw=80 ts=4
6603-->