[PATCH 11/12] doc: bootefi: note two-phase runtime variables selftest

[Simon Glass]

Hi Harsimran,

On 2026-04-24T17:31:50, Harsimran Singh Tungal
<harsimransingh.tungal at arm.com> wrote:
> doc: bootefi: note two-phase runtime variables selftest
>
> Explain how the runtime variable selftest runs in two phases
>
> Document that the "variables at runtime" selftest runs in two
> phases when CONFIG_EFI_RT_VOLATILE_STORE is not enabled, and
> show how to select it with efi_selftest.
>
> Signed-off-by: Harsimran Singh Tungal <harsimransingh.tungal at arm.com>
>
> doc/usage/cmd/bootefi.rst | 12 ++++++++++++
>  1 file changed, 12 insertions(+)

> diff --git a/doc/usage/cmd/bootefi.rst b/doc/usage/cmd/bootefi.rst
> @@ -167,6 +177,8 @@ To use the *bootefi* command you must specify CONFIG_CMD_BOOTEFI=y.
>  The *bootefi bootmgr* sub-command requries CMD_BOOTEFI_BOOTMGR=y.
>  The *bootefi hello* sub-command requries CMD_BOOTEFI_HELLO=y.
>  The *bootefi selftest* sub-command depends on CMD_BOOTEFI_SELFTEST=y.
> +The *variables at runtime* selftest runs in two phases when
> +CONFIG\_EFI\_RT\_VOLATILE\_STORE is not enabled.

Please drop this addition. It duplicates what you wrote a few lines
above and the Configuration section is for build-time CONFIG_ options,
not runtime test behaviour. Also the backslash-escaped underscores are
not needed in rST and produce inconsistent rendering compared to the
plain CONFIG_EFI_RT_VOLATILE_STORE used in the paragraph above.

> diff --git a/doc/usage/cmd/bootefi.rst b/doc/usage/cmd/bootefi.rst
> @@ -160,6 +160,16 @@ environment variable to match one of the listed identifiers
>  Some of the tests execute the ExitBootServices() UEFI boot service and will not
>  return to the command line but require a board reset.
>
> +The test *variables at runtime* runs in two phases when
> +CONFIG_EFI_RT_VOLATILE_STORE is not enabled. Run it once to create a
> +runtime-accessible variable in non-volatile storage, reboot, then run it
> +again to validate, append, and delete that variable.

It would help to also say what happens when
CONFIG_EFI_RT_VOLATILE_STORE is enabled (single phase, no reboot
needed) so readers know which path applies to their build. A one-line
note is enough.

>     Explain how the runtime variable selftest runs in two phases
>
>     Document that the "variables at runtime" selftest runs in two
>     phases when CONFIG_EFI_RT_VOLATILE_STORE is not enabled, and
>     show how to select it with efi_selftest.

The first paragraph just restates the subject - please drop it and
lead with the motivation, then describe what the patch adds. Lines are
also wrapping well short of 72 columns.

Regards,
Simon