In rST documents, an '@' character in normal text or a parsed-literal is assumed to be an email address and will result in a 'mailto:' hyperlink in the generated HTML. In several places we have mailto: hyperlinks that are unintended nonsense; correct these by either escaping the @ character or making the text use ``...`` preformatted rendering.
This commit covers only the simple cases which can be trivially fixed with escaping or ``..``; the remaining cases will be handled in separate commits. Signed-off-by: Peter Maydell <[email protected]> --- docs/devel/submitting-a-patch.rst | 2 +- docs/system/device-url-syntax.rst.inc | 4 ++-- docs/system/vnc-security.rst | 6 +++--- 3 files changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/devel/submitting-a-patch.rst b/docs/devel/submitting-a-patch.rst index dd1cf32ad3..5ccd09a397 100644 --- a/docs/devel/submitting-a-patch.rst +++ b/docs/devel/submitting-a-patch.rst @@ -18,7 +18,7 @@ one-shot fix, the bare minimum we ask is that: * - Check - Reason - * - Patches contain Signed-off-by: Your Name <author@email> + * - Patches contain ``Signed-off-by: Your Name <author@email>`` - States you are legally able to contribute the code. See :ref:`patch_emails_must_include_a_signed_off_by_line` * - Sent as patch emails to ``[email protected]`` - The project uses an email list based workflow. See :ref:`submitting_your_patches` diff --git a/docs/system/device-url-syntax.rst.inc b/docs/system/device-url-syntax.rst.inc index 43b5c2596b..aae65d138c 100644 --- a/docs/system/device-url-syntax.rst.inc +++ b/docs/system/device-url-syntax.rst.inc @@ -33,7 +33,7 @@ These are specified using a special URL syntax. .. parsed-literal:: - |qemu_system| -drive file=iscsi://user%[email protected]/iqn.2001-04.com.example/1 + |qemu_system| -drive file=iscsi://user%password\@192.0.2.1/iqn.2001-04.com.example/1 Example (CHAP username/password via environment variables): @@ -79,7 +79,7 @@ These are specified using a special URL syntax. .. parsed-literal:: - |qemu_system| -drive file=ssh://user@host/path/to/disk.img + |qemu_system| -drive file=ssh://user\@host/path/to/disk.img |qemu_system| -drive file.driver=ssh,file.user=user,file.host=host,file.port=22,file.path=/path/to/disk.img Currently authentication must be done using ssh-agent. Other diff --git a/docs/system/vnc-security.rst b/docs/system/vnc-security.rst index 4c1769eeb8..97e94ff407 100644 --- a/docs/system/vnc-security.rst +++ b/docs/system/vnc-security.rst @@ -182,9 +182,9 @@ When not using TLS the recommended configuration is This says to use the 'GSSAPI' mechanism with the Kerberos v5 protocol, with the server principal stored in /etc/qemu/krb5.tab. For this to work the administrator of your KDC must generate a Kerberos principal for the -server, with a name of 'qemu/[email protected]' replacing -'somehost.example.com' with the fully qualified host name of the machine -running QEMU, and 'EXAMPLE.COM' with the Kerberos Realm. +server, with a name of ``qemu/[email protected]`` replacing +``somehost.example.com`` with the fully qualified host name of the machine +running QEMU, and ``EXAMPLE.COM`` with the Kerberos Realm. When using TLS, if username+password authentication is desired, then a reasonable configuration is -- 2.47.3
