qemu-devel.nongnu.org archive mirror
 help / color / mirror / Atom feed
From: John Snow <jsnow@redhat.com>
To: Peter Maydell <peter.maydell@linaro.org>, qemu-devel@nongnu.org
Cc: Markus Armbruster <armbru@redhat.com>
Subject: Re: [PATCH v6 00/21] Convert QAPI doc comments to generate rST instead of texinfo
Date: Fri, 25 Sep 2020 12:54:12 -0400	[thread overview]
Message-ID: <5d9726b1-e4f7-f9a3-02ca-9f893925c6ce@redhat.com> (raw)
In-Reply-To: <20200925162316.21205-1-peter.maydell@linaro.org>

On 9/25/20 12:22 PM, Peter Maydell wrote:
>   * although there are HTML anchors on all the command/object/etc
>     headings, they are not stable but just serial-number based
>     tags like '#qapidoc-35', so not suitable for trying to link
>     to from other parts of the docs

I suppose this answers my question if qmp commands were going to be able 
to be cross-referenced yet.

I'd love to get that working so I can make smart references in the 
bitmaps doc.

We could even amend the QMP code parser to insert cross-references to 
the function names, which would be *extremely* slick.

--js



  parent reply	other threads:[~2020-09-25 16:55 UTC|newest]

Thread overview: 69+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-09-25 16:22 [PATCH v6 00/21] Convert QAPI doc comments to generate rST instead of texinfo Peter Maydell
2020-09-25 16:22 ` [PATCH v6 01/21] qapi: Fix doc comment indentation again Peter Maydell
2020-09-28 12:39   ` Markus Armbruster
2020-09-25 16:22 ` [PATCH v6 02/21] qapi/block.json: Add newline after "Example:" for block-latency-histogram-set Peter Maydell
2020-09-28 12:42   ` Markus Armbruster
2020-09-28 12:49     ` Peter Maydell
2020-09-28 18:04       ` Markus Armbruster
2020-09-25 16:22 ` [PATCH v6 03/21] tests/qapi/doc-good.json: Prepare for qapi-doc Sphinx extension Peter Maydell
2020-09-25 16:22 ` [PATCH v6 04/21] scripts/qapi: Move doc-comment whitespace stripping to doc.py Peter Maydell
2020-09-25 16:23 ` [PATCH v6 05/21] scripts/qapi/parser.py: improve doc comment indent handling Peter Maydell
2020-09-28 19:15   ` Markus Armbruster
2020-09-29  8:55     ` Peter Maydell
2020-09-29 13:03       ` Markus Armbruster
2020-09-25 16:23 ` [PATCH v6 06/21] qapi/machine.json: Escape a literal '*' in doc comment Peter Maydell
2020-09-29  4:57   ` Markus Armbruster
2020-09-25 16:23 ` [PATCH v6 07/21] docs/sphinx: Add new qapi-doc Sphinx extension Peter Maydell
2020-09-29  6:54   ` Markus Armbruster
2020-09-29  9:05     ` Peter Maydell
2020-09-25 16:23 ` [PATCH v6 08/21] docs/interop: Convert qemu-ga-ref to rST Peter Maydell
2020-09-29  8:20   ` Markus Armbruster
2020-09-29  9:26     ` Peter Maydell
2020-09-29 13:11       ` Markus Armbruster
2020-09-29 14:25         ` Markus Armbruster
2020-09-25 16:23 ` [PATCH v6 09/21] docs/interop: Convert qemu-qmp-ref " Peter Maydell
2020-09-29  8:27   ` Markus Armbruster
2020-09-29  9:41     ` Peter Maydell
2020-09-29 13:12       ` Markus Armbruster
2020-09-29  8:42   ` Markus Armbruster
2020-09-29  9:46     ` Peter Maydell
2020-09-29 13:13       ` Markus Armbruster
2020-09-25 16:23 ` [PATCH v6 10/21] qapi: Use rST markup for literal blocks Peter Maydell
2020-09-25 16:23 ` [PATCH v6 11/21] qga/qapi-schema.json: Add some headings Peter Maydell
2020-09-29  8:30   ` Markus Armbruster
2020-09-25 16:23 ` [PATCH v6 12/21] tests/qapi-schema: Convert doc-good.json to rST-style strong/emphasis Peter Maydell
2020-09-29  8:33   ` Markus Armbruster
2020-09-25 16:23 ` [PATCH v6 13/21] meson.build: Move SPHINX_ARGS to top level meson.build file Peter Maydell
2020-09-29  8:45   ` Markus Armbruster
2020-09-25 16:23 ` [PATCH v6 14/21] meson.build: Make manuals depend on source to Sphinx extensions Peter Maydell
2020-09-29  8:52   ` Markus Armbruster
2020-09-25 16:23 ` [PATCH v6 15/21] tests/qapi-schema: Add test of the rST QAPI doc-comment outputn Peter Maydell
2020-09-29 12:20   ` Markus Armbruster
2020-09-29 12:33     ` Peter Maydell
2020-09-29 13:18       ` Markus Armbruster
2020-09-25 16:23 ` [PATCH v6 16/21] scripts/qapi: Remove texinfo generation support Peter Maydell
2020-09-29 12:22   ` Markus Armbruster
2020-09-25 16:23 ` [PATCH v6 17/21] docs/devel/qapi-code-gen.txt: Update to new rST backend conventions Peter Maydell
2020-09-29 12:35   ` Markus Armbruster
2020-09-29 12:43     ` Peter Maydell
2020-09-29 13:27       ` Markus Armbruster
2020-09-25 16:23 ` [PATCH v6 18/21] scripts/texi2pod: Delete unused script Peter Maydell
2020-09-29 12:36   ` Markus Armbruster
2020-09-25 16:23 ` [PATCH v6 19/21] Remove Texinfo related line from git.orderfile Peter Maydell
2020-09-29 12:37   ` Markus Armbruster
2020-09-25 16:23 ` [PATCH v6 20/21] configure: Drop texinfo requirement Peter Maydell
2020-09-29 12:38   ` Markus Armbruster
2020-09-25 16:23 ` [PATCH v6 21/21] Remove texinfo dependency from docker and CI configs Peter Maydell
2020-09-29 12:39   ` Markus Armbruster
2020-09-25 16:54 ` John Snow [this message]
2020-09-25 17:02   ` [PATCH v6 00/21] Convert QAPI doc comments to generate rST instead of texinfo Peter Maydell
2020-09-25 17:09     ` John Snow
2020-09-25 19:25 ` no-reply
2020-09-25 21:37   ` Peter Maydell
2020-09-28 13:04     ` Markus Armbruster
2020-09-28 13:05       ` Peter Maydell
2020-09-29 15:26         ` Markus Armbruster
2020-09-29 15:43           ` Peter Maydell
2020-09-25 19:25 ` no-reply
2020-09-29 13:31 ` Markus Armbruster
2020-09-29 20:17 ` Markus Armbruster

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=5d9726b1-e4f7-f9a3-02ca-9f893925c6ce@redhat.com \
    --to=jsnow@redhat.com \
    --cc=armbru@redhat.com \
    --cc=peter.maydell@linaro.org \
    --cc=qemu-devel@nongnu.org \
    /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 a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).