sphinx/qapidoc: Do not emit TODO sections into user manuals
commitf57e1d05bfaf2f41f0793280886ebf1db753794f
authorMarkus Armbruster <armbru@redhat.com>
Fri, 28 Apr 2023 10:54:18 +0000 (28 12:54 +0200)
committerMarkus Armbruster <armbru@redhat.com>
Tue, 9 May 2023 07:10:14 +0000 (9 09:10 +0200)
treef677e908b64b55679275cb0671bcf40c1caf7c20
parentb71fd73cc459ce1ef545a40ff8fbce5ff242b103
sphinx/qapidoc: Do not emit TODO sections into user manuals

QAPI doc comments are for QMP users: they go into the "QEMU QMP
Reference Manual" and the "QEMU Storage Daemon QMP Reference Manual".

The doc comment TODO sections are for somebody else, namely for the
people who can do: developers.  Do not emit them into the user
manuals.

This elides the following TODOs:

* SchemaInfoCommand

  # TODO: @success-response (currently irrelevant, because it's QGA, not QMP)

  This is a note to developers adding introspection to the guest
  agent.  It makes no sense to users.

* @query-hotpluggable-cpus

  # TODO: Better documentation; currently there is none.

  This is a reminder for developers.  It doesn't help users.

* @device_add

  # TODO: This command effectively bypasses QAPI completely due to its
  #       "additional arguments" business.  It shouldn't have been added to
  #       the schema in this form.  It should be qapified properly, or
  #       replaced by a properly qapified command.

  Likewise.

Eliding them is an improvement.

Signed-off-by: Markus Armbruster <armbru@redhat.com>
Message-Id: <20230428105429.1687850-7-armbru@redhat.com>
Reviewed-by: Ani Sinha <anisinha@redhat.com>
Reviewed-by: Juan Quintela <quintela@redhat.com>
docs/devel/qapi-code-gen.rst
docs/sphinx/qapidoc.py