From 923e931188dcbb72387961d313478b80ffc75231 Mon Sep 17 00:00:00 2001 From: Thomas Huth Date: Mon, 16 Nov 2020 15:47:36 +0100 Subject: docs: Get rid of the weird _005f links in the man page The man page does not contain all the chapters from the System Emulation Users Guide, so some of the links that we've put into the qemu options descriptions can not be resolved and thus the link names are used in the man pages instead. These link names currently contain weird "_005f" letters in the middle and just do not make any sense for the users. To avoid this situation, replace the link names with more descriptive, natural text. Message-Id: <20201116145341.91606-1-thuth@redhat.com> Resolves: https://gitlab.com/qemu-project/qemu/-/issues/3 Buglink: https://bugs.launchpad.net/qemu/+bug/1453608 Signed-off-by: Thomas Huth --- docs/system/gdb.rst | 2 +- docs/system/images.rst | 2 +- docs/system/monitor.rst | 2 +- docs/system/mux-chardev.rst | 2 +- docs/system/usb.rst | 6 +++--- docs/system/vnc-security.rst | 2 +- 6 files changed, 8 insertions(+), 8 deletions(-) (limited to 'docs') diff --git a/docs/system/gdb.rst b/docs/system/gdb.rst index abda961..72b1e68 100644 --- a/docs/system/gdb.rst +++ b/docs/system/gdb.rst @@ -1,4 +1,4 @@ -.. _gdb_005fusage: +.. _GDB usage: GDB usage --------- diff --git a/docs/system/images.rst b/docs/system/images.rst index ff26bf9..3d9144e 100644 --- a/docs/system/images.rst +++ b/docs/system/images.rst @@ -1,4 +1,4 @@ -.. _disk_005fimages: +.. _disk images: Disk Images ----------- diff --git a/docs/system/monitor.rst b/docs/system/monitor.rst index 0bcd5da..ff5c434 100644 --- a/docs/system/monitor.rst +++ b/docs/system/monitor.rst @@ -1,4 +1,4 @@ -.. _pcsys_005fmonitor: +.. _QEMU monitor: QEMU Monitor ------------ diff --git a/docs/system/mux-chardev.rst b/docs/system/mux-chardev.rst index 413a6b3..0506406 100644 --- a/docs/system/mux-chardev.rst +++ b/docs/system/mux-chardev.rst @@ -1,4 +1,4 @@ -.. _mux_005fkeys: +.. _keys in the character backend multiplexer: Keys in the character backend multiplexer ----------------------------------------- diff --git a/docs/system/usb.rst b/docs/system/usb.rst index 9a2f192..eeab78d 100644 --- a/docs/system/usb.rst +++ b/docs/system/usb.rst @@ -8,7 +8,7 @@ plug virtual USB devices or real host USB devices (only works with certain host operating systems). QEMU will automatically create and connect virtual USB hubs as necessary to connect multiple USB devices. -.. _usb_005fdevices: +.. _Connecting USB devices: Connecting USB devices ~~~~~~~~~~~~~~~~~~~~~~ @@ -27,8 +27,8 @@ option or the ``device_add`` monitor command. Available devices are: activated. ``usb-storage,drive=drive_id`` - Mass storage device backed by drive_id (see - :ref:`disk_005fimages`) + Mass storage device backed by drive_id (see the :ref:`disk images` + chapter in the System Emulation Users Guide) ``usb-uas`` USB attached SCSI device, see diff --git a/docs/system/vnc-security.rst b/docs/system/vnc-security.rst index b237b07..558e4fa 100644 --- a/docs/system/vnc-security.rst +++ b/docs/system/vnc-security.rst @@ -1,4 +1,4 @@ -.. _vnc_005fsecurity: +.. _VNC security: VNC security ------------ -- cgit v1.1