From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from eggs.gnu.org ([2001:4830:134:3::10]:43276) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1ePUZu-0001WD-JB for qemu-devel@nongnu.org; Thu, 14 Dec 2017 09:33:47 -0500 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1ePUZq-0005Xj-IA for qemu-devel@nongnu.org; Thu, 14 Dec 2017 09:33:38 -0500 Received: from mx1.redhat.com ([209.132.183.28]:49017) by eggs.gnu.org with esmtps (TLS1.0:DHE_RSA_AES_256_CBC_SHA1:32) (Exim 4.71) (envelope-from ) id 1ePUZq-0005TK-4x for qemu-devel@nongnu.org; Thu, 14 Dec 2017 09:33:34 -0500 From: Markus Armbruster References: <20170911110623.24981-1-marcandre.lureau@redhat.com> <20170911110623.24981-42-marcandre.lureau@redhat.com> <87zi6lza7i.fsf@dusky.pond.sub.org> Date: Thu, 14 Dec 2017 15:33:30 +0100 In-Reply-To: (=?utf-8?Q?=22Marc-Andr=C3=A9?= Lureau"'s message of "Thu, 14 Dec 2017 15:00:12 +0100") Message-ID: <87po7hxttx.fsf@dusky.pond.sub.org> MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: quoted-printable Subject: Re: [Qemu-devel] [PATCH v3 41/50] qapi: add a 'unit' pragma List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , To: =?utf-8?Q?Marc-Andr=C3=A9?= Lureau Cc: QEMU , Michael Roth Marc-Andr=C3=A9 Lureau writes: > Hi > > On Thu, Dec 14, 2017 at 2:54 PM, Markus Armbruster wr= ote: >> Marc-Andr=C3=A9 Lureau writes: >> >>> Add a pragma that allows to tag the following expressions with a unit >>> name. By default, an expression has no unit name. >> >> Please explain the unit name's intended purpose. >> > > It's syccintly explained in the doc. The commit message should state the patch's purpose. When the patch adds documentation, and you'd rather not duplicate it in the commit message, a short summary plus a pointer there may do. >>> Signed-off-by: Marc-Andr=C3=A9 Lureau >>> --- >>> scripts/qapi.py | 9 ++++++++- >>> docs/devel/qapi-code-gen.txt | 3 +++ >>> 2 files changed, 11 insertions(+), 1 deletion(-) >>> >>> diff --git a/scripts/qapi.py b/scripts/qapi.py >>> index eb4ffdc06d..1d0defd638 100644 >>> --- a/scripts/qapi.py >>> +++ b/scripts/qapi.py >>> @@ -279,10 +279,12 @@ class QAPISchemaParser(object): >>> self.docs =3D [] >>> self.cur_doc =3D None >>> self.accept() >>> + self.unit =3D None >>> >>> while self.tok is not None: >>> info =3D {'file': fname, 'line': self.line, >>> - 'parent': self.incl_info} >>> + 'parent': self.incl_info, >>> + 'unit': self.unit} >>> if self.tok =3D=3D '#': >>> self.reject_expr_doc() >>> self.cur_doc =3D self.get_doc(info) >>> @@ -371,6 +373,11 @@ class QAPISchemaParser(object): >>> "Pragma name-case-whitelist must be" >>> " a list of strings") >>> name_case_whitelist =3D value >>> + elif name =3D=3D 'unit': >>> + if not isinstance(value, str): >>> + raise QAPISemError(info, >>> + "Pragma 'unit' must be string") >>> + self.unit =3D value >>> else: >>> raise QAPISemError(info, "Unknown pragma '%s'" % name) >>> >>> diff --git a/docs/devel/qapi-code-gen.txt b/docs/devel/qapi-code-gen.txt >>> index 24fc6f74ee..37a27cd9d7 100644 >>> --- a/docs/devel/qapi-code-gen.txt >>> +++ b/docs/devel/qapi-code-gen.txt >>> @@ -326,6 +326,9 @@ violate the rules on permitted return types. Defau= lt is none. >>> Pragma 'name-case-whitelist' takes a list of names that may violate >>> rules on use of upper- vs. lower-case letters. Default is none. >>> >>> +Pragma 'unit' takes a string value. It will set the unit name for the >>> +following expressions in the schema. Most code generator can filter >>> +based on a unit name. Default is none. >> >> Do you mean "most code generators"? > > The qapi code/doc generators. So plural is intended. Easy enough to fix. >> >> What does "filtering" mean? > > To be able to select a subset of expressions based on the unit name. Let's spell that out. >>> >>> =3D=3D=3D Struct types =3D=3D=3D >> >> Humor me: put two spaces after a sentence-ending period. >> > > I don't get what you mean. This sentence ends with a period, which is followed by two spaces. This sentence is followed by just one space. I prefer two. A few inconsistencies have crept into this file over time, let's not add more. All clear now?