diff options
author | Markus Armbruster <armbru@redhat.com> | 2017-03-15 13:57:11 +0100 |
---|---|---|
committer | Markus Armbruster <armbru@redhat.com> | 2017-03-16 07:13:03 +0100 |
commit | 5da19f14ff3393dc84f0f84c50770affd2c10acf (patch) | |
tree | 1bedd66d8b5d257d656b22175d8c6a086e5cbfc3 /scripts/qapi2texi.py | |
parent | 2a1183ce9399657a896c51f388e6c7ca58f5d56d (diff) |
qapi2texi: Explain enum value undocumentedness more clearly
Instead of not saying anything when we have no documentation, say "Not
documented".
Example change (qemu-qmp-ref.txt):
-- Enum: GuestPanicAction
An enumeration of the actions taken when guest OS panic is detected
Values:
'pause'
system pauses
'poweroff'
+ Not documented
Since: 2.1 (poweroff since 2.8)
Signed-off-by: Markus Armbruster <armbru@redhat.com>
Reviewed-by: Eric Blake <eblake@redhat.com>
Message-Id: <1489582656-31133-23-git-send-email-armbru@redhat.com>
Diffstat (limited to 'scripts/qapi2texi.py')
-rwxr-xr-x | scripts/qapi2texi.py | 5 |
1 files changed, 4 insertions, 1 deletions
diff --git a/scripts/qapi2texi.py b/scripts/qapi2texi.py index 35e182d543..1f01817be5 100755 --- a/scripts/qapi2texi.py +++ b/scripts/qapi2texi.py @@ -145,7 +145,10 @@ def texi_members(doc, what, member_func, show_undocumented): for section in doc.args.itervalues(): if not section.content and not show_undocumented: continue # Undocumented TODO require doc and drop - desc = str(section) + if section.content: + desc = str(section) + else: + desc = 'Not documented' items += member_func(section.member) + texi_format(desc) + '\n' if not items: return '' |