Re: [docs] [PATCH] ref-manual/variables.rst: document the QB_FSINFO variable

["Antonin Godard" <antonin.godard@bootlin.com>]

Hi,

On Tue Oct 20, 2026 at 12:36 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
> and tar rootfs-dbg handling.
>
> Signed-off-by: Andrej Kozemcak <andrej.kozemcak@siemens.com>
> ---
> Request from this email: 
> https://lists.openembedded.org/g/openembedded-core/message/248037?p=%2C%2C%2C20%2C0%2C0%2C0%3A%3Acreated%2C%2CQB_FSINFO%2C20%2C2%2C0%2C121544914
>
>  documentation/ref-manual/variables.rst | 14 ++++++++++++++
>  1 file changed, 14 insertions(+)
>
> diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst
> index 5339721f4..025219d54 100644
> --- a/documentation/ref-manual/variables.rst
> +++ b/documentation/ref-manual/variables.rst
> @@ -8205,6 +8205,20 @@ 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"
> +
> +      For WIC images, use ``wic:no-kernel-in-fs`` or ``wic:kernel-in-fs`` to
> +      specify whether the kernel is included in the filesystem. For tar-based
> +      filesystem types, ``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`.

I think this would be better presented as lists, and start with:

"""
The currently supported ``fstype`` and ``flag`` entries are:

-  ``wic``:

   -  ``no-kernel-in-fs``: ...

   -  ``kernel-in-fs``: ...

-  ``tar``:

   -  ``rootfs-dbg``: ...
"""

So it's simpler to add new ones later.

Thanks,
Antonin