All of lore.kernel.org
 help / color / mirror / Atom feed
From: Peter Maydell <peter.maydell@linaro.org>
To: Thomas Huth <thuth@redhat.com>
Cc: QEMU Developers <qemu-devel@nongnu.org>,
	Gerd Hoffmann <kraxel@redhat.com>
Subject: Re: [PATCH for-5.2] docs: Get rid of the weird _005f links in the man page
Date: Mon, 16 Nov 2020 15:32:12 +0000	[thread overview]
Message-ID: <CAFEAcA9DGwpG2JE-=-EUf6G6ER0U0gy+aW69=hkrkUSDTrKsRQ@mail.gmail.com> (raw)
In-Reply-To: <20201116145341.91606-1-thuth@redhat.com>

On Mon, 16 Nov 2020 at 14:53, Thomas Huth <thuth@redhat.com> wrote:
>
> 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.

The "_005f" is a legacy from the automatic conversion from Texinfo.
In Texinfo, link names could not contain underscores and so for
instance the link to the GDB usage was "gdb_usage". The conversion
to rST seems to have taken a broad view of what might be a
punctuation character that needed escaping, and so converted the '_'
into a hex-representation (ASCII 0x5f being '_'), giving
"gdb_005fusage".

thanks
-- PMM


      reply	other threads:[~2020-11-16 15:33 UTC|newest]

Thread overview: 2+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-11-16 14:53 [PATCH for-5.2] docs: Get rid of the weird _005f links in the man page Thomas Huth
2020-11-16 15:32 ` Peter Maydell [this message]

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to='CAFEAcA9DGwpG2JE-=-EUf6G6ER0U0gy+aW69=hkrkUSDTrKsRQ@mail.gmail.com' \
    --to=peter.maydell@linaro.org \
    --cc=kraxel@redhat.com \
    --cc=qemu-devel@nongnu.org \
    --cc=thuth@redhat.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body. 
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.