| Message ID | 20261021125235.2954-1-andrej.kozemcak@siemens.com |
|---|---|
| State | Under Review |
| Headers | show |
| Series | [v2] ref-manual/variables.rst: document the QB_FSINFO variable | expand |
On Wed Oct 21, 2026 at 2:52 PM CEST, Andrej Kozemcak via lists.yoctoproject.org wrote: > Added by commit b6c78bddf3 ("runqemu: support rootfs-dbg flag > in QB_FSINFO") in OE-Core. > Add documentation for the QB_FSINFO variable, which provides > additional filesystem metadata to runqemu as a space-separated > list of fstype:flag entries, covering WIC kernel-in-fs options [...] Applied to master-next, thanks! I've just allowed myself to add a reference to "WIC" with :term: since we recently added it in the docs, and also fix variable sorting in the glossary: diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst index c79d58954..bbf0e6d07 100644 --- a/documentation/ref-manual/variables.rst +++ b/documentation/ref-manual/variables.rst @@ -8205,6 +8205,24 @@ system and gives an overview of their function and contents. filesystem image extension found in :term:`DEPLOY_DIR_IMAGE`. For example: ``ext4.zst``. + :term:`QB_DEFAULT_KERNEL` + + When using ``runqemu``, the :term:`QB_DEFAULT_KERNEL` variable controls + the default Linux kernel image to boot, found in :term:`DEPLOY_DIR_IMAGE`. For + example: ``bzImage``. + + :term:`QB_DRIVE_TYPE` + + When using ``runqemu``, the :term:`QB_DRIVE_TYPE` variable specifies the + type of drive to emulate when starting the emulated machine. + Valid values are: + + - ``/dev/hd``: emulates an IDE drive. + - ``/dev/mmcblk``: emulates an SD Card. + - ``/dev/sd``: emulates an SCSI drive. + - ``/dev/vd``: emulates a VirtIO drive. + - ``/dev/vdb``: emulates a block VirtIO drive. + :term:`QB_FSINFO` The :term:`QB_FSINFO` variable provides additional filesystem metadata to @@ -8218,10 +8236,10 @@ system and gives an overview of their function and contents. - ``wic``: - ``no-kernel-in-fs``: Specifies that the kernel is not included in - the WIC image. In this case, ``runqemu`` loads the kernel separately. + the :term:`Wic` image. In this case, ``runqemu`` loads the kernel separately. - ``kernel-in-fs``: Specifies that the kernel is included in the - WIC image. In this case, ``runqemu`` does not load a separate kernel. + :term:`Wic` image. In this case, ``runqemu`` does not load a separate kernel. - ``tar``: @@ -8229,24 +8247,6 @@ system and gives an overview of their function and contents. image when extracting a tarball for NFS by appending ``-dbg`` to :term:`IMAGE_LINK_NAME`. - :term:`QB_DEFAULT_KERNEL` - - When using ``runqemu``, the :term:`QB_DEFAULT_KERNEL` variable controls - the default Linux kernel image to boot, found in :term:`DEPLOY_DIR_IMAGE`. For - example: ``bzImage``. - - :term:`QB_DRIVE_TYPE` - - When using ``runqemu``, the :term:`QB_DRIVE_TYPE` variable specifies the - type of drive to emulate when starting the emulated machine. - Valid values are: - - - ``/dev/hd``: emulates an IDE drive. - - ``/dev/mmcblk``: emulates an SD Card. - - ``/dev/sd``: emulates an SCSI drive. - - ``/dev/vd``: emulates a VirtIO drive. - - ``/dev/vdb``: emulates a block VirtIO drive. - :term:`QB_GRAPHICS` When using ``runqemu``, the :term:`QB_GRAPHICS` variable controls the QEMU Antonin
diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst index 5339721f4..c79d58954 100644 --- a/documentation/ref-manual/variables.rst +++ b/documentation/ref-manual/variables.rst @@ -8205,6 +8205,30 @@ system and gives an overview of their function and contents. filesystem image extension found in :term:`DEPLOY_DIR_IMAGE`. For example: ``ext4.zst``. + :term:`QB_FSINFO` + + The :term:`QB_FSINFO` variable provides additional filesystem metadata to + ``runqemu`` as a space-separated list of ``fstype:flag`` entries. For + example:: + + QB_FSINFO = "wic:no-kernel-in-fs tar:rootfs-dbg" + + The currently supported ``fstype`` and ``flag`` entries are: + + - ``wic``: + + - ``no-kernel-in-fs``: Specifies that the kernel is not included in + the WIC image. In this case, ``runqemu`` loads the kernel separately. + + - ``kernel-in-fs``: Specifies that the kernel is included in the + WIC image. In this case, ``runqemu`` does not load a separate kernel. + + - ``tar``: + + - ``rootfs-dbg``: Makes ``runqemu`` use the debug root filesystem + image when extracting a tarball for NFS by appending ``-dbg`` to + :term:`IMAGE_LINK_NAME`. + :term:`QB_DEFAULT_KERNEL` When using ``runqemu``, the :term:`QB_DEFAULT_KERNEL` variable controls
Added by commit b6c78bddf3 ("runqemu: support rootfs-dbg flag in QB_FSINFO") in OE-Core. Add documentation for the QB_FSINFO variable, which provides additional filesystem metadata to runqemu as a space-separated list of fstype:flag entries, covering WIC kernel-in-fs options and tar rootfs-dbg handling. Signed-off-by: Andrej Kozemcak <andrej.kozemcak@siemens.com> --- documentation/ref-manual/variables.rst | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+)