[PATCH 2/4] docs/system: unify the naming style for VirtIO devices

Alex Bennée posted 4 patches 3 weeks, 4 days ago
Maintainers: John Levon <john.levon@nutanix.com>, Thanos Makatos <thanos.makatos@nutanix.com>, "Cédric Le Goater" <clg@redhat.com>
[PATCH 2/4] docs/system: unify the naming style for VirtIO devices
Posted by Alex Bennée 3 weeks, 4 days ago
This makes the index look a little neater.

Signed-off-by: Alex Bennée <alex.bennee@linaro.org>
---
 docs/system/devices/virtio/virtio-gpu.rst  | 2 +-
 docs/system/devices/virtio/virtio-pmem.rst | 6 ++----
 docs/system/devices/virtio/virtio-snd.rst  | 2 +-
 3 files changed, 4 insertions(+), 6 deletions(-)

diff --git a/docs/system/devices/virtio/virtio-gpu.rst b/docs/system/devices/virtio/virtio-gpu.rst
index b7eb0fc0e72..39d2fd2d21c 100644
--- a/docs/system/devices/virtio/virtio-gpu.rst
+++ b/docs/system/devices/virtio/virtio-gpu.rst
@@ -1,7 +1,7 @@
 ..
    SPDX-License-Identifier: GPL-2.0-or-later
 
-virtio-gpu
+VirtIO GPU
 ==========
 
 This document explains the setup and usage of the virtio-gpu device.
diff --git a/docs/system/devices/virtio/virtio-pmem.rst b/docs/system/devices/virtio/virtio-pmem.rst
index c82ac067315..0c24de83ec7 100644
--- a/docs/system/devices/virtio/virtio-pmem.rst
+++ b/docs/system/devices/virtio/virtio-pmem.rst
@@ -1,7 +1,5 @@
-
-===========
-virtio pmem
-===========
+VirtIO Persistent Memory
+========================
 
 This document explains the setup and usage of the virtio pmem device.
 The virtio pmem device is a paravirtualized persistent memory device
diff --git a/docs/system/devices/virtio/virtio-snd.rst b/docs/system/devices/virtio/virtio-snd.rst
index 2a9187fd701..3c797f66e03 100644
--- a/docs/system/devices/virtio/virtio-snd.rst
+++ b/docs/system/devices/virtio/virtio-snd.rst
@@ -1,4 +1,4 @@
-virtio sound
+VirtIO Sound
 ============
 
 This document explains the setup and usage of the Virtio sound device.
-- 
2.47.2


Re: [PATCH 2/4] docs/system: unify the naming style for VirtIO devices
Posted by Manos Pitsidianakis 3 weeks, 4 days ago
Hi Alex,

On Tue, Sep 2, 2025 at 7:51 PM Alex Bennée <alex.bennee@linaro.org> wrote:
>
> This makes the index look a little neater.
>
> Signed-off-by: Alex Bennée <alex.bennee@linaro.org>
> ---

The spec uses VIRTIO/Virtio/virtio but not VirtIO. A unified look is a
nice cleanup. Maybe we could use Virtio?

>  docs/system/devices/virtio/virtio-gpu.rst  | 2 +-
>  docs/system/devices/virtio/virtio-pmem.rst | 6 ++----
>  docs/system/devices/virtio/virtio-snd.rst  | 2 +-
>  3 files changed, 4 insertions(+), 6 deletions(-)
>
> diff --git a/docs/system/devices/virtio/virtio-gpu.rst b/docs/system/devices/virtio/virtio-gpu.rst
> index b7eb0fc0e72..39d2fd2d21c 100644
> --- a/docs/system/devices/virtio/virtio-gpu.rst
> +++ b/docs/system/devices/virtio/virtio-gpu.rst
> @@ -1,7 +1,7 @@
>  ..
>     SPDX-License-Identifier: GPL-2.0-or-later
>
> -virtio-gpu
> +VirtIO GPU
>  ==========
>
>  This document explains the setup and usage of the virtio-gpu device.
> diff --git a/docs/system/devices/virtio/virtio-pmem.rst b/docs/system/devices/virtio/virtio-pmem.rst
> index c82ac067315..0c24de83ec7 100644
> --- a/docs/system/devices/virtio/virtio-pmem.rst
> +++ b/docs/system/devices/virtio/virtio-pmem.rst
> @@ -1,7 +1,5 @@
> -
> -===========
> -virtio pmem
> -===========
> +VirtIO Persistent Memory
> +========================
>
>  This document explains the setup and usage of the virtio pmem device.
>  The virtio pmem device is a paravirtualized persistent memory device
> diff --git a/docs/system/devices/virtio/virtio-snd.rst b/docs/system/devices/virtio/virtio-snd.rst
> index 2a9187fd701..3c797f66e03 100644
> --- a/docs/system/devices/virtio/virtio-snd.rst
> +++ b/docs/system/devices/virtio/virtio-snd.rst
> @@ -1,4 +1,4 @@
> -virtio sound
> +VirtIO Sound
>  ============
>
>  This document explains the setup and usage of the Virtio sound device.
> --
> 2.47.2
>
>
Re: [PATCH 2/4] docs/system: unify the naming style for VirtIO devices
Posted by John Levon 3 weeks, 4 days ago
On Tue, Sep 02, 2025 at 05:50:46PM +0100, Alex Bennée wrote:

> This makes the index look a little neater.
> 
> Signed-off-by: Alex Bennée <alex.bennee@linaro.org>

Reviewed-by: John Levon <john.levon@nutanix.com>

regards
john