Skip to contentSkip to conversation

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

PATCH In review Thomas Huth 4 participants 4 messages Jun 7, 2021 – Jun 8, 2021

lore
Share & tools
lore
#0 lore raw

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

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.

---
 docs/tools/virtiofsd.rst | 14 +++++++-------
 1 file changed, 7 insertions(+), 7 deletions(-)
docs/tools/virtiofsd.rst +7 -7
index 00554c75bd..265a39b0cf 100644
@@ -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
Signature · 1 line
2.27.0
Reviewed-by on v1 1/1
#1 lore raw
Quoted 6 lines · * Thomas Huth ([email protected]) 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.

Quoted 32 lines
---
 docs/tools/virtiofsd.rst | 14 +++++++-------
 1 file changed, 7 insertions(+), 7 deletions(-)
docs/tools/virtiofsd.rst +7 -7
index 00554c75bd..265a39b0cf 100644
@@ -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
Signature · 1 line
2.27.0
Signature · 1 line
Dr. David Alan Gilbert / [email protected] / Manchester, UK
Reviewed-by on v1 1/1
#2 lore raw
In reply to Thomas Huth
Quoted 9 lines · 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.

---
 docs/tools/virtiofsd.rst | 14 +++++++-------
 1 file changed, 7 insertions(+), 7 deletions(-)
Reviewed-by on v1 1/1
#3 lore raw
In reply to Thomas Huth
Quoted 9 lines · 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.

---
 docs/tools/virtiofsd.rst | 14 +++++++-------
 1 file changed, 7 insertions(+), 7 deletions(-)