diff mbox series

[11/15] qapi/dump: Clean up documentation of DumpGuestMemoryCapability

Message ID 20240205074709.3613229-12-armbru@redhat.com
State New
Headers show
Series qapi: Require member documentation (with loophole) | expand

Commit Message

Markus Armbruster Feb. 5, 2024, 7:47 a.m. UTC
The type's doc comment describes its member, but it's not marked up as
such.  Easy enough to fix.

Signed-off-by: Markus Armbruster <armbru@redhat.com>
---
 qapi/dump.json   | 2 +-
 qapi/pragma.json | 1 -
 2 files changed, 1 insertion(+), 2 deletions(-)

Comments

Daniel P. Berrangé Feb. 7, 2024, 8:35 a.m. UTC | #1
On Mon, Feb 05, 2024 at 08:47:05AM +0100, Markus Armbruster wrote:
> The type's doc comment describes its member, but it's not marked up as
> such.  Easy enough to fix.
> 
> Signed-off-by: Markus Armbruster <armbru@redhat.com>
> ---
>  qapi/dump.json   | 2 +-
>  qapi/pragma.json | 1 -
>  2 files changed, 1 insertion(+), 2 deletions(-)

Reviewed-by: Daniel P. Berrangé <berrange@redhat.com>


With regards,
Daniel
diff mbox series

Patch

diff --git a/qapi/dump.json b/qapi/dump.json
index 5cbc237ad9..1997c1d1d4 100644
--- a/qapi/dump.json
+++ b/qapi/dump.json
@@ -186,7 +186,7 @@ 
 ##
 # @DumpGuestMemoryCapability:
 #
-# A list of the available formats for dump-guest-memory
+# @formats: the available formats for dump-guest-memory
 #
 # Since: 2.0
 ##
diff --git a/qapi/pragma.json b/qapi/pragma.json
index 544f138afa..aea6384255 100644
--- a/qapi/pragma.json
+++ b/qapi/pragma.json
@@ -74,7 +74,6 @@ 
         'DummyBlockCoreForceArrays',
         'DummyForceArrays',
         'DummyVirtioForceArrays',
-        'DumpGuestMemoryCapability',
         'GrabToggleKeys',
         'GuestPanicInformationHyperV',
         'HotKeyMod',