docs/system: fix vfio-user console example format

[PATCH] docs/system: fix vfio-user console example format

Posted by Carlos López 3 weeks, 3 days ago

The rendering for the console example for vfio-user is displayed
incorrectly because of a missing indentation, causing the example to be
shown as regular text. Fix this by adding the required indentation.

Fixes: c688cc165b32 ("docs: add vfio-user documentation")
Signed-off-by: Carlos López <clopez@suse.de>
---
 docs/system/devices/vfio-user.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/docs/system/devices/vfio-user.rst b/docs/system/devices/vfio-user.rst
index b6dcaa5615..e31548b3a4 100644
--- a/docs/system/devices/vfio-user.rst
+++ b/docs/system/devices/vfio-user.rst
@@ -20,7 +20,7 @@ Presuming a suitable ``vfio-user`` server has opened a socket at
 
 .. code-block:: console
 
--device '{"driver": "vfio-user-pci","socket": {"path": "/tmp/vfio-user.sock", "type": "unix"}}'
+  -device '{"driver": "vfio-user-pci","socket": {"path": "/tmp/vfio-user.sock", "type": "unix"}}'
 
 See `libvfio-user <https://github.com/nutanix/libvfio-user/>`_ for further
 information.
-- 
2.51.0

Re: [PATCH] docs/system: fix vfio-user console example format

Posted by John Levon 3 weeks, 3 days ago

On Tue, Oct 21, 2025 at 11:35:51AM +0200, Carlos López wrote:

> The rendering for the console example for vfio-user is displayed
> incorrectly because of a missing indentation, causing the example to be
> shown as regular text. Fix this by adding the required indentation.

Thanks but this is a duplicate of:

https://lore.kernel.org/qemu-devel/20251009140206.386249-1-john.levon@nutanix.com/

regards
john

Re: [PATCH] docs/system: fix vfio-user console example format

Posted by Cédric Le Goater 3 weeks, 3 days ago

Hello Carlos,

On 10/21/25 11:35, Carlos López wrote:
> The rendering for the console example for vfio-user is displayed
> incorrectly because of a missing indentation, causing the example to be
> shown as regular text. Fix this by adding the required indentation.
> 
> Fixes: c688cc165b32 ("docs: add vfio-user documentation")
> Signed-off-by: Carlos López <clopez@suse.de>
> ---
>   docs/system/devices/vfio-user.rst | 2 +-
>   1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/docs/system/devices/vfio-user.rst b/docs/system/devices/vfio-user.rst
> index b6dcaa5615..e31548b3a4 100644
> --- a/docs/system/devices/vfio-user.rst
> +++ b/docs/system/devices/vfio-user.rst
> @@ -20,7 +20,7 @@ Presuming a suitable ``vfio-user`` server has opened a socket at
>   
>   .. code-block:: console
>   
> --device '{"driver": "vfio-user-pci","socket": {"path": "/tmp/vfio-user.sock", "type": "unix"}}'
> +  -device '{"driver": "vfio-user-pci","socket": {"path": "/tmp/vfio-user.sock", "type": "unix"}}'
>   
>   See `libvfio-user <https://github.com/nutanix/libvfio-user/>`_ for further
>   information.

John sent a similar fix [1]. It's in the vfio-next branch and
should soon be merged.

Thanks,

C.

[1] https://lore.kernel.org//qemu-devel/20251009140206.386249-1-john.levon@nutanix.com