qemu-devel.nongnu.org archive mirror
 help / color / mirror / Atom feed
* [PATCH] docs/system: fix vfio-user console example format
@ 2025-10-21  9:35 Carlos López
  2025-10-21 10:05 ` John Levon
  2025-10-21 10:06 ` Cédric Le Goater
  0 siblings, 2 replies; 3+ messages in thread
From: Carlos López @ 2025-10-21  9:35 UTC (permalink / raw)
  To: qemu-devel
  Cc: Carlos López, John Levon, Thanos Makatos,
	Cédric Le Goater

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



^ permalink raw reply related	[flat|nested] 3+ messages in thread

* Re: [PATCH] docs/system: fix vfio-user console example format
  2025-10-21  9:35 [PATCH] docs/system: fix vfio-user console example format Carlos López
@ 2025-10-21 10:05 ` John Levon
  2025-10-21 10:06 ` Cédric Le Goater
  1 sibling, 0 replies; 3+ messages in thread
From: John Levon @ 2025-10-21 10:05 UTC (permalink / raw)
  To: Carlos López; +Cc: qemu-devel, Thanos Makatos, Cédric Le Goater

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


^ permalink raw reply	[flat|nested] 3+ messages in thread

* Re: [PATCH] docs/system: fix vfio-user console example format
  2025-10-21  9:35 [PATCH] docs/system: fix vfio-user console example format Carlos López
  2025-10-21 10:05 ` John Levon
@ 2025-10-21 10:06 ` Cédric Le Goater
  1 sibling, 0 replies; 3+ messages in thread
From: Cédric Le Goater @ 2025-10-21 10:06 UTC (permalink / raw)
  To: Carlos López, qemu-devel; +Cc: John Levon, Thanos Makatos

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



^ permalink raw reply	[flat|nested] 3+ messages in thread

end of thread, other threads:[~2025-10-21 10:07 UTC | newest]

Thread overview: 3+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2025-10-21  9:35 [PATCH] docs/system: fix vfio-user console example format Carlos López
2025-10-21 10:05 ` John Levon
2025-10-21 10:06 ` Cédric Le Goater

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).