[libvirt PATCH 2/2] docs: virtiofs: use the preferred virtiofs spelling

Stefan Hajnoczi posted 2 patches 4 years, 5 months ago
[libvirt PATCH 2/2] docs: virtiofs: use the preferred virtiofs spelling
Posted by Stefan Hajnoczi 4 years, 5 months ago
The virtiofs project started off using "virtio-fs" but later switched to
the "virtiofs" spelling because it matches the spelling of the mount -t
virtiofs command-line. Update the kbase article with the new spelling so
it matches the virtiofs website.

Signed-off-by: Stefan Hajnoczi <stefanha@redhat.com>
---
 docs/kbase/virtiofs.rst | 12 ++++++------
 1 file changed, 6 insertions(+), 6 deletions(-)

diff --git a/docs/kbase/virtiofs.rst b/docs/kbase/virtiofs.rst
index 75e740bf96..d728a1358c 100644
--- a/docs/kbase/virtiofs.rst
+++ b/docs/kbase/virtiofs.rst
@@ -1,13 +1,13 @@
-============================
-Sharing files with Virtio-FS
-============================
+===========================
+Sharing files with Virtiofs
+===========================
 
 .. contents::
 
-Virtio-FS
-=========
+Virtiofs
+========
 
-Virtio-FS is a shared file system that lets virtual machines access
+Virtiofs is a shared file system that lets virtual machines access
 a directory tree on the host. Unlike existing approaches, it
 is designed to offer local file system semantics and performance.
 
-- 
2.31.1

Re: [libvirt PATCH 2/2] docs: virtiofs: use the preferred virtiofs spelling
Posted by Ján Tomko 4 years, 5 months ago
On a Thursday in 2021, Stefan Hajnoczi wrote:
>The virtiofs project started off using "virtio-fs" but later switched to
>the "virtiofs" spelling because it matches the spelling of the mount -t
>virtiofs command-line. Update the kbase article with the new spelling so
>it matches the virtiofs website.
>
>Signed-off-by: Stefan Hajnoczi <stefanha@redhat.com>
>---
> docs/kbase/virtiofs.rst | 12 ++++++------
> 1 file changed, 6 insertions(+), 6 deletions(-)
>

There are two more occurrences on pages linking to the kbase article.

With the following diff squashed in:
Reviewed-by: Ján Tomko <jtomko@redhat.com>

Jano

diff --git a/docs/formatdomain.rst b/docs/formatdomain.rst
index 479a3acfbb..ad3b4ea92c 100644
--- a/docs/formatdomain.rst
+++ b/docs/formatdomain.rst
@@ -3305,7 +3305,7 @@ A directory on the host that can be accessed directly from the guest.
        pages touched during a guest file write operation :since:`(since 0.9.10)`
        . :since:`Since 6.2.0` , ``type='virtiofs'`` is also supported. Using
        virtiofs requires setting up shared memory, see the guide:
-      `Virtio-FS <kbase/virtiofs.html>`__
+      `Virtiofs <kbase/virtiofs.html>`__
     ``template``
        OpenVZ filesystem template. Only used by OpenVZ driver.
     ``file``
diff --git a/docs/kbase/index.rst b/docs/kbase/index.rst
index 372042886d..351ea2c93b 100644
--- a/docs/kbase/index.rst
+++ b/docs/kbase/index.rst
@@ -12,7 +12,7 @@ Usage
     Explanation of how disk backing chain specification impacts libvirt's
     behaviour and basic troubleshooting steps of disk problems.

-`Virtio-FS <virtiofs.html>`__
+`Virtiofs <virtiofs.html>`__
     Share a filesystem between the guest and the host

  `Security with QEMU passthrough <qemu-passthrough-security.html>`__