qemu-devel.nongnu.org archive mirror
 help / color / mirror / Atom feed
From: Markus Armbruster <armbru@redhat.com>
To: qemu-devel@nongnu.org
Cc: peter.maydell@linaro.org, "Daniel P . Berrangé" <berrange@redhat.com>
Subject: [PULL 05/18] sphinx/qapidoc: Drop code to generate doc for simple union tag
Date: Mon, 12 Feb 2024 10:14:23 +0100	[thread overview]
Message-ID: <20240212091436.688598-6-armbru@redhat.com> (raw)
In-Reply-To: <20240212091436.688598-1-armbru@redhat.com>

QAPISchemaGenRSTVisitor._nodes_for_members() has a special case to
auto-generate documentation for a union tag member of implicit (enum)
type that lacks documentation.

This was useful for simple unions, where the tag member's type was
implicitly.  The only implicit enum type left today is 'QType'.  Not
worth a special case.  Drop.  No change to generated documentation.

Signed-off-by: Markus Armbruster <armbru@redhat.com>
Message-ID: <20240205074709.3613229-6-armbru@redhat.com>
Reviewed-by: Daniel P. Berrangé <berrange@redhat.com>
---
 docs/sphinx/qapidoc.py | 6 ------
 1 file changed, 6 deletions(-)

diff --git a/docs/sphinx/qapidoc.py b/docs/sphinx/qapidoc.py
index 658c288f8f..05b809af27 100644
--- a/docs/sphinx/qapidoc.py
+++ b/docs/sphinx/qapidoc.py
@@ -168,12 +168,6 @@ def _nodes_for_members(self, doc, what, base=None, variants=None):
             # TODO drop fallbacks when undocumented members are outlawed
             if section.text:
                 defn = section.text
-            elif (variants and variants.tag_member == section.member
-                  and not section.member.type.doc_type()):
-                values = section.member.type.member_names()
-                defn = [nodes.Text('One of ')]
-                defn.extend(intersperse([nodes.literal('', v) for v in values],
-                                        nodes.Text(', ')))
             else:
                 defn = [nodes.Text('Not documented')]
 
-- 
2.43.0



  parent reply	other threads:[~2024-02-12  9:16 UTC|newest]

Thread overview: 20+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2024-02-12  9:14 [PULL 00/18] QAPI patches patches for 2024-02-12 Markus Armbruster
2024-02-12  9:14 ` [PULL 01/18] docs/devel/qapi-code-gen: Normalize version refs x.y.0 to just x.y Markus Armbruster
2024-02-12  9:14 ` [PULL 02/18] docs/devel/qapi-code-gen: Tweak doc comment whitespace Markus Armbruster
2024-02-12  9:14 ` [PULL 03/18] qapi/block-core: Fix BlockLatencyHistogramInfo doc markup Markus Armbruster
2024-02-12  9:14 ` [PULL 04/18] qapi: Indent tagged doc comment sections properly Markus Armbruster
2024-02-12  9:14 ` Markus Armbruster [this message]
2024-02-12  9:14 ` [PULL 06/18] qapi: Require member documentation (with loophole) Markus Armbruster
2024-02-12  9:14 ` [PULL 07/18] qga/qapi-schema: Clean up documentation of guest-set-memory-blocks Markus Armbruster
2024-02-12  9:14 ` [PULL 08/18] qga/qapi-schema: Clean up documentation of guest-set-vcpus Markus Armbruster
2024-02-12  9:14 ` [PULL 09/18] qga/qapi-schema: Plug trivial documentation holes Markus Armbruster
2024-02-12  9:14 ` [PULL 10/18] qapi/yank: Clean up documentaion of yank Markus Armbruster
2024-02-12  9:14 ` [PULL 11/18] qapi/dump: Clean up documentation of DumpGuestMemoryCapability Markus Armbruster
2024-02-12  9:14 ` [PULL 12/18] qapi: Plug trivial documentation holes around former simple unions Markus Armbruster
2024-02-12  9:14 ` [PULL 13/18] qapi: Improve documentation of file descriptor socket addresses Markus Armbruster
2024-02-12  9:14 ` [PULL 14/18] qapi: Move @String out of common.json to discourage reuse Markus Armbruster
2024-02-12  9:14 ` [PULL 15/18] qapi: Add missing union tag documentation Markus Armbruster
2024-02-12  9:14 ` [PULL 16/18] qapi/migration: Add missing tls-authz documentation Markus Armbruster
2024-02-12  9:14 ` [PULL 17/18] MAINTAINERS: Cover qapi/cxl.json Markus Armbruster
2024-02-12  9:14 ` [PULL 18/18] MAINTAINERS: Cover qapi/stats.json Markus Armbruster
2024-02-13 13:55 ` [PULL 00/18] QAPI patches patches for 2024-02-12 Peter Maydell

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=20240212091436.688598-6-armbru@redhat.com \
    --to=armbru@redhat.com \
    --cc=berrange@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).