diff options
author | Michael Opdenacker <michael.opdenacker@bootlin.com> | 2022-09-23 14:30:56 +0200 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2022-10-07 10:54:25 +0100 |
commit | 9dbd27a48aec4aaf235af91a3b7397725b644463 (patch) | |
tree | 59eceecd9bc147f56af607431082264807ea0068 /documentation/migration-guides | |
parent | c3c7344826231d1b2c009dbb317d2373bbdf9ff3 (diff) | |
download | poky-9dbd27a48aec4aaf235af91a3b7397725b644463.tar.gz |
manuals: improve initramfs details
- Create a new entry in the glossary
- Add implementation details
- Replace the mention of "init ramdisk" by "initramfs¨
whenever possible
- Remove obsolete and duplicate information
- Fix spacing issues in the Sphinx code
(From yocto-docs rev: 952c7e6dee49532705b2c162f4728e635c38df3f)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/migration-guides')
4 files changed, 9 insertions, 9 deletions
diff --git a/documentation/migration-guides/migration-2.4.rst b/documentation/migration-guides/migration-2.4.rst index 964ed92937..8904495022 100644 --- a/documentation/migration-guides/migration-2.4.rst +++ b/documentation/migration-guides/migration-2.4.rst | |||
@@ -54,7 +54,7 @@ occurred: | |||
54 | when "pam" is in :term:`DISTRO_FEATURES`. | 54 | when "pam" is in :term:`DISTRO_FEATURES`. |
55 | 55 | ||
56 | - The ``switch_root`` program is now packaged in a separate | 56 | - The ``switch_root`` program is now packaged in a separate |
57 | "util-linux-switch-root" package for small initramfs images that | 57 | "util-linux-switch-root" package for small :term:`Initramfs` images that |
58 | do not need the whole ``util-linux`` package or the busybox | 58 | do not need the whole ``util-linux`` package or the busybox |
59 | binary, which are both much larger than ``switch_root``. The main | 59 | binary, which are both much larger than ``switch_root``. The main |
60 | ``util-linux`` package has a recommended runtime dependency (i.e. | 60 | ``util-linux`` package has a recommended runtime dependency (i.e. |
diff --git a/documentation/migration-guides/migration-3.2.rst b/documentation/migration-guides/migration-3.2.rst index 92b7f91f2c..cc6f05322a 100644 --- a/documentation/migration-guides/migration-3.2.rst +++ b/documentation/migration-guides/migration-3.2.rst | |||
@@ -265,10 +265,10 @@ using the GL options. | |||
265 | 265 | ||
266 | .. _migration-3.2-initramfs-suffix: | 266 | .. _migration-3.2-initramfs-suffix: |
267 | 267 | ||
268 | initramfs images now use a blank suffix | 268 | Initramfs images now use a blank suffix |
269 | --------------------------------------- | 269 | --------------------------------------- |
270 | 270 | ||
271 | The reference initramfs images (``core-image-minimal-initramfs``, | 271 | The reference :term:`Initramfs` images (``core-image-minimal-initramfs``, |
272 | ``core-image-tiny-initramfs`` and ``core-image-testmaster-initramfs``) now | 272 | ``core-image-tiny-initramfs`` and ``core-image-testmaster-initramfs``) now |
273 | set an empty string for :term:`IMAGE_NAME_SUFFIX`, which otherwise defaults | 273 | set an empty string for :term:`IMAGE_NAME_SUFFIX`, which otherwise defaults |
274 | to ``".rootfs"``. These images aren't root filesystems and thus the rootfs | 274 | to ``".rootfs"``. These images aren't root filesystems and thus the rootfs |
diff --git a/documentation/migration-guides/release-notes-3.4.rst b/documentation/migration-guides/release-notes-3.4.rst index 323e4df7ae..4319bf119d 100644 --- a/documentation/migration-guides/release-notes-3.4.rst +++ b/documentation/migration-guides/release-notes-3.4.rst | |||
@@ -36,7 +36,7 @@ New Features / Enhancements in 3.4 | |||
36 | 36 | ||
37 | - Kernel-related enhancements: | 37 | - Kernel-related enhancements: |
38 | 38 | ||
39 | - Support zstd-compressed modules and initramfs images | 39 | - Support zstd-compressed modules and :term:`Initramfs` images |
40 | - Allow opt-out of split kernel modules | 40 | - Allow opt-out of split kernel modules |
41 | - linux-yocto-dev: base AUTOREV on specified version | 41 | - linux-yocto-dev: base AUTOREV on specified version |
42 | - kernel-yocto: provide debug / summary information for metadata | 42 | - kernel-yocto: provide debug / summary information for metadata |
@@ -211,7 +211,7 @@ The following corrections have been made to the LICENSE values set by recipes: | |||
211 | Other license-related notes: | 211 | Other license-related notes: |
212 | 212 | ||
213 | - When creating recipes for Python software, recipetool will now treat "BSD" as "BSD-3-Clause" for the purposes of setting LICENSE, as that is the most common understanding. | 213 | - When creating recipes for Python software, recipetool will now treat "BSD" as "BSD-3-Clause" for the purposes of setting LICENSE, as that is the most common understanding. |
214 | - Please be aware that an initramfs bundled with the kernel using :term:`INITRAMFS_IMAGE_BUNDLE` should only contain GPLv2-compatible software; this is now mentioned in the documentation. | 214 | - Please be aware that an :term:`Initramfs` bundled with the kernel using :term:`INITRAMFS_IMAGE_BUNDLE` should only contain GPLv2-compatible software; this is now mentioned in the documentation. |
215 | 215 | ||
216 | Security Fixes in 3.4 | 216 | Security Fixes in 3.4 |
217 | ~~~~~~~~~~~~~~~~~~~~~ | 217 | ~~~~~~~~~~~~~~~~~~~~~ |
diff --git a/documentation/migration-guides/release-notes-4.0.rst b/documentation/migration-guides/release-notes-4.0.rst index b675cae217..a61ccc6913 100644 --- a/documentation/migration-guides/release-notes-4.0.rst +++ b/documentation/migration-guides/release-notes-4.0.rst | |||
@@ -30,7 +30,7 @@ New Features / Enhancements in 4.0 | |||
30 | 30 | ||
31 | - New :ref:`overlayfs <ref-classes-overlayfs>` and | 31 | - New :ref:`overlayfs <ref-classes-overlayfs>` and |
32 | :ref:`overlayfs-etc <ref-classes-overlayfs-etc>` classes and | 32 | :ref:`overlayfs-etc <ref-classes-overlayfs-etc>` classes and |
33 | ``overlayroot`` support in the initramfs framework to make it easier to | 33 | ``overlayroot`` support in the :term:`Initramfs` framework to make it easier to |
34 | overlay read-only filesystems (for example) with | 34 | overlay read-only filesystems (for example) with |
35 | `OverlayFS <https://en.wikipedia.org/wiki/OverlayFS>`__. | 35 | `OverlayFS <https://en.wikipedia.org/wiki/OverlayFS>`__. |
36 | 36 | ||
@@ -168,7 +168,7 @@ New Features / Enhancements in 4.0 | |||
168 | 168 | ||
169 | - Kernel-related enhancements: | 169 | - Kernel-related enhancements: |
170 | 170 | ||
171 | - Allow initramfs to be built from a separate multiconfig | 171 | - Allow :term:`Initramfs` to be built from a separate multiconfig |
172 | - Make kernel-base recommend kernel-image, not depend (allowing images containing kernel modules without kernel image) | 172 | - Make kernel-base recommend kernel-image, not depend (allowing images containing kernel modules without kernel image) |
173 | - linux-yocto: split vtpm for more granular inclusion | 173 | - linux-yocto: split vtpm for more granular inclusion |
174 | - linux-yocto: cfg/debug: add configs for kcsan | 174 | - linux-yocto: cfg/debug: add configs for kcsan |
@@ -182,7 +182,7 @@ New Features / Enhancements in 4.0 | |||
182 | 182 | ||
183 | - FIT image related enhancements: | 183 | - FIT image related enhancements: |
184 | 184 | ||
185 | - New ``FIT_SUPPORTED_INITRAMFS_FSTYPES`` variable to allow extending initramfs image types to look for | 185 | - New ``FIT_SUPPORTED_INITRAMFS_FSTYPES`` variable to allow extending :term:`Initramfs` image types to look for |
186 | - New ``FIT_CONF_PREFIX`` variable to allow overriding FIT configuration prefix | 186 | - New ``FIT_CONF_PREFIX`` variable to allow overriding FIT configuration prefix |
187 | - Use 'bbnote' for better logging | 187 | - Use 'bbnote' for better logging |
188 | 188 | ||
@@ -276,7 +276,7 @@ New Features / Enhancements in 4.0 | |||
276 | - volatile-binds: SELinux and overlayfs extensions in mount-copybind | 276 | - volatile-binds: SELinux and overlayfs extensions in mount-copybind |
277 | - gtk-icon-cache: Allow using gtk4 | 277 | - gtk-icon-cache: Allow using gtk4 |
278 | - kmod: Add an exclude directive to depmod | 278 | - kmod: Add an exclude directive to depmod |
279 | - os-release: add os-release-initrd package for use in systemd-based initramfs images | 279 | - os-release: add os-release-initrd package for use in systemd-based :term:`Initramfs` images |
280 | - gstreamer1.0-plugins-base: add support for graphene | 280 | - gstreamer1.0-plugins-base: add support for graphene |
281 | - gpg-sign: Add parameters to gpg signature function | 281 | - gpg-sign: Add parameters to gpg signature function |
282 | - package_manager: sign DEB package feeds | 282 | - package_manager: sign DEB package feeds |