diff options
Diffstat (limited to 'scripts/qapi')
| -rw-r--r-- | scripts/qapi/common.py | 43 | ||||
| -rwxr-xr-x | scripts/qapi/doc.py | 12 |
2 files changed, 51 insertions, 4 deletions
diff --git a/scripts/qapi/common.py b/scripts/qapi/common.py index f40a2cd4c5..1164301edf 100644 --- a/scripts/qapi/common.py +++ b/scripts/qapi/common.py @@ -129,6 +129,7 @@ class QAPIDoc(object): optional overview * an ARGS part: description of each argument (for commands and events) or member (for structs, unions and alternates), + * a FEATURES part: description of each feature, * a VARIOUS part: optional tagged sections. Free-form documentation blocks consist only of a BODY part. @@ -136,7 +137,8 @@ class QAPIDoc(object): # TODO Make it a subclass of Enum when Python 2 support is removed BODY = 1 ARGS = 2 - VARIOUS = 3 + FEATURES = 3 + VARIOUS = 4 def __init__(self, parser, info): # self._parser is used to report errors with QAPIParseError. The @@ -149,6 +151,7 @@ class QAPIDoc(object): self.body = QAPIDoc.Section() # dict mapping parameter name to ArgSection self.args = OrderedDict() + self.features = OrderedDict() # a list of Section self.sections = [] # the current section @@ -197,6 +200,8 @@ class QAPIDoc(object): self._append_body_line(line) elif self._part == QAPIDoc.DocPart.ARGS: self._append_args_line(line) + elif self._part == QAPIDoc.DocPart.FEATURES: + self._append_features_line(line) elif self._part == QAPIDoc.DocPart.VARIOUS: self._append_various_line(line) else: @@ -229,6 +234,8 @@ class QAPIDoc(object): if name.startswith('@') and name.endswith(':'): self._part = QAPIDoc.DocPart.ARGS self._append_args_line(line) + elif line == 'Features:': + self._part = QAPIDoc.DocPart.FEATURES elif self._is_section_tag(name): self._part = QAPIDoc.DocPart.VARIOUS self._append_various_line(line) @@ -250,6 +257,28 @@ class QAPIDoc(object): return elif (self._section.text.endswith('\n\n') and line and not line[0].isspace()): + if line == 'Features:': + self._part = QAPIDoc.DocPart.FEATURES + else: + self._start_section() + self._part = QAPIDoc.DocPart.VARIOUS + self._append_various_line(line) + return + + self._append_freeform(line.strip()) + + def _append_features_line(self, line): + name = line.split(' ', 1)[0] + + if name.startswith('@') and name.endswith(':'): + line = line[len(name)+1:] + self._start_features_section(name[1:-1]) + elif self._is_section_tag(name): + self._part = QAPIDoc.DocPart.VARIOUS + self._append_various_line(line) + return + elif (self._section.text.endswith('\n\n') + and line and not line[0].isspace()): self._start_section() self._part = QAPIDoc.DocPart.VARIOUS self._append_various_line(line) @@ -274,17 +303,23 @@ class QAPIDoc(object): self._append_freeform(line) - def _start_args_section(self, name): + def _start_symbol_section(self, symbols_dict, name): # FIXME invalid names other than the empty string aren't flagged if not name: raise QAPIParseError(self._parser, "Invalid parameter name") - if name in self.args: + if name in symbols_dict: raise QAPIParseError(self._parser, "'%s' parameter name duplicated" % name) assert not self.sections self._end_section() self._section = QAPIDoc.ArgSection(name) - self.args[name] = self._section + symbols_dict[name] = self._section + + def _start_args_section(self, name): + self._start_symbol_section(self.args, name) + + def _start_features_section(self, name): + self._start_symbol_section(self.features, name) def _start_section(self, name=None): if name in ('Returns', 'Since') and self.has_section(name): diff --git a/scripts/qapi/doc.py b/scripts/qapi/doc.py index 433e9fcbfb..5fc0fc7e06 100755 --- a/scripts/qapi/doc.py +++ b/scripts/qapi/doc.py @@ -182,6 +182,17 @@ def texi_members(doc, what, base, variants, member_func): return '\n@b{%s:}\n@table @asis\n%s@end table\n' % (what, items) +def texi_features(doc): + """Format the table of features""" + items = '' + for section in doc.features.values(): + desc = texi_format(section.text) + items += '@item @code{%s}\n%s' % (section.name, desc) + if not items: + return '' + return '\n@b{Features:}\n@table @asis\n%s@end table\n' % (items) + + def texi_sections(doc, ifcond): """Format additional sections following arguments""" body = '' @@ -201,6 +212,7 @@ def texi_entity(doc, what, ifcond, base=None, variants=None, member_func=texi_member): return (texi_body(doc) + texi_members(doc, what, base, variants, member_func) + + texi_features(doc) + texi_sections(doc, ifcond)) |