diff options
-rw-r--r-- | documentation/dev-manual/common-tasks.rst | 9 | ||||
-rw-r--r-- | documentation/kernel-dev/faq.rst | 4 | ||||
-rw-r--r-- | documentation/migration-guides/migration-2.2.rst | 2 | ||||
-rw-r--r-- | documentation/migration-guides/migration-2.5.rst | 2 | ||||
-rw-r--r-- | documentation/migration-guides/migration-2.6.rst | 2 | ||||
-rw-r--r-- | documentation/profile-manual/usage.rst | 2 | ||||
-rw-r--r-- | documentation/ref-manual/classes.rst | 10 | ||||
-rw-r--r-- | documentation/ref-manual/kickstart.rst | 4 | ||||
-rw-r--r-- | documentation/ref-manual/variables.rst | 2 | ||||
-rw-r--r-- | documentation/what-i-wish-id-known.rst | 2 |
10 files changed, 20 insertions, 19 deletions
diff --git a/documentation/dev-manual/common-tasks.rst b/documentation/dev-manual/common-tasks.rst index f7d82ba191..9d0c8f33d4 100644 --- a/documentation/dev-manual/common-tasks.rst +++ b/documentation/dev-manual/common-tasks.rst | |||
@@ -2243,12 +2243,13 @@ error during the | |||
2243 | 2243 | ||
2244 | If you have recipes that use ``pkg_postinst`` function and they require | 2244 | If you have recipes that use ``pkg_postinst`` function and they require |
2245 | the use of non-standard native tools that have dependencies during | 2245 | the use of non-standard native tools that have dependencies during |
2246 | rootfs construction, you need to use the | 2246 | root filesystem construction, you need to use the |
2247 | :term:`PACKAGE_WRITE_DEPS` | 2247 | :term:`PACKAGE_WRITE_DEPS` |
2248 | variable in your recipe to list these tools. If you do not use this | 2248 | variable in your recipe to list these tools. If you do not use this |
2249 | variable, the tools might be missing and execution of the | 2249 | variable, the tools might be missing and execution of the |
2250 | post-installation script is deferred until first boot. Deferring the | 2250 | post-installation script is deferred until first boot. Deferring the |
2251 | script to first boot is undesirable and for read-only rootfs impossible. | 2251 | script to the first boot is undesirable and impossible for read-only |
2252 | root filesystems. | ||
2252 | 2253 | ||
2253 | .. note:: | 2254 | .. note:: |
2254 | 2255 | ||
@@ -8487,14 +8488,14 @@ perform a one-time setup of your controller image by doing the following: | |||
8487 | 8488 | ||
8488 | - Uses a custom Initial RAM Disk (initramfs) image with a custom | 8489 | - Uses a custom Initial RAM Disk (initramfs) image with a custom |
8489 | installer. A normal image that you can install usually creates a | 8490 | installer. A normal image that you can install usually creates a |
8490 | single rootfs partition. This image uses another installer that | 8491 | single root filesystem partition. This image uses another installer that |
8491 | creates a specific partition layout. Not all Board Support | 8492 | creates a specific partition layout. Not all Board Support |
8492 | Packages (BSPs) can use an installer. For such cases, you need to | 8493 | Packages (BSPs) can use an installer. For such cases, you need to |
8493 | manually create the following partition layout on the target: | 8494 | manually create the following partition layout on the target: |
8494 | 8495 | ||
8495 | - First partition mounted under ``/boot``, labeled "boot". | 8496 | - First partition mounted under ``/boot``, labeled "boot". |
8496 | 8497 | ||
8497 | - The main rootfs partition where this image gets installed, | 8498 | - The main root filesystem partition where this image gets installed, |
8498 | which is mounted under ``/``. | 8499 | which is mounted under ``/``. |
8499 | 8500 | ||
8500 | - Another partition labeled "testrootfs" where test images get | 8501 | - Another partition labeled "testrootfs" where test images get |
diff --git a/documentation/kernel-dev/faq.rst b/documentation/kernel-dev/faq.rst index 5aa702ad69..e40e3ff372 100644 --- a/documentation/kernel-dev/faq.rst +++ b/documentation/kernel-dev/faq.rst | |||
@@ -30,8 +30,8 @@ Refer to the | |||
30 | ":ref:`kernel-dev/common:working with your own sources`" | 30 | ":ref:`kernel-dev/common:working with your own sources`" |
31 | section for information. | 31 | section for information. |
32 | 32 | ||
33 | How do I install/not-install the kernel image on the rootfs? | 33 | How do I install/not-install the kernel image on the root filesystem? |
34 | ------------------------------------------------------------ | 34 | --------------------------------------------------------------------- |
35 | 35 | ||
36 | The kernel image (e.g. ``vmlinuz``) is provided by the | 36 | The kernel image (e.g. ``vmlinuz``) is provided by the |
37 | ``kernel-image`` package. Image recipes depend on ``kernel-base``. To | 37 | ``kernel-image`` package. Image recipes depend on ``kernel-base``. To |
diff --git a/documentation/migration-guides/migration-2.2.rst b/documentation/migration-guides/migration-2.2.rst index c063deb44b..a6c1a4aa48 100644 --- a/documentation/migration-guides/migration-2.2.rst +++ b/documentation/migration-guides/migration-2.2.rst | |||
@@ -154,7 +154,7 @@ enables fine-grained tuning of options passed to QEMU without the | |||
154 | Using a configuration file is particularly convenient when trying to use | 154 | Using a configuration file is particularly convenient when trying to use |
155 | QEMU with machines other than the ``qemu*`` machines in | 155 | QEMU with machines other than the ``qemu*`` machines in |
156 | :term:`OpenEmbedded-Core (OE-Core)`. The ``qemuboot.conf`` file is generated by the | 156 | :term:`OpenEmbedded-Core (OE-Core)`. The ``qemuboot.conf`` file is generated by the |
157 | ``qemuboot`` class when the root filesystem is being build (i.e. build | 157 | ``qemuboot`` class when the root filesystem is being built (i.e. build |
158 | rootfs). QEMU boot arguments can be set in BSP's configuration file and | 158 | rootfs). QEMU boot arguments can be set in BSP's configuration file and |
159 | the ``qemuboot`` class will save them to ``qemuboot.conf``. | 159 | the ``qemuboot`` class will save them to ``qemuboot.conf``. |
160 | 160 | ||
diff --git a/documentation/migration-guides/migration-2.5.rst b/documentation/migration-guides/migration-2.5.rst index bd75522773..abd26809df 100644 --- a/documentation/migration-guides/migration-2.5.rst +++ b/documentation/migration-guides/migration-2.5.rst | |||
@@ -287,7 +287,7 @@ The following are additional changes: | |||
287 | 287 | ||
288 | - For EFI-based machines, the bootloader (``grub-efi`` by default) is | 288 | - For EFI-based machines, the bootloader (``grub-efi`` by default) is |
289 | installed into the image at /boot. Wic can be used to split the | 289 | installed into the image at /boot. Wic can be used to split the |
290 | bootloader into separate boot and rootfs partitions if necessary. | 290 | bootloader into separate boot and root filesystem partitions if necessary. |
291 | 291 | ||
292 | - Patches whose context does not match exactly (i.e. where patch | 292 | - Patches whose context does not match exactly (i.e. where patch |
293 | reports "fuzz" when applying) will generate a warning. For an example | 293 | reports "fuzz" when applying) will generate a warning. For an example |
diff --git a/documentation/migration-guides/migration-2.6.rst b/documentation/migration-guides/migration-2.6.rst index a8c56ede72..c68414e1ca 100644 --- a/documentation/migration-guides/migration-2.6.rst +++ b/documentation/migration-guides/migration-2.6.rst | |||
@@ -363,7 +363,7 @@ Post Installation Changes | |||
363 | 363 | ||
364 | You must explicitly mark post installs to defer to the target. If you | 364 | You must explicitly mark post installs to defer to the target. If you |
365 | want to explicitly defer a postinstall to first boot on the target | 365 | want to explicitly defer a postinstall to first boot on the target |
366 | rather than at rootfs creation time, use ``pkg_postinst_ontarget()`` or | 366 | rather than at root filesystem creation time, use ``pkg_postinst_ontarget()`` or |
367 | call ``postinst_intercept delay_to_first_boot`` from ``pkg_postinst()``. | 367 | call ``postinst_intercept delay_to_first_boot`` from ``pkg_postinst()``. |
368 | Any failure of a ``pkg_postinst()`` script (including exit 1) triggers | 368 | Any failure of a ``pkg_postinst()`` script (including exit 1) triggers |
369 | an error during the :ref:`ref-tasks-rootfs` task. | 369 | an error during the :ref:`ref-tasks-rootfs` task. |
diff --git a/documentation/profile-manual/usage.rst b/documentation/profile-manual/usage.rst index 3d2840884f..56f1e66674 100644 --- a/documentation/profile-manual/usage.rst +++ b/documentation/profile-manual/usage.rst | |||
@@ -2138,7 +2138,7 @@ For LTTng userspace tracing, you need to have a properly instrumented | |||
2138 | userspace program. For this example, we'll use the 'hello' test program | 2138 | userspace program. For this example, we'll use the 'hello' test program |
2139 | generated by the lttng-ust build. | 2139 | generated by the lttng-ust build. |
2140 | 2140 | ||
2141 | The 'hello' test program isn't installed on the rootfs by the lttng-ust | 2141 | The 'hello' test program isn't installed on the root filesystem by the lttng-ust |
2142 | build, so we need to copy it over manually. First cd into the build | 2142 | build, so we need to copy it over manually. First cd into the build |
2143 | directory that contains the hello executable:: | 2143 | directory that contains the hello executable:: |
2144 | 2144 | ||
diff --git a/documentation/ref-manual/classes.rst b/documentation/ref-manual/classes.rst index e70c7d9013..99d9a7a3e7 100644 --- a/documentation/ref-manual/classes.rst +++ b/documentation/ref-manual/classes.rst | |||
@@ -1362,9 +1362,9 @@ is set to 0. | |||
1362 | 1362 | ||
1363 | Only a single Initramfs bundle can be added to the FIT image created by | 1363 | Only a single Initramfs bundle can be added to the FIT image created by |
1364 | ``kernel-fitimage`` and the Initramfs bundle in FIT is optional. | 1364 | ``kernel-fitimage`` and the Initramfs bundle in FIT is optional. |
1365 | In case of Initramfs, the kernel is configured to be bundled with the rootfs | 1365 | In case of Initramfs, the kernel is configured to be bundled with the root filesystem |
1366 | in the same binary (example: zImage-initramfs-:term:`MACHINE`.bin). | 1366 | in the same binary (example: zImage-initramfs-:term:`MACHINE`.bin). |
1367 | When the kernel is copied to RAM and executed, it unpacks the Initramfs rootfs. | 1367 | When the kernel is copied to RAM and executed, it unpacks the Initramfs root filesystem. |
1368 | The Initramfs bundle can be enabled when :term:`INITRAMFS_IMAGE` | 1368 | The Initramfs bundle can be enabled when :term:`INITRAMFS_IMAGE` |
1369 | is specified and that :term:`INITRAMFS_IMAGE_BUNDLE` is set to 1. | 1369 | is specified and that :term:`INITRAMFS_IMAGE_BUNDLE` is set to 1. |
1370 | The address where the Initramfs bundle is to be loaded by U-boot is specified | 1370 | The address where the Initramfs bundle is to be loaded by U-boot is specified |
@@ -1712,13 +1712,13 @@ layers. | |||
1712 | ``overlayfs.bbclass`` | 1712 | ``overlayfs.bbclass`` |
1713 | ======================= | 1713 | ======================= |
1714 | 1714 | ||
1715 | It's often desired in Embedded System design to have a read-only rootfs. | 1715 | It's often desired in Embedded System design to have a read-only root filesystem. |
1716 | But a lot of different applications might want to have read-write access to | 1716 | But a lot of different applications might want to have read-write access to |
1717 | some parts of a filesystem. It can be especially useful when your update mechanism | 1717 | some parts of a filesystem. It can be especially useful when your update mechanism |
1718 | overwrites the whole rootfs, but you may want your application data to be preserved | 1718 | overwrites the whole root filesystem, but you may want your application data to be preserved |
1719 | between updates. The :ref:`overlayfs <ref-classes-overlayfs>` class provides a way | 1719 | between updates. The :ref:`overlayfs <ref-classes-overlayfs>` class provides a way |
1720 | to achieve that by means of ``overlayfs`` and at the same time keeping the base | 1720 | to achieve that by means of ``overlayfs`` and at the same time keeping the base |
1721 | rootfs read-only. | 1721 | root filesystem read-only. |
1722 | 1722 | ||
1723 | To use this class, set a mount point for a partition ``overlayfs`` is going to use as upper | 1723 | To use this class, set a mount point for a partition ``overlayfs`` is going to use as upper |
1724 | layer in your machine configuration. The underlying file system can be anything that | 1724 | layer in your machine configuration. The underlying file system can be anything that |
diff --git a/documentation/ref-manual/kickstart.rst b/documentation/ref-manual/kickstart.rst index 807f5e052d..885c721297 100644 --- a/documentation/ref-manual/kickstart.rst +++ b/documentation/ref-manual/kickstart.rst | |||
@@ -87,7 +87,7 @@ the ``part`` and ``partition`` commands: | |||
87 | 87 | ||
88 | If you use ``--source rootfs``, Wic creates a partition as large as | 88 | If you use ``--source rootfs``, Wic creates a partition as large as |
89 | needed and fills it with the contents of the root filesystem pointed | 89 | needed and fills it with the contents of the root filesystem pointed |
90 | to by the ``-r`` command-line option or the equivalent rootfs derived | 90 | to by the ``-r`` command-line option or the equivalent root filesystem derived |
91 | from the ``-e`` command-line option. The filesystem type used to | 91 | from the ``-e`` command-line option. The filesystem type used to |
92 | create the partition is driven by the value of the ``--fstype`` | 92 | create the partition is driven by the value of the ``--fstype`` |
93 | option specified for the partition. See the entry on ``--fstype`` | 93 | option specified for the partition. See the entry on ``--fstype`` |
@@ -96,7 +96,7 @@ the ``part`` and ``partition`` commands: | |||
96 | If you use ``--source plugin-name``, Wic creates a partition as large | 96 | If you use ``--source plugin-name``, Wic creates a partition as large |
97 | as needed and fills it with the contents of the partition that is | 97 | as needed and fills it with the contents of the partition that is |
98 | generated by the specified plugin name using the data pointed to by | 98 | generated by the specified plugin name using the data pointed to by |
99 | the ``-r`` command-line option or the equivalent rootfs derived from | 99 | the ``-r`` command-line option or the equivalent root filesystem derived from |
100 | the ``-e`` command-line option. Exactly what those contents are and | 100 | the ``-e`` command-line option. Exactly what those contents are and |
101 | filesystem type used are dependent on the given plugin | 101 | filesystem type used are dependent on the given plugin |
102 | implementation. | 102 | implementation. |
diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst index e5216b3f36..4f5d084e54 100644 --- a/documentation/ref-manual/variables.rst +++ b/documentation/ref-manual/variables.rst | |||
@@ -5302,7 +5302,7 @@ system and gives an overview of their function and contents. | |||
5302 | :term:`PACKAGE_WRITE_DEPS` | 5302 | :term:`PACKAGE_WRITE_DEPS` |
5303 | Specifies a list of dependencies for post-installation and | 5303 | Specifies a list of dependencies for post-installation and |
5304 | pre-installation scripts on native/cross tools. If your | 5304 | pre-installation scripts on native/cross tools. If your |
5305 | post-installation or pre-installation script can execute at rootfs | 5305 | post-installation or pre-installation script can execute at root filesystem |
5306 | creation time rather than on the target but depends on a native tool | 5306 | creation time rather than on the target but depends on a native tool |
5307 | in order to execute, you need to list the tools in | 5307 | in order to execute, you need to list the tools in |
5308 | :term:`PACKAGE_WRITE_DEPS`. | 5308 | :term:`PACKAGE_WRITE_DEPS`. |
diff --git a/documentation/what-i-wish-id-known.rst b/documentation/what-i-wish-id-known.rst index 143f9fbfed..dec5617173 100644 --- a/documentation/what-i-wish-id-known.rst +++ b/documentation/what-i-wish-id-known.rst | |||
@@ -150,7 +150,7 @@ contact us with other suggestions. | |||
150 | need, which is advantageous because you are building for small devices when | 150 | need, which is advantageous because you are building for small devices when |
151 | developing for embedded and IoT. | 151 | developing for embedded and IoT. |
152 | 152 | ||
153 | #. **You will want to learn about and know what's packaged in rootfs.** | 153 | #. **You will want to learn about and know what's packaged in the root filesystem.** |
154 | 154 | ||
155 | #. **Create your own image recipe:** | 155 | #. **Create your own image recipe:** |
156 | There are a number of ways to create your own image recipe. We suggest you | 156 | There are a number of ways to create your own image recipe. We suggest you |