[PATCH 2/5] qapi: Drop redundant documentation of conditional

Markus Armbruster posted 5 patches 10 months ago
Maintainers: Eric Blake <eblake@redhat.com>, Markus Armbruster <armbru@redhat.com>, Kevin Wolf <kwolf@redhat.com>, Hanna Reitz <hreitz@redhat.com>, Michael Roth <michael.roth@amd.com>, Konstantin Kostiuk <kkostiuk@redhat.com>
[PATCH 2/5] qapi: Drop redundant documentation of conditional
Posted by Markus Armbruster 10 months ago
Documentation generated for dump-skeys contains

    This command is only supported on s390 architecture.

and

    If
    ~~

    "TARGET_S390X"

The former became redundant in commit 901a34a400a (qapi: add 'If:'
section to generated documentation) added the latter.  Drop the
former.

Signed-off-by: Markus Armbruster <armbru@redhat.com>
---
 qapi/misc-target.json | 2 --
 1 file changed, 2 deletions(-)

diff --git a/qapi/misc-target.json b/qapi/misc-target.json
index 9195e7d26b..03e83c053f 100644
--- a/qapi/misc-target.json
+++ b/qapi/misc-target.json
@@ -237,8 +237,6 @@
 #
 # @filename: the path to the file to dump to
 #
-# This command is only supported on s390 architecture.
-#
 # Since: 2.5
 #
 # Example:
-- 
2.43.0
Re: [PATCH 2/5] qapi: Drop redundant documentation of conditional
Posted by Eric Blake 10 months ago
On Mon, Jan 29, 2024 at 12:50:05PM +0100, Markus Armbruster wrote:
> Documentation generated for dump-skeys contains
> 
>     This command is only supported on s390 architecture.
> 
> and
> 
>     If
>     ~~
> 
>     "TARGET_S390X"
> 
> The former became redundant in commit 901a34a400a (qapi: add 'If:'
> section to generated documentation) added the latter.  Drop the
> former.
> 
> Signed-off-by: Markus Armbruster <armbru@redhat.com>
> ---
>  qapi/misc-target.json | 2 --
>  1 file changed, 2 deletions(-)

Reviewed-by: Eric Blake <eblake@redhat.com>

-- 
Eric Blake, Principal Software Engineer
Red Hat, Inc.
Virtualization:  qemu.org | libguestfs.org