diff options
author | Richard Purdie <richard.purdie@linuxfoundation.org> | 2020-09-15 23:00:15 +0100 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2020-09-17 10:09:35 +0100 |
commit | dd8c9b74d3b46aed6d1315af83769ff29109b65a (patch) | |
tree | 075ae3b1c81896476e752a944796071f1b8e18bb /documentation/ref-manual/migration-1.4.rst | |
parent | 1c9db6ef7f239dc097ee4d9ef6922d93c3c3c711 (diff) | |
download | poky-dd8c9b74d3b46aed6d1315af83769ff29109b65a.tar.gz |
sphinx: ref-manual/migration: Split each release into its own file
This avoids the duplicate heading warnings at the slight expense
of more directory clutter.
(From yocto-docs rev: ef896d71836aa3bd6c926b36976a9c45d5f2ca15)
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/ref-manual/migration-1.4.rst')
-rw-r--r-- | documentation/ref-manual/migration-1.4.rst | 237 |
1 files changed, 237 insertions, 0 deletions
diff --git a/documentation/ref-manual/migration-1.4.rst b/documentation/ref-manual/migration-1.4.rst new file mode 100644 index 0000000000..a658bdff68 --- /dev/null +++ b/documentation/ref-manual/migration-1.4.rst | |||
@@ -0,0 +1,237 @@ | |||
1 | Moving to the Yocto Project 1.4 Release | ||
2 | ======================================= | ||
3 | |||
4 | This section provides migration information for moving to the Yocto | ||
5 | Project 1.4 Release from the prior release. | ||
6 | |||
7 | .. _migration-1.4-bitbake: | ||
8 | |||
9 | BitBake | ||
10 | ------- | ||
11 | |||
12 | Differences include the following: | ||
13 | |||
14 | - *Comment Continuation:* If a comment ends with a line continuation | ||
15 | (\) character, then the next line must also be a comment. Any | ||
16 | instance where this is not the case, now triggers a warning. You must | ||
17 | either remove the continuation character, or be sure the next line is | ||
18 | a comment. | ||
19 | |||
20 | - *Package Name Overrides:* The runtime package specific variables | ||
21 | :term:`RDEPENDS`, | ||
22 | :term:`RRECOMMENDS`, | ||
23 | :term:`RSUGGESTS`, | ||
24 | :term:`RPROVIDES`, | ||
25 | :term:`RCONFLICTS`, | ||
26 | :term:`RREPLACES`, :term:`FILES`, | ||
27 | :term:`ALLOW_EMPTY`, and the pre, post, install, | ||
28 | and uninstall script functions ``pkg_preinst``, ``pkg_postinst``, | ||
29 | ``pkg_prerm``, and ``pkg_postrm`` should always have a package name | ||
30 | override. For example, use ``RDEPENDS_${PN}`` for the main package | ||
31 | instead of ``RDEPENDS``. BitBake uses more strict checks when it | ||
32 | parses recipes. | ||
33 | |||
34 | .. _migration-1.4-build-behavior: | ||
35 | |||
36 | Build Behavior | ||
37 | -------------- | ||
38 | |||
39 | Differences include the following: | ||
40 | |||
41 | - *Shared State Code:* The shared state code has been optimized to | ||
42 | avoid running unnecessary tasks. For example, the following no longer | ||
43 | populates the target sysroot since that is not necessary: | ||
44 | :: | ||
45 | |||
46 | $ bitbake -c rootfs some-image | ||
47 | |||
48 | Instead, the system just needs to extract the | ||
49 | output package contents, re-create the packages, and construct the | ||
50 | root filesystem. This change is unlikely to cause any problems unless | ||
51 | you have missing declared dependencies. | ||
52 | |||
53 | - *Scanning Directory Names:* When scanning for files in | ||
54 | :term:`SRC_URI`, the build system now uses | ||
55 | :term:`FILESOVERRIDES` instead of | ||
56 | :term:`OVERRIDES` for the directory names. In | ||
57 | general, the values previously in ``OVERRIDES`` are now in | ||
58 | ``FILESOVERRIDES`` as well. However, if you relied upon an additional | ||
59 | value you previously added to ``OVERRIDES``, you might now need to | ||
60 | add it to ``FILESOVERRIDES`` unless you are already adding it through | ||
61 | the :term:`MACHINEOVERRIDES` or | ||
62 | :term:`DISTROOVERRIDES` variables, as | ||
63 | appropriate. For more related changes, see the | ||
64 | "`Variables <#migration-1.4-variables>`__" section. | ||
65 | |||
66 | .. _migration-1.4-proxies-and-fetching-source: | ||
67 | |||
68 | Proxies and Fetching Source | ||
69 | --------------------------- | ||
70 | |||
71 | A new ``oe-git-proxy`` script has been added to replace previous methods | ||
72 | of handling proxies and fetching source from Git. See the | ||
73 | ``meta-yocto/conf/site.conf.sample`` file for information on how to use | ||
74 | this script. | ||
75 | |||
76 | .. _migration-1.4-custom-interfaces-file-netbase-change: | ||
77 | |||
78 | Custom Interfaces File (netbase change) | ||
79 | --------------------------------------- | ||
80 | |||
81 | If you have created your own custom ``etc/network/interfaces`` file by | ||
82 | creating an append file for the ``netbase`` recipe, you now need to | ||
83 | create an append file for the ``init-ifupdown`` recipe instead, which | ||
84 | you can find in the :term:`Source Directory` at | ||
85 | ``meta/recipes-core/init-ifupdown``. For information on how to use | ||
86 | append files, see the | ||
87 | ":ref:`dev-manual/dev-manual-common-tasks:using .bbappend files in your layer`" | ||
88 | section in the Yocto Project Development Tasks Manual. | ||
89 | |||
90 | .. _migration-1.4-remote-debugging: | ||
91 | |||
92 | Remote Debugging | ||
93 | ---------------- | ||
94 | |||
95 | Support for remote debugging with the Eclipse IDE is now separated into | ||
96 | an image feature (``eclipse-debug``) that corresponds to the | ||
97 | ``packagegroup-core-eclipse-debug`` package group. Previously, the | ||
98 | debugging feature was included through the ``tools-debug`` image | ||
99 | feature, which corresponds to the ``packagegroup-core-tools-debug`` | ||
100 | package group. | ||
101 | |||
102 | .. _migration-1.4-variables: | ||
103 | |||
104 | Variables | ||
105 | --------- | ||
106 | |||
107 | The following variables have changed: | ||
108 | |||
109 | - ``SANITY_TESTED_DISTROS``: This variable now uses a distribution | ||
110 | ID, which is composed of the host distributor ID followed by the | ||
111 | release. Previously, | ||
112 | :term:`SANITY_TESTED_DISTROS` was | ||
113 | composed of the description field. For example, "Ubuntu 12.10" | ||
114 | becomes "Ubuntu-12.10". You do not need to worry about this change if | ||
115 | you are not specifically setting this variable, or if you are | ||
116 | specifically setting it to "". | ||
117 | |||
118 | - ``SRC_URI``: The ``${``\ :term:`PN`\ ``}``, | ||
119 | ``${``\ :term:`PF`\ ``}``, | ||
120 | ``${``\ :term:`P`\ ``}``, and ``FILE_DIRNAME`` directories | ||
121 | have been dropped from the default value of the | ||
122 | :term:`FILESPATH` variable, which is used as the | ||
123 | search path for finding files referred to in | ||
124 | :term:`SRC_URI`. If you have a recipe that relied upon | ||
125 | these directories, which would be unusual, then you will need to add | ||
126 | the appropriate paths within the recipe or, alternatively, rearrange | ||
127 | the files. The most common locations are still covered by ``${BP}``, | ||
128 | ``${BPN}``, and "files", which all remain in the default value of | ||
129 | :term:`FILESPATH`. | ||
130 | |||
131 | .. _migration-target-package-management-with-rpm: | ||
132 | |||
133 | Target Package Management with RPM | ||
134 | ---------------------------------- | ||
135 | |||
136 | If runtime package management is enabled and the RPM backend is | ||
137 | selected, Smart is now installed for package download, dependency | ||
138 | resolution, and upgrades instead of Zypper. For more information on how | ||
139 | to use Smart, run the following command on the target: | ||
140 | :: | ||
141 | |||
142 | smart --help | ||
143 | |||
144 | .. _migration-1.4-recipes-moved: | ||
145 | |||
146 | Recipes Moved | ||
147 | ------------- | ||
148 | |||
149 | The following recipes were moved from their previous locations because | ||
150 | they are no longer used by anything in the OpenEmbedded-Core: | ||
151 | |||
152 | - ``clutter-box2d``: Now resides in the ``meta-oe`` layer. | ||
153 | |||
154 | - ``evolution-data-server``: Now resides in the ``meta-gnome`` layer. | ||
155 | |||
156 | - ``gthumb``: Now resides in the ``meta-gnome`` layer. | ||
157 | |||
158 | - ``gtkhtml2``: Now resides in the ``meta-oe`` layer. | ||
159 | |||
160 | - ``gupnp``: Now resides in the ``meta-multimedia`` layer. | ||
161 | |||
162 | - ``gypsy``: Now resides in the ``meta-oe`` layer. | ||
163 | |||
164 | - ``libcanberra``: Now resides in the ``meta-gnome`` layer. | ||
165 | |||
166 | - ``libgdata``: Now resides in the ``meta-gnome`` layer. | ||
167 | |||
168 | - ``libmusicbrainz``: Now resides in the ``meta-multimedia`` layer. | ||
169 | |||
170 | - ``metacity``: Now resides in the ``meta-gnome`` layer. | ||
171 | |||
172 | - ``polkit``: Now resides in the ``meta-oe`` layer. | ||
173 | |||
174 | - ``zeroconf``: Now resides in the ``meta-networking`` layer. | ||
175 | |||
176 | .. _migration-1.4-removals-and-renames: | ||
177 | |||
178 | Removals and Renames | ||
179 | -------------------- | ||
180 | |||
181 | The following list shows what has been removed or renamed: | ||
182 | |||
183 | - ``evieext``: Removed because it has been removed from ``xserver`` | ||
184 | since 2008. | ||
185 | |||
186 | - *Gtk+ DirectFB:* Removed support because upstream Gtk+ no longer | ||
187 | supports it as of version 2.18. | ||
188 | |||
189 | - ``libxfontcache / xfontcacheproto``: Removed because they were | ||
190 | removed from the Xorg server in 2008. | ||
191 | |||
192 | - ``libxp / libxprintapputil / libxprintutil / printproto``: Removed | ||
193 | because the XPrint server was removed from Xorg in 2008. | ||
194 | |||
195 | - ``libxtrap / xtrapproto``: Removed because their functionality was | ||
196 | broken upstream. | ||
197 | |||
198 | - *linux-yocto 3.0 kernel:* Removed with linux-yocto 3.8 kernel being | ||
199 | added. The linux-yocto 3.2 and linux-yocto 3.4 kernels remain as part | ||
200 | of the release. | ||
201 | |||
202 | - ``lsbsetup``: Removed with functionality now provided by | ||
203 | ``lsbtest``. | ||
204 | |||
205 | - ``matchbox-stroke``: Removed because it was never more than a | ||
206 | proof-of-concept. | ||
207 | |||
208 | - ``matchbox-wm-2 / matchbox-theme-sato-2``: Removed because they are | ||
209 | not maintained. However, ``matchbox-wm`` and ``matchbox-theme-sato`` | ||
210 | are still provided. | ||
211 | |||
212 | - ``mesa-dri``: Renamed to ``mesa``. | ||
213 | |||
214 | - ``mesa-xlib``: Removed because it was no longer useful. | ||
215 | |||
216 | - ``mutter``: Removed because nothing ever uses it and the recipe is | ||
217 | very old. | ||
218 | |||
219 | - ``orinoco-conf``: Removed because it has become obsolete. | ||
220 | |||
221 | - ``update-modules``: Removed because it is no longer used. The | ||
222 | kernel module ``postinstall`` and ``postrm`` scripts can now do the | ||
223 | same task without the use of this script. | ||
224 | |||
225 | - ``web``: Removed because it is not maintained. Superseded by | ||
226 | ``web-webkit``. | ||
227 | |||
228 | - ``xf86bigfontproto``: Removed because upstream it has been disabled | ||
229 | by default since 2007. Nothing uses ``xf86bigfontproto``. | ||
230 | |||
231 | - ``xf86rushproto``: Removed because its dependency in ``xserver`` | ||
232 | was spurious and it was removed in 2005. | ||
233 | |||
234 | - ``zypper / libzypp / sat-solver``: Removed and been functionally | ||
235 | replaced with Smart (``python-smartpm``) when RPM packaging is used | ||
236 | and package management is enabled on the target. | ||
237 | |||