The documentation for UEFI variable storage in uefi-vars.rst
incorrectly listed the device name as `uefi-vars-x86`.

The correct device name as implemented in the source code is
`uefi-vars-x64`.

This commit updates the documentation to use the correct name,
aligning it with the implementation.

Signed-off-by: Nana Liu <nanliu@redhat.com>
---
 docs/devel/uefi-vars.rst | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/docs/devel/uefi-vars.rst b/docs/devel/uefi-vars.rst
index 0151a26a0a..b4013b5d12 100644
--- a/docs/devel/uefi-vars.rst
+++ b/docs/devel/uefi-vars.rst
@@ -34,7 +34,7 @@ configures the shared buffer location and size, and traps to the host
 to process the requests.
 
 The ``uefi-vars`` device implements the UEFI virtual device.  It comes
-in ``uefi-vars-x86`` and ``uefi-vars-sysbus`` flavours.  The device
+in ``uefi-vars-x64`` and ``uefi-vars-sysbus`` flavours.  The device
 reimplements the handlers needed, specifically
 ``EfiSmmVariableProtocol`` and ``VarCheckPolicyLibMmiHandler``.  It
 also consumes events (``EfiEndOfDxeEventGroup``,
@@ -57,7 +57,7 @@ usage on x86_64
 .. code::
 
    qemu-system-x86_64 \
-      -device uefi-vars-x86,jsonfile=/path/to/vars.json
+      -device uefi-vars-x64,jsonfile=/path/to/vars.json
 
 usage on aarch64
 ----------------
-- 
2.50.1

On Mon, 22 Sept 2025 at 07:59, nanliu <nanliu@redhat.com> wrote:
>
> The documentation for UEFI variable storage in uefi-vars.rst
> incorrectly listed the device name as `uefi-vars-x86`.
>
> The correct device name as implemented in the source code is
> `uefi-vars-x64`.
>
> This commit updates the documentation to use the correct name,
> aligning it with the implementation.
>
> Signed-off-by: Nana Liu <nanliu@redhat.com>
> ---

We could probably also correct the bit of the text in this file
that currently reads "depend on SMM emulation on x64" to either
say "x86" or "x86_64". (Nowhere else in our docs calls
the 64-bit x86 platform "x64".)

thanks
-- PMM

On 23.09.2025 14:57, Peter Maydell wrote:

> We could probably also correct the bit of the text in this file
> that currently reads "depend on SMM emulation on x64" to either
> say "x86" or "x86_64".

This one will be a bit more than trivial :)  I for one don't know
if this is related to any x86 or to x86_64 only.

I'm applying the suggested correction to the trivial-patches tree.

Thanks,

/mjt

On Sat, 27 Sept 2025 at 09:48, Michael Tokarev <mjt@tls.msk.ru> wrote:
>
> On 23.09.2025 14:57, Peter Maydell wrote:
>
> > We could probably also correct the bit of the text in this file
> > that currently reads "depend on SMM emulation on x64" to either
> > say "x86" or "x86_64".
>
> This one will be a bit more than trivial :)  I for one don't know
> if this is related to any x86 or to x86_64 only.

I just mean exactly and specifically the one place in this
file which says "x64" and ought to say either "x86" or
"x86_64". To me a single word change is pretty trivial,
especially since nowhere else in our docs do we use "x64".

-- PMM

On 22/09/2025 08.57, nanliu wrote:
> The documentation for UEFI variable storage in uefi-vars.rst
> incorrectly listed the device name as `uefi-vars-x86`.
> 
> The correct device name as implemented in the source code is
> `uefi-vars-x64`.
> 
> This commit updates the documentation to use the correct name,
> aligning it with the implementation.
> 
> Signed-off-by: Nana Liu <nanliu@redhat.com>
> ---
>   docs/devel/uefi-vars.rst | 4 ++--
>   1 file changed, 2 insertions(+), 2 deletions(-)
> 
> diff --git a/docs/devel/uefi-vars.rst b/docs/devel/uefi-vars.rst
> index 0151a26a0a..b4013b5d12 100644
> --- a/docs/devel/uefi-vars.rst
> +++ b/docs/devel/uefi-vars.rst
> @@ -34,7 +34,7 @@ configures the shared buffer location and size, and traps to the host
>   to process the requests.
>   
>   The ``uefi-vars`` device implements the UEFI virtual device.  It comes
> -in ``uefi-vars-x86`` and ``uefi-vars-sysbus`` flavours.  The device
> +in ``uefi-vars-x64`` and ``uefi-vars-sysbus`` flavours.  The device
>   reimplements the handlers needed, specifically
>   ``EfiSmmVariableProtocol`` and ``VarCheckPolicyLibMmiHandler``.  It
>   also consumes events (``EfiEndOfDxeEventGroup``,
> @@ -57,7 +57,7 @@ usage on x86_64
>   .. code::
>   
>      qemu-system-x86_64 \
> -      -device uefi-vars-x86,jsonfile=/path/to/vars.json
> +      -device uefi-vars-x64,jsonfile=/path/to/vars.json
>   
>   usage on aarch64
>   ----------------

Reviewed-by: Thomas Huth <thuth@redhat.com>