Mesa (main): docs: rename vmware-guest article

[GitLab Mirror]

Module: Mesa
Branch: main
Commit: 601a7bd2b2d03075f8d5a987fd2d2ebd00baf5f0
URL:    http://cgit.freedesktop.org/mesa/mesa/commit/?id=601a7bd2b2d03075f8d5a987fd2d2ebd00baf5f0

Author: Erik Faye-Lund <erik.faye-lund at collabora.com>
Date:   Tue Jun  1 13:30:44 2021 +0200

docs: rename vmware-guest article

No other drivers use the vendor in the title or path, so it seems better
to not do this for the vmware-guest driver as well. So let's rename it
to SVGA instead. The actual text itself makes it clear enough what it is
about.

This makes it stand out less in the toctree.

I chose the name "WMware SVGA3D", because that's less ambigious than the
"SVGA"-alternative, and was requested by VMware people.t

Reviewed-by: Alyssa Rosenzweig <alyssa.rosenzweig at collabora.com>
Reviewed-by: Chia-I Wu <olvaffe at gmail.com>
Acked-by: Jose Fonseca <jfonseca at vmware.com>
Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/11109>

---

 docs/conf.py                                  | 1 +
 docs/drivers/{vmware-guest.rst => svga3d.rst} | 4 ++--
 docs/index.rst                                | 2 +-
 docs/systems.rst                              | 2 +-
 4 files changed, 5 insertions(+), 4 deletions(-)

diff --git a/docs/conf.py b/docs/conf.py
index 31ef7a10c95..47fd9069785 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -135,6 +135,7 @@ html_extra_path = [
 ]
 
 html_redirects = [
+  ('drivers/vmware-guest', 'drivers/svga3d.html'),
   ('gallium/drivers/freedreno', 'drivers/freedreno.html'),
   ('gallium/drivers/freedreno/ir3-notes', 'drivers/freedreno/ir3-notes.html'),
   ('gallium/drivers/llvmpipe', 'drivers/llvmpipe.html'),
diff --git a/docs/drivers/vmware-guest.rst b/docs/drivers/svga3d.rst
similarity index 99%
rename from docs/drivers/vmware-guest.rst
rename to docs/drivers/svga3d.rst
index df9e09e411d..b2cf063d3fc 100644
--- a/docs/drivers/vmware-guest.rst
+++ b/docs/drivers/svga3d.rst
@@ -1,5 +1,5 @@
-VMware SVGA3D Guest Driver
-==========================
+VMware SVGA3D
+=============
 
 This page describes how to build, install and use the
 `VMware <https://www.vmware.com/>`__ guest GL driver (aka the SVGA or
diff --git a/docs/index.rst b/docs/index.rst
index 79571e07916..c735b994e1d 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -89,10 +89,10 @@ Linux, FreeBSD, and other operating systems.
    drivers/llvmpipe
    drivers/openswr
    drivers/panfrost
+   drivers/svga3d
    drivers/v3d
    drivers/vc4
    drivers/venus
-   drivers/vmware-guest
    drivers/zink
 
 .. toctree::
diff --git a/docs/systems.rst b/docs/systems.rst
index 37f8742b486..6e3da61ccf1 100644
--- a/docs/systems.rst
+++ b/docs/systems.rst
@@ -32,7 +32,7 @@ Software drivers include:
 -  :doc:`llvmpipe <drivers/llvmpipe>` - uses LLVM for x86 JIT code generation
    and is multi-threaded
 -  softpipe - a reference Gallium driver
--  :doc:`svga <drivers/vmware-guest>` - driver for VMware virtual GPU
+-  :doc:`svga <drivers/svga3d>` - driver for VMware virtual GPU
 -  `swr <https://www.openswr.org/>`__ - x86-optimized software renderer
    for visualization workloads
 -  `virgl <https://virgil3d.github.io/>`__ - research project for