From nobody Sat May 4 10:23:33 2024 Delivered-To: importer@patchew.org Authentication-Results: mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org; dmarc=pass(p=none dis=none) header.from=redhat.com ARC-Seal: i=1; a=rsa-sha256; t=1605538517; cv=none; d=zohomail.com; s=zohoarc; b=dWrV5PQP0fPDeY8w2jTeIEWGQIYcHc+8+AAEZLBBuZQV5KW7ocVIdAmkMUTO+f9bjSnV1t7sMVPtsNb3iZJvE2u4vYUMtxl/wno50e44zod4/4Uz3Cf7+OnR4Nwcq/wMqmrKSYbbgHODAKUDCP2OTa8R/x2Vs3pLPWux0ugI5Ys= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1605538517; h=Content-Type:Cc:Date:From:List-Subscribe:List-Post:List-Id:List-Archive:List-Help:List-Unsubscribe:Message-ID:Sender:Subject:To; bh=Fa31cEMVQCJrD3MDjg6monyvli9YCJF8tuHiqOcIoGo=; b=ZNk5gHDv59LK3nHsadKfp5wj48ueYKOT9JB0sQh2B9EaCEZL224PRK9XJHbUZ02nTKUwjMBqoUjle8Fl+rgZiA8dlxnmDp0W/BUvVH6/zIaAGqOIw/XMDgcqU0Zs/ri2GSVnVMLo93Mxl7qcdj98DPNqiA/+PFxcRSHy98D42Pk= ARC-Authentication-Results: i=1; mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org; dmarc=pass header.from= (p=none dis=none) header.from= Return-Path: Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) by mx.zohomail.com with SMTPS id 1605538517359442.2201947978847; Mon, 16 Nov 2020 06:55:17 -0800 (PST) Received: from localhost ([::1]:33516 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1kefuU-00041W-VT for importer@patchew.org; Mon, 16 Nov 2020 09:55:15 -0500 Received: from eggs.gnu.org ([2001:470:142:3::10]:35652) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1keftE-0003Zu-RJ for qemu-devel@nongnu.org; Mon, 16 Nov 2020 09:53:56 -0500 Received: from us-smtp-delivery-124.mimecast.com ([63.128.21.124]:58111) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_CBC_SHA1:256) (Exim 4.90_1) (envelope-from ) id 1keftC-0006kS-HE for qemu-devel@nongnu.org; Mon, 16 Nov 2020 09:53:56 -0500 Received: from mimecast-mx01.redhat.com (mimecast-mx01.redhat.com [209.132.183.4]) (Using TLS) by relay.mimecast.com with ESMTP id us-mta-418-WoXxFSv1OXKNhs-K1uixrQ-1; Mon, 16 Nov 2020 09:53:50 -0500 Received: from smtp.corp.redhat.com (int-mx05.intmail.prod.int.phx2.redhat.com [10.5.11.15]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx01.redhat.com (Postfix) with ESMTPS id 9129110866A1; Mon, 16 Nov 2020 14:53:49 +0000 (UTC) Received: from thuth.com (ovpn-113-126.ams2.redhat.com [10.36.113.126]) by smtp.corp.redhat.com (Postfix) with ESMTP id 2B69E55764; Mon, 16 Nov 2020 14:53:43 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1605538433; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:content-type:content-type; bh=Fa31cEMVQCJrD3MDjg6monyvli9YCJF8tuHiqOcIoGo=; b=hk34pcAqakssmTyUJ50To7WKPdlmEz8SGiZd9VVmnUECiAgxc8MWESmop9pDehBWnYR5qA wiQV80SN8RSzkRovAoHuQqh6rCnR/XbkuJ92miEXwhNgsp68FAkqOW1g5yyw8k8Z8QC/AV QoD2kSt5UCYgJMXaY9uPnWiTQgBYa2c= X-MC-Unique: WoXxFSv1OXKNhs-K1uixrQ-1 From: Thomas Huth To: qemu-devel@nongnu.org, Peter Maydell Subject: [PATCH for-5.2] docs: Get rid of the weird _005f links in the man page Date: Mon, 16 Nov 2020 15:53:41 +0100 Message-Id: <20201116145341.91606-1-thuth@redhat.com> X-Scanned-By: MIMEDefang 2.79 on 10.5.11.15 Authentication-Results: relay.mimecast.com; auth=pass smtp.auth=CUSA124A263 smtp.mailfrom=thuth@redhat.com X-Mimecast-Spam-Score: 0 X-Mimecast-Originator: redhat.com Received-SPF: pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) client-ip=209.51.188.17; envelope-from=qemu-devel-bounces+importer=patchew.org@nongnu.org; helo=lists.gnu.org; Received-SPF: pass client-ip=63.128.21.124; envelope-from=thuth@redhat.com; helo=us-smtp-delivery-124.mimecast.com X-detected-operating-system: by eggs.gnu.org: First seen = 2020/11/16 04:46:27 X-ACL-Warn: Detected OS = Linux 2.2.x-3.x [generic] [fuzzy] X-Spam_score_int: -20 X-Spam_score: -2.1 X-Spam_bar: -- X-Spam_report: (-2.1 / 5.0 requ) BAYES_00=-1.9, DKIMWL_WL_HIGH=-0.001, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, RCVD_IN_DNSWL_NONE=-0.0001, RCVD_IN_MSPIKE_H5=0.001, RCVD_IN_MSPIKE_WL=0.001, SPF_HELO_NONE=0.001, SPF_PASS=-0.001 autolearn=ham autolearn_force=no X-Spam_action: no action X-BeenThere: qemu-devel@nongnu.org X-Mailman-Version: 2.1.23 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: Gerd Hoffmann Errors-To: qemu-devel-bounces+importer=patchew.org@nongnu.org Sender: "Qemu-devel" X-ZohoMail-DKIM: pass (identity @redhat.com) Content-Transfer-Encoding: quoted-printable MIME-Version: 1.0 Content-Type: text/plain; charset="utf-8" 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. 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 +- qemu-options.hx | 38 +++++++++++++++++++----------------- 7 files changed, 28 insertions(+), 26 deletions(-) diff --git a/docs/system/gdb.rst b/docs/system/gdb.rst index abda961e2b..72b1e68f4e 100644 --- a/docs/system/gdb.rst +++ b/docs/system/gdb.rst @@ -1,4 +1,4 @@ -.. _gdb_005fusage: +.. _GDB usage: =20 GDB usage --------- diff --git a/docs/system/images.rst b/docs/system/images.rst index ff26bf9587..3d9144e625 100644 --- a/docs/system/images.rst +++ b/docs/system/images.rst @@ -1,4 +1,4 @@ -.. _disk_005fimages: +.. _disk images: =20 Disk Images ----------- diff --git a/docs/system/monitor.rst b/docs/system/monitor.rst index 0bcd5da216..ff5c434612 100644 --- a/docs/system/monitor.rst +++ b/docs/system/monitor.rst @@ -1,4 +1,4 @@ -.. _pcsys_005fmonitor: +.. _QEMU monitor: =20 QEMU Monitor ------------ diff --git a/docs/system/mux-chardev.rst b/docs/system/mux-chardev.rst index 413a6b3446..05064068aa 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: =20 Keys in the character backend multiplexer ----------------------------------------- diff --git a/docs/system/usb.rst b/docs/system/usb.rst index 9a2f1927c4..eeab78dcfb 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 wor= ks with certain host operating systems). QEMU will automatically create and connect virtual USB hubs as necessary to connect multiple USB devices. =20 -.. _usb_005fdevices: +.. _Connecting USB devices: =20 Connecting USB devices ~~~~~~~~~~~~~~~~~~~~~~ @@ -27,8 +27,8 @@ option or the ``device_add`` monitor command. Available d= evices are: activated. =20 ``usb-storage,drive=3Ddrive_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) =20 ``usb-uas`` USB attached SCSI device, see diff --git a/docs/system/vnc-security.rst b/docs/system/vnc-security.rst index b237b07330..558e4faffc 100644 --- a/docs/system/vnc-security.rst +++ b/docs/system/vnc-security.rst @@ -1,4 +1,4 @@ -.. _vnc_005fsecurity: +.. _VNC security: =20 VNC security ------------ diff --git a/qemu-options.hx b/qemu-options.hx index 2c83390504..104632ea34 100644 --- a/qemu-options.hx +++ b/qemu-options.hx @@ -913,8 +913,8 @@ SRST ``-fda file`` \ ``-fdb file`` - Use file as floppy disk 0/1 image (see - :ref:`disk_005fimages`). + Use file as floppy disk 0/1 image (see the :ref:`disk images` chapter = in + the System Emulation Users Guide). ERST =20 DEF("hda", HAS_ARG, QEMU_OPTION_hda, @@ -931,8 +931,8 @@ SRST ``-hdc file`` \=20 ``-hdd file`` - Use file as hard disk 0, 1, 2 or 3 image (see - :ref:`disk_005fimages`). + Use file as hard disk 0, 1, 2 or 3 image (see the :ref:`disk images` + chapter in the System Emulation Users Guide). ERST =20 DEF("cdrom", HAS_ARG, QEMU_OPTION_cdrom, @@ -1189,9 +1189,9 @@ SRST In addition, it knows the following options: =20 ``file=3Dfile`` - This option defines which disk image (see - :ref:`disk_005fimages`) to use with this drive. If - the filename contains comma, you must double it (for instance, + This option defines which disk image (see the :ref:`disk images` + chapter in the System Emulation Users Guide) to use with this driv= e. + If the filename contains comma, you must double it (for instance, "file=3Dmy,,file" to use file "my,file"). =20 Special files such as iSCSI devices can be specified using @@ -1400,8 +1400,8 @@ SRST ``-snapshot`` Write to temporary files instead of disk image files. In this case, the raw disk image you use is not written back. You can however - force the write back by pressing C-a s (see - :ref:`disk_005fimages`). + force the write back by pressing C-a s (see the :ref:`disk images` + chapter in the System Emulation Users Guide). ERST =20 DEF("fsdev", HAS_ARG, QEMU_OPTION_fsdev, @@ -1687,8 +1687,8 @@ DEF("usbdevice", HAS_ARG, QEMU_OPTION_usbdevice, SRST ``-usbdevice devname`` Add the USB device devname. Note that this option is deprecated, - please use ``-device usb-...`` instead. See - :ref:`usb_005fdevices`. + please use ``-device usb-...`` instead. See the chapter about + :ref:`Connecting USB devices` in the System Emulation Users Guide. =20 ``mouse`` Virtual Mouse. This will override the PS/2 mouse emulation when @@ -2110,7 +2110,7 @@ SRST connections. =20 The password must be set separately using the ``set_password`` - command in the :ref:`pcsys_005fmonitor`. The + command in the :ref:`QEMU monitor`. The syntax to change your password is: ``set_password `` where could be either "vnc" or "spice". @@ -2155,8 +2155,8 @@ SRST and 'x509' settings to enable use of SSL and server certificates. This ensures a data encryption preventing compromise of authentication credentials. See the - :ref:`vnc_005fsecurity` section for details on - using SASL authentication. + :ref:`VNC security` section in the System Emulation Users Guide + for details on using SASL authentication. =20 ``sasl-authz=3DID`` Provides the ID of the QAuthZ authorization object against which @@ -3082,7 +3082,9 @@ The general form of a character device option is: -serial chardev:char1 =20 When you're using a multiplexed character device, some escape - sequences are interpreted in the input. See :ref:`mux_005fkeys`. + sequences are interpreted in the input. See the chapter about + :ref:`keys in the character backend multiplexer` in the + System Emulation Users Guide for more details. =20 Note that some other command line options may implicitly create multiplexed character backends; for instance ``-serial mon:stdio`` @@ -3755,8 +3757,8 @@ DEF("gdb", HAS_ARG, QEMU_OPTION_gdb, \ QEMU_ARCH_ALL) SRST ``-gdb dev`` - Accept a gdb connection on device dev (see - :ref:`gdb_005fusage`). Note that this option does not pause QEMU + Accept a gdb connection on device dev (see the :ref:`GDB usage` chapter + in the System Emulation Users Guide). Note that this option does not p= ause QEMU execution -- if you want QEMU to not start the guest until you connect with gdb and issue a ``continue`` command, you will need to also pass the ``-S`` option to QEMU. @@ -3781,7 +3783,7 @@ DEF("s", 0, QEMU_OPTION_s, \ SRST ``-s`` Shorthand for -gdb tcp::1234, i.e. open a gdbserver on TCP port 1234 - (see :ref:`gdb_005fusage`). + (see the :ref:`GDB usage` chapter in the System Emulation Users Guide). ERST =20 DEF("d", HAS_ARG, QEMU_OPTION_d, \ --=20 2.18.4