[PATCH] docs: Remove unused weirdly-named cross-reference targets

[PATCH] docs: Remove unused weirdly-named cross-reference targets

[Peter Maydell]

In the doc sources, we have a few cross-reference targets with odd
names "pcsys_005fxyz".  These are the legacy of the semi-automated
conversion of the old info docs to rST (the '005f' is because ASCII
0x5f is '_' and the old info link names had underscores in them).

Remove the targets which nothing links to, and rename the two targets
which are used to something a bit more descriptive.

Signed-off-by: Peter Maydell <peter.maydell@linaro.org>
---
 docs/system/devices/igb.rst     | 2 +-
 docs/system/devices/ivshmem.rst | 2 --
 docs/system/devices/net.rst     | 2 +-
 docs/system/devices/usb.rst     | 2 --
 docs/system/keys.rst            | 2 +-
 docs/system/linuxboot.rst       | 2 +-
 docs/system/target-i386.rst     | 4 ----
 7 files changed, 4 insertions(+), 12 deletions(-)

diff --git a/docs/system/devices/igb.rst b/docs/system/devices/igb.rst
index 70edadd5743..0bcdd857473 100644
--- a/docs/system/devices/igb.rst
+++ b/docs/system/devices/igb.rst
@@ -29,7 +29,7 @@ Using igb
 =========
 
 Using igb should be nothing different from using another network device. See
-:ref:`pcsys_005fnetwork` in general.
+:ref:`Network_emulation` in general.
 
 However, you may also need to perform additional steps to activate SR-IOV
 feature on your guest. For Linux, refer to [4]_.
diff --git a/docs/system/devices/ivshmem.rst b/docs/system/devices/ivshmem.rst
index b03a48afa3a..e7aaf34c200 100644
--- a/docs/system/devices/ivshmem.rst
+++ b/docs/system/devices/ivshmem.rst
@@ -1,5 +1,3 @@
-.. _pcsys_005fivshmem:
-
 Inter-VM Shared Memory device
 -----------------------------
 
diff --git a/docs/system/devices/net.rst b/docs/system/devices/net.rst
index 4b2640c448e..2ab516d4b09 100644
--- a/docs/system/devices/net.rst
+++ b/docs/system/devices/net.rst
@@ -1,4 +1,4 @@
-.. _pcsys_005fnetwork:
+.. _Network_Emulation:
 
 Network emulation
 -----------------
diff --git a/docs/system/devices/usb.rst b/docs/system/devices/usb.rst
index 37cb9b33aea..74166810731 100644
--- a/docs/system/devices/usb.rst
+++ b/docs/system/devices/usb.rst
@@ -1,5 +1,3 @@
-.. _pcsys_005fusb:
-
 USB emulation
 -------------
 
diff --git a/docs/system/keys.rst b/docs/system/keys.rst
index e596ae6c4e7..0fc17b994d3 100644
--- a/docs/system/keys.rst
+++ b/docs/system/keys.rst
@@ -1,4 +1,4 @@
-.. _pcsys_005fkeys:
+.. _GUI_keys:
 
 Keys in the graphical frontends
 -------------------------------
diff --git a/docs/system/linuxboot.rst b/docs/system/linuxboot.rst
index 228650abc5e..5db2e560dc5 100644
--- a/docs/system/linuxboot.rst
+++ b/docs/system/linuxboot.rst
@@ -27,4 +27,4 @@ virtual serial port and the QEMU monitor to the console with the
                     -append "root=/dev/hda console=ttyS0" -nographic
 
 Use Ctrl-a c to switch between the serial console and the monitor (see
-:ref:`pcsys_005fkeys`).
+:ref:`GUI_keys`).
diff --git a/docs/system/target-i386.rst b/docs/system/target-i386.rst
index 77c2f3b9799..1b8a1f248ab 100644
--- a/docs/system/target-i386.rst
+++ b/docs/system/target-i386.rst
@@ -3,8 +3,6 @@
 x86 System emulator
 -------------------
 
-.. _pcsys_005fdevices:
-
 Board-specific documentation
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
@@ -32,8 +30,6 @@ Architectural features
    i386/sgx
    i386/amd-memory-encryption
 
-.. _pcsys_005freq:
-
 OS requirements
 ~~~~~~~~~~~~~~~
 
-- 
2.34.1

Re: [PATCH] docs: Remove unused weirdly-named cross-reference targets

[Peter Maydell]

Ping for code review?

thanks
-- PMM

On Fri, 21 Apr 2023 at 17:36, Peter Maydell <peter.maydell@linaro.org> wrote:
>
> In the doc sources, we have a few cross-reference targets with odd
> names "pcsys_005fxyz".  These are the legacy of the semi-automated
> conversion of the old info docs to rST (the '005f' is because ASCII
> 0x5f is '_' and the old info link names had underscores in them).
>
> Remove the targets which nothing links to, and rename the two targets
> which are used to something a bit more descriptive.
>
> Signed-off-by: Peter Maydell <peter.maydell@linaro.org>
> ---
>  docs/system/devices/igb.rst     | 2 +-
>  docs/system/devices/ivshmem.rst | 2 --
>  docs/system/devices/net.rst     | 2 +-
>  docs/system/devices/usb.rst     | 2 --
>  docs/system/keys.rst            | 2 +-
>  docs/system/linuxboot.rst       | 2 +-
>  docs/system/target-i386.rst     | 4 ----
>  7 files changed, 4 insertions(+), 12 deletions(-)
>
> diff --git a/docs/system/devices/igb.rst b/docs/system/devices/igb.rst
> index 70edadd5743..0bcdd857473 100644
> --- a/docs/system/devices/igb.rst
> +++ b/docs/system/devices/igb.rst
> @@ -29,7 +29,7 @@ Using igb
>  =========
>
>  Using igb should be nothing different from using another network device. See
> -:ref:`pcsys_005fnetwork` in general.
> +:ref:`Network_emulation` in general.
>
>  However, you may also need to perform additional steps to activate SR-IOV
>  feature on your guest. For Linux, refer to [4]_.
> diff --git a/docs/system/devices/ivshmem.rst b/docs/system/devices/ivshmem.rst
> index b03a48afa3a..e7aaf34c200 100644
> --- a/docs/system/devices/ivshmem.rst
> +++ b/docs/system/devices/ivshmem.rst
> @@ -1,5 +1,3 @@
> -.. _pcsys_005fivshmem:
> -
>  Inter-VM Shared Memory device
>  -----------------------------
>
> diff --git a/docs/system/devices/net.rst b/docs/system/devices/net.rst
> index 4b2640c448e..2ab516d4b09 100644
> --- a/docs/system/devices/net.rst
> +++ b/docs/system/devices/net.rst
> @@ -1,4 +1,4 @@
> -.. _pcsys_005fnetwork:
> +.. _Network_Emulation:
>
>  Network emulation
>  -----------------
> diff --git a/docs/system/devices/usb.rst b/docs/system/devices/usb.rst
> index 37cb9b33aea..74166810731 100644
> --- a/docs/system/devices/usb.rst
> +++ b/docs/system/devices/usb.rst
> @@ -1,5 +1,3 @@
> -.. _pcsys_005fusb:
> -
>  USB emulation
>  -------------
>
> diff --git a/docs/system/keys.rst b/docs/system/keys.rst
> index e596ae6c4e7..0fc17b994d3 100644
> --- a/docs/system/keys.rst
> +++ b/docs/system/keys.rst
> @@ -1,4 +1,4 @@
> -.. _pcsys_005fkeys:
> +.. _GUI_keys:
>
>  Keys in the graphical frontends
>  -------------------------------
> diff --git a/docs/system/linuxboot.rst b/docs/system/linuxboot.rst
> index 228650abc5e..5db2e560dc5 100644
> --- a/docs/system/linuxboot.rst
> +++ b/docs/system/linuxboot.rst
> @@ -27,4 +27,4 @@ virtual serial port and the QEMU monitor to the console with the
>                      -append "root=/dev/hda console=ttyS0" -nographic
>
>  Use Ctrl-a c to switch between the serial console and the monitor (see
> -:ref:`pcsys_005fkeys`).
> +:ref:`GUI_keys`).
> diff --git a/docs/system/target-i386.rst b/docs/system/target-i386.rst
> index 77c2f3b9799..1b8a1f248ab 100644
> --- a/docs/system/target-i386.rst
> +++ b/docs/system/target-i386.rst
> @@ -3,8 +3,6 @@
>  x86 System emulator
>  -------------------
>
> -.. _pcsys_005fdevices:
> -
>  Board-specific documentation
>  ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
>
> @@ -32,8 +30,6 @@ Architectural features
>     i386/sgx
>     i386/amd-memory-encryption
>
> -.. _pcsys_005freq:
> -
>  OS requirements
>  ~~~~~~~~~~~~~~~
>
> --
> 2.34.1
>

Re: [PATCH] docs: Remove unused weirdly-named cross-reference targets

[Markus Armbruster]

Peter Maydell <peter.maydell@linaro.org> writes:

> In the doc sources, we have a few cross-reference targets with odd
> names "pcsys_005fxyz".  These are the legacy of the semi-automated
> conversion of the old info docs to rST (the '005f' is because ASCII
> 0x5f is '_' and the old info link names had underscores in them).
>
> Remove the targets which nothing links to, and rename the two targets
> which are used to something a bit more descriptive.
>
> Signed-off-by: Peter Maydell <peter.maydell@linaro.org>

Reviewed-by: Markus Armbruster <armbru@redhat.com>

Re: [PATCH] docs: Remove unused weirdly-named cross-reference targets

[Peter Maydell]

On Tue, 9 May 2023 at 14:28, Markus Armbruster <armbru@redhat.com> wrote:
>
> Peter Maydell <peter.maydell@linaro.org> writes:
>
> > In the doc sources, we have a few cross-reference targets with odd
> > names "pcsys_005fxyz".  These are the legacy of the semi-automated
> > conversion of the old info docs to rST (the '005f' is because ASCII
> > 0x5f is '_' and the old info link names had underscores in them).
> >
> > Remove the targets which nothing links to, and rename the two targets
> > which are used to something a bit more descriptive.
> >
> > Signed-off-by: Peter Maydell <peter.maydell@linaro.org>
>
> Reviewed-by: Markus Armbruster <armbru@redhat.com>

Thanks; I'll take this via target-arm.next since I'm doing
a pullreq this week anyway.

-- PMM