From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-0.5 required=3.0 tests=DKIM_INVALID,DKIM_SIGNED, HEADER_FROM_DIFFERENT_DOMAINS,MAILING_LIST_MULTI,SPF_HELO_NONE,SPF_PASS, URIBL_BLOCKED autolearn=no autolearn_force=no version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id 2ACA1CA9EBC for ; Thu, 24 Oct 2019 11:09:33 +0000 (UTC) Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by mail.kernel.org (Postfix) with ESMTPS id EC92A20684 for ; Thu, 24 Oct 2019 11:09:32 +0000 (UTC) Authentication-Results: mail.kernel.org; dkim=fail reason="signature verification failed" (1024-bit key) header.d=redhat.com header.i=@redhat.com header.b="Kb4YZEsX" DMARC-Filter: OpenDMARC Filter v1.3.2 mail.kernel.org EC92A20684 Authentication-Results: mail.kernel.org; dmarc=fail (p=none dis=none) header.from=redhat.com Authentication-Results: mail.kernel.org; spf=pass smtp.mailfrom=qemu-devel-bounces+qemu-devel=archiver.kernel.org@nongnu.org Received: from localhost ([::1]:38936 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1iNazj-0002eB-Jm for qemu-devel@archiver.kernel.org; Thu, 24 Oct 2019 07:09:31 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]:59239) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1iNatG-0000sd-PM for qemu-devel@nongnu.org; Thu, 24 Oct 2019 07:02:52 -0400 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1iNatE-0004p5-4R for qemu-devel@nongnu.org; Thu, 24 Oct 2019 07:02:50 -0400 Received: from us-smtp-2.mimecast.com ([205.139.110.61]:58212 helo=us-smtp-delivery-1.mimecast.com) by eggs.gnu.org with esmtps (TLS1.0:DHE_RSA_AES_256_CBC_SHA1:32) (Exim 4.71) (envelope-from ) id 1iNatC-0004mE-4r for qemu-devel@nongnu.org; Thu, 24 Oct 2019 07:02:46 -0400 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1571914964; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding; bh=ZhiueCs0hiaDMiol+Y6BbmQnDCKMQEynZKK4iNNRY3A=; b=Kb4YZEsXN4x1eAmTZKF0KKk9Pi5AI7R65Eg6sXr4oMR6Yw5++cvIud4ahnVoOI1+dkBqb+ cw/8/p+mU5127ON0wMgtQ+sO0KB5vTmhbT0OywE7L+BYKEN3bDgHhDHJAYEUkHq7WW+nhs cKcpIv5JrhNOD7qlytl1te0JZpLdmHE= Received: from mimecast-mx01.redhat.com (mimecast-mx01.redhat.com [209.132.183.4]) (Using TLS) by relay.mimecast.com with ESMTP id us-mta-242-fQIddSV4Pvuc-rm7du-qwQ-1; Thu, 24 Oct 2019 07:02:40 -0400 Received: from smtp.corp.redhat.com (int-mx02.intmail.prod.int.phx2.redhat.com [10.5.11.12]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx01.redhat.com (Postfix) with ESMTPS id F3FC2800D49; Thu, 24 Oct 2019 11:02:38 +0000 (UTC) Received: from blackfin.pond.sub.org (unknown [10.36.118.123]) by smtp.corp.redhat.com (Postfix) with ESMTPS id BB6D060BF3; Thu, 24 Oct 2019 11:02:38 +0000 (UTC) Received: by blackfin.pond.sub.org (Postfix, from userid 1000) id 318041138619; Thu, 24 Oct 2019 13:02:37 +0200 (CEST) From: Markus Armbruster To: qemu-devel@nongnu.org Subject: [PATCH 00/19] qapi: Doc generation fixes Date: Thu, 24 Oct 2019 13:02:18 +0200 Message-Id: <20191024110237.30963-1-armbru@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 2.79 on 10.5.11.12 X-MC-Unique: fQIddSV4Pvuc-rm7du-qwQ-1 X-Mimecast-Spam-Score: 0 Content-Type: text/plain; charset=WINDOWS-1252 Content-Transfer-Encoding: quoted-printable X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.2.x-3.x [generic] [fuzzy] X-Received-From: 205.139.110.61 X-BeenThere: qemu-devel@nongnu.org X-Mailman-Version: 2.1.23 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: kwolf@redhat.com, pkrempa@redhat.com, mdroth@linux.vnet.ibm.com Errors-To: qemu-devel-bounces+qemu-devel=archiver.kernel.org@nongnu.org Sender: "Qemu-devel" The recent patches to introduce feature flags neglected doc generation. While fixing that, I found similar neglect in non-recent patches. Fix all that, and clean up some. Markus Armbruster (19): tests/qapi-schema: Demonstrate feature and enum doc comment bugs tests/qapi-schema: Demonstrate command and event doc comment bugs tests/qapi-schema: Cover alternate documentation comments tests/qapi-schema: Fix feature documentation testing qemu-doc: Belatedly document QMP command deprecation qapi: Implement boxed event argument documentation qapi: De-duplicate entity documentation generation code qapi: Split .connect_doc(), .check_doc() off .check() qapi: Fix enum doc comment checking qapi: Clean up doc comment checking for implicit union base qapi: Fix doc comment checking for commands and events qapi: Simplify ._make_implicit_object_type() qapi: Eliminate .check_doc() overrides qapi: Fold normalize_if() into check_if() qapi: Fold normalize_features() into check_features() qapi: Fold normalize_enum() into check_enum() qapi: Lift features into QAPISchemaEntity qapi: Polish reporting of bogus member documentation qapi: Check feature documentation against the schema qemu-deprecated.texi | 12 +++ tests/qapi-schema/doc-good.texi | 27 ++++++ qapi/net.json | 2 - scripts/qapi/doc.py | 75 +++++++------- scripts/qapi/expr.py | 32 +----- scripts/qapi/parser.py | 29 ++++-- scripts/qapi/schema.py | 97 +++++++++++-------- tests/Makefile.include | 5 + .../qapi-schema/doc-bad-alternate-member.err | 2 +- .../qapi-schema/doc-bad-boxed-command-arg.err | 1 + .../doc-bad-boxed-command-arg.json | 14 +++ .../qapi-schema/doc-bad-boxed-command-arg.out | 0 tests/qapi-schema/doc-bad-command-arg.err | 2 +- tests/qapi-schema/doc-bad-enum-member.err | 1 + tests/qapi-schema/doc-bad-enum-member.json | 8 ++ tests/qapi-schema/doc-bad-enum-member.out | 0 tests/qapi-schema/doc-bad-event-arg.err | 1 + tests/qapi-schema/doc-bad-event-arg.json | 7 ++ tests/qapi-schema/doc-bad-event-arg.out | 0 tests/qapi-schema/doc-bad-feature.err | 1 + tests/qapi-schema/doc-bad-feature.json | 9 ++ tests/qapi-schema/doc-bad-feature.out | 0 tests/qapi-schema/doc-bad-union-member.err | 2 +- tests/qapi-schema/doc-good.json | 14 +++ tests/qapi-schema/doc-good.out | 27 ++++++ tests/qapi-schema/doc-undoc-feature.err | 2 + tests/qapi-schema/doc-undoc-feature.json | 9 ++ tests/qapi-schema/doc-undoc-feature.out | 0 tests/qapi-schema/test-qapi.py | 2 + 29 files changed, 270 insertions(+), 111 deletions(-) create mode 100644 tests/qapi-schema/doc-bad-boxed-command-arg.err create mode 100644 tests/qapi-schema/doc-bad-boxed-command-arg.json create mode 100644 tests/qapi-schema/doc-bad-boxed-command-arg.out create mode 100644 tests/qapi-schema/doc-bad-enum-member.err create mode 100644 tests/qapi-schema/doc-bad-enum-member.json create mode 100644 tests/qapi-schema/doc-bad-enum-member.out create mode 100644 tests/qapi-schema/doc-bad-event-arg.err create mode 100644 tests/qapi-schema/doc-bad-event-arg.json create mode 100644 tests/qapi-schema/doc-bad-event-arg.out create mode 100644 tests/qapi-schema/doc-bad-feature.err create mode 100644 tests/qapi-schema/doc-bad-feature.json create mode 100644 tests/qapi-schema/doc-bad-feature.out create mode 100644 tests/qapi-schema/doc-undoc-feature.err create mode 100644 tests/qapi-schema/doc-undoc-feature.json create mode 100644 tests/qapi-schema/doc-undoc-feature.out --=20 2.21.0