mirror of
https://github.com/Motorhead1991/qemu.git
synced 2025-07-28 21:03:54 -06:00
qapi: The #optional tag is redundant, drop
We traditionally mark optional members #optional in the doc comment. Before commit3313b61
, this was entirely manual. Commit3313b61
added some automation because its qapi2texi.py relied on #optional to determine whether a member is optional. This is no longer the case since the previous commit: the only thing qapi2texi.py still does with #optional is stripping it out. We still reject bogus qapi-schema.json and six places for qga/qapi-schema.json. Thus, you can't actually rely on #optional to see whether something is optional. Yet we still make people add it manually. That's just busy-work. Drop the code to check, fix up and strip out #optional, along with all instances of #optional. To keep it out, add code to reject it, to be dropped again once the dust settles. No change to generated documentation. Signed-off-by: Markus Armbruster <armbru@redhat.com> Reviewed-by: Eric Blake <eblake@redhat.com> Message-Id: <1489582656-31133-18-git-send-email-armbru@redhat.com>
This commit is contained in:
parent
aa964b7fdc
commit
1d8bda128d
18 changed files with 486 additions and 516 deletions
|
@ -145,8 +145,7 @@ def texi_members(doc, 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 = re.sub(r'^ *#optional *\n?|\n? *#optional *$|#optional',
|
||||
'', str(section))
|
||||
desc = str(section)
|
||||
items += member_func(section.member) + texi_format(desc) + '\n'
|
||||
if not items:
|
||||
return ''
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue