From patchwork Fri May 17 14:42:31 2019 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Kevin Wolf X-Patchwork-Id: 10948053 Return-Path: Received: from mail.wl.linuxfoundation.org (pdx-wl-mail.web.codeaurora.org [172.30.200.125]) by pdx-korg-patchwork-2.web.codeaurora.org (Postfix) with ESMTP id 8770C112C for ; Fri, 17 May 2019 14:46:20 +0000 (UTC) Received: from mail.wl.linuxfoundation.org (localhost [127.0.0.1]) by mail.wl.linuxfoundation.org (Postfix) with ESMTP id 7674A27F4B for ; Fri, 17 May 2019 14:46:20 +0000 (UTC) Received: by mail.wl.linuxfoundation.org (Postfix, from userid 486) id 6A38B27F8C; Fri, 17 May 2019 14:46:20 +0000 (UTC) X-Spam-Checker-Version: SpamAssassin 3.3.1 (2010-03-16) on pdx-wl-mail.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-5.2 required=2.0 tests=BAYES_00,MAILING_LIST_MULTI, RCVD_IN_DNSWL_MED autolearn=ham version=3.3.1 Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) (using TLSv1 with cipher AES256-SHA (256/256 bits)) (No client certificate requested) by mail.wl.linuxfoundation.org (Postfix) with ESMTPS id D510827F4B for ; Fri, 17 May 2019 14:46:19 +0000 (UTC) Received: from localhost ([127.0.0.1]:49692 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1hRe7m-0004ae-8A for patchwork-qemu-devel@patchwork.kernel.org; Fri, 17 May 2019 10:46:18 -0400 Received: from eggs.gnu.org ([209.51.188.92]:45825) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1hRe4l-0001so-94 for qemu-devel@nongnu.org; Fri, 17 May 2019 10:43:12 -0400 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1hRe4k-00047g-29 for qemu-devel@nongnu.org; Fri, 17 May 2019 10:43:11 -0400 Received: from mx1.redhat.com ([209.132.183.28]:53328) by eggs.gnu.org with esmtps (TLS1.0:DHE_RSA_AES_256_CBC_SHA1:32) (Exim 4.71) (envelope-from ) id 1hRe4h-00045J-5P; Fri, 17 May 2019 10:43:07 -0400 Received: from smtp.corp.redhat.com (int-mx05.intmail.prod.int.phx2.redhat.com [10.5.11.15]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mx1.redhat.com (Postfix) with ESMTPS id 634EC80F79; Fri, 17 May 2019 14:42:56 +0000 (UTC) Received: from localhost.localdomain.com (ovpn-116-213.ams2.redhat.com [10.36.116.213]) by smtp.corp.redhat.com (Postfix) with ESMTP id 039585D784; Fri, 17 May 2019 14:42:54 +0000 (UTC) From: Kevin Wolf To: qemu-block@nongnu.org Date: Fri, 17 May 2019 16:42:31 +0200 Message-Id: <20190517144232.18965-6-kwolf@redhat.com> In-Reply-To: <20190517144232.18965-1-kwolf@redhat.com> References: <20190517144232.18965-1-kwolf@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 2.79 on 10.5.11.15 X-Greylist: Sender IP whitelisted, not delayed by milter-greylist-4.5.16 (mx1.redhat.com [10.5.110.27]); Fri, 17 May 2019 14:43:01 +0000 (UTC) X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.2.x-3.x [generic] X-Received-From: 209.132.183.28 Subject: [Qemu-devel] [PATCH v2 5/6] qapi: Allow documentation for features X-BeenThere: qemu-devel@nongnu.org X-Mailman-Version: 2.1.21 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: kwolf@redhat.com, pkrempa@redhat.com, armbru@redhat.com, qemu-devel@nongnu.org Errors-To: qemu-devel-bounces+patchwork-qemu-devel=patchwork.kernel.org@nongnu.org Sender: "Qemu-devel" X-Virus-Scanned: ClamAV using ClamSMTP Features will be documented in a new part introduced by a "Features:" line, after arguments and before named sections. Signed-off-by: Kevin Wolf --- scripts/qapi/common.py | 43 ++++++++++++++++++++++++++++++++++++++---- scripts/qapi/doc.py | 11 +++++++++++ 2 files changed, 50 insertions(+), 4 deletions(-) diff --git a/scripts/qapi/common.py b/scripts/qapi/common.py index 1d0f4847db..6a1ec87d41 100644 --- a/scripts/qapi/common.py +++ b/scripts/qapi/common.py @@ -132,6 +132,9 @@ class QAPIDoc(object): ARGS means that we're parsing the arguments section. Any symbol name is interpreted as an argument and an ArgSection is created for it. + FEATURES means that we're parsing features sections. Any symbol name is + interpreted as a feature. + VARIOUS is the final part where freeform sections may appear. This includes named sections such as "Return:" as well as unnamed paragraphs. No symbols are allowed any more in this part. @@ -139,7 +142,8 @@ class QAPIDoc(object): # Can't make it a subclass of Enum because of Python 2 BODY = 0 ARGS = 1 - VARIOUS = 2 + FEATURES = 2 + VARIOUS = 3 def __init__(self, parser, info): # self._parser is used to report errors with QAPIParseError. The @@ -152,6 +156,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 @@ -180,6 +185,8 @@ class QAPIDoc(object): self._append_body_line(line) elif self._part == QAPIDoc.SymbolPart.ARGS: self._append_args_line(line) + elif self._part == QAPIDoc.SymbolPart.FEATURES: + self._append_features_line(line) elif self._part == QAPIDoc.SymbolPart.VARIOUS: self._append_various_line(line) else: @@ -215,6 +222,8 @@ class QAPIDoc(object): if name.startswith('@') and name.endswith(':'): self._part = QAPIDoc.SymbolPart.ARGS self._append_args_line(line) + elif line == 'Features:': + self._part = QAPIDoc.SymbolPart.FEATURES elif self.symbol and self._check_named_section(line, name): self._append_various_line(line) else: @@ -231,6 +240,26 @@ class QAPIDoc(object): self._start_args_section(name[1:-1]) elif self._check_named_section(line, name): return self._append_various_line(line) + elif (self._section.text.endswith('\n\n') + and line and not line[0].isspace()): + if line == 'Features:': + self._part = QAPIDoc.SymbolPart.FEATURES + return + else: + self._start_section() + self._part = QAPIDoc.SymbolPart.VARIOUS + return self._append_various_line(line) + + 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._check_named_section(line, name): + return self._append_various_line(line) elif (self._section.text.endswith('\n\n') and line and not line[0].isspace()): self._start_section() @@ -256,17 +285,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..8e799b9e0b 100755 --- a/scripts/qapi/doc.py +++ b/scripts/qapi/doc.py @@ -181,6 +181,16 @@ def texi_members(doc, what, base, variants, member_func): return '' 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""" @@ -201,6 +211,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))