[PATCH] docs/tools/virtiofsd.rst: Do not hard-code the QEMU binary name

[PATCH] docs/tools/virtiofsd.rst: Do not hard-code the QEMU binary name

[Thomas Huth]

In downstream, we want to use a different name for the QEMU binary,
and some people might also use the docs for non-x86 binaries, that's
why we already created the |qemu_system| placeholder in the past.
Use it now in the virtiofsd doc, too.

Signed-off-by: Thomas Huth <thuth@redhat.com>
---
 docs/tools/virtiofsd.rst | 14 +++++++-------
 1 file changed, 7 insertions(+), 7 deletions(-)

diff --git a/docs/tools/virtiofsd.rst b/docs/tools/virtiofsd.rst
index 00554c75bd..265a39b0cf 100644
--- a/docs/tools/virtiofsd.rst
+++ b/docs/tools/virtiofsd.rst
@@ -298,13 +298,13 @@ Examples
 Export ``/var/lib/fs/vm001/`` on vhost-user UNIX domain socket
 ``/var/run/vm001-vhost-fs.sock``:
 
-::
+.. parsed-literal::
 
   host# virtiofsd --socket-path=/var/run/vm001-vhost-fs.sock -o source=/var/lib/fs/vm001
-  host# qemu-system-x86_64 \
-      -chardev socket,id=char0,path=/var/run/vm001-vhost-fs.sock \
-      -device vhost-user-fs-pci,chardev=char0,tag=myfs \
-      -object memory-backend-memfd,id=mem,size=4G,share=on \
-      -numa node,memdev=mem \
-      ...
+  host# |qemu_system| \\
+        -chardev socket,id=char0,path=/var/run/vm001-vhost-fs.sock \\
+        -device vhost-user-fs-pci,chardev=char0,tag=myfs \\
+        -object memory-backend-memfd,id=mem,size=4G,share=on \\
+        -numa node,memdev=mem \\
+        ...
   guest# mount -t virtiofs myfs /mnt
-- 
2.27.0

Re: [PATCH] docs/tools/virtiofsd.rst: Do not hard-code the QEMU binary name

[Dr. David Alan Gilbert]

* Thomas Huth (thuth@redhat.com) wrote:
> In downstream, we want to use a different name for the QEMU binary,
> and some people might also use the docs for non-x86 binaries, that's
> why we already created the |qemu_system| placeholder in the past.
> Use it now in the virtiofsd doc, too.
> 
> Signed-off-by: Thomas Huth <thuth@redhat.com>

Reviewed-by: Dr. David Alan Gilbert <dgilbert@redhat.com>

> ---
>  docs/tools/virtiofsd.rst | 14 +++++++-------
>  1 file changed, 7 insertions(+), 7 deletions(-)
> 
> diff --git a/docs/tools/virtiofsd.rst b/docs/tools/virtiofsd.rst
> index 00554c75bd..265a39b0cf 100644
> --- a/docs/tools/virtiofsd.rst
> +++ b/docs/tools/virtiofsd.rst
> @@ -298,13 +298,13 @@ Examples
>  Export ``/var/lib/fs/vm001/`` on vhost-user UNIX domain socket
>  ``/var/run/vm001-vhost-fs.sock``:
>  
> -::
> +.. parsed-literal::
>  
>    host# virtiofsd --socket-path=/var/run/vm001-vhost-fs.sock -o source=/var/lib/fs/vm001
> -  host# qemu-system-x86_64 \
> -      -chardev socket,id=char0,path=/var/run/vm001-vhost-fs.sock \
> -      -device vhost-user-fs-pci,chardev=char0,tag=myfs \
> -      -object memory-backend-memfd,id=mem,size=4G,share=on \
> -      -numa node,memdev=mem \
> -      ...
> +  host# |qemu_system| \\
> +        -chardev socket,id=char0,path=/var/run/vm001-vhost-fs.sock \\
> +        -device vhost-user-fs-pci,chardev=char0,tag=myfs \\
> +        -object memory-backend-memfd,id=mem,size=4G,share=on \\
> +        -numa node,memdev=mem \\
> +        ...
>    guest# mount -t virtiofs myfs /mnt
> -- 
> 2.27.0
> 
-- 
Dr. David Alan Gilbert / dgilbert@redhat.com / Manchester, UK

Re: [PATCH] docs/tools/virtiofsd.rst: Do not hard-code the QEMU binary name

[Philippe Mathieu-Daudé]

On 6/7/21 7:42 PM, Thomas Huth wrote:
> In downstream, we want to use a different name for the QEMU binary,
> and some people might also use the docs for non-x86 binaries, that's
> why we already created the |qemu_system| placeholder in the past.
> Use it now in the virtiofsd doc, too.
> 
> Signed-off-by: Thomas Huth <thuth@redhat.com>
> ---
>  docs/tools/virtiofsd.rst | 14 +++++++-------
>  1 file changed, 7 insertions(+), 7 deletions(-)

Reviewed-by: Philippe Mathieu-Daudé <philmd@redhat.com>

Re: [PATCH] docs/tools/virtiofsd.rst: Do not hard-code the QEMU binary name

[Stefan Hajnoczi]

[-- Attachment #1: Type: text/plain, Size: 530 bytes --]

On Mon, Jun 07, 2021 at 07:42:50PM +0200, Thomas Huth wrote:
> In downstream, we want to use a different name for the QEMU binary,
> and some people might also use the docs for non-x86 binaries, that's
> why we already created the |qemu_system| placeholder in the past.
> Use it now in the virtiofsd doc, too.
> 
> Signed-off-by: Thomas Huth <thuth@redhat.com>
> ---
>  docs/tools/virtiofsd.rst | 14 +++++++-------
>  1 file changed, 7 insertions(+), 7 deletions(-)

Reviewed-by: Stefan Hajnoczi <stefanha@redhat.com>

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 488 bytes --]