From nobody Tue Feb 10 05:44:42 2026 Delivered-To: importer@patchew.org Authentication-Results: mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org; dmarc=pass(p=none dis=none) header.from=redhat.com ARC-Seal: i=1; a=rsa-sha256; t=1682679433; cv=none; d=zohomail.com; s=zohoarc; b=Xd0Cb94FMTEIuk2NE8IpC8yX221+pV9SqDZxFBiTZHQmydOpmGCyKGPu6zGJdCrxBpBRKeK6XM2YGnucYBpRSY0U9uhtQmLUVTVDzKWm+V+s9b/DDhjnfigvH0aiZt76vOLi9///+4w6jousiMfZyTJqp4OflbCGcxBWMeIlZHY= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1682679433; h=Content-Type:Content-Transfer-Encoding:Cc:Date:From:In-Reply-To:List-Subscribe:List-Post:List-Id:List-Archive:List-Help:List-Unsubscribe:MIME-Version:Message-ID:References:Sender:Subject:To; bh=iVvvPS2dqAgWTfaMRuiVetY5mBN48Fdbpg9a+jBHono=; b=JLc+l7EO/hxYVxqqGvSkISo4+g8ox267HSpmQ6DgBIGxsxq1/Hpn1ZPkTKZ3U+jxE8TND5R9OZJcGy0IEz5uoMLamsavlbacBoZdylEsTw75jSAi70iBiAvsZAxcm06b4ZkLEixV9BZrf19oFtorY4N9kuhuPpX9rKHjRQVDgcE= ARC-Authentication-Results: i=1; mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org; dmarc=pass header.from= (p=none dis=none) Return-Path: Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) by mx.zohomail.com with SMTPS id 1682679433790156.2269130147938; Fri, 28 Apr 2023 03:57:13 -0700 (PDT) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1psLkS-0008Nl-9Z; Fri, 28 Apr 2023 06:54:44 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1psLkQ-0008Mh-5j for qemu-devel@nongnu.org; Fri, 28 Apr 2023 06:54:42 -0400 Received: from us-smtp-delivery-124.mimecast.com ([170.10.133.124]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1psLkM-0003yU-JI for qemu-devel@nongnu.org; Fri, 28 Apr 2023 06:54:41 -0400 Received: from mimecast-mx02.redhat.com (mimecast-mx02.redhat.com [66.187.233.88]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id us-mta-176-_B3_BmH7NcOgLuqJl7pEdg-1; Fri, 28 Apr 2023 06:54:33 -0400 Received: from smtp.corp.redhat.com (int-mx07.intmail.prod.int.rdu2.redhat.com [10.11.54.7]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx02.redhat.com (Postfix) with ESMTPS id B7A6B885635; Fri, 28 Apr 2023 10:54:32 +0000 (UTC) Received: from blackfin.pond.sub.org (unknown [10.39.192.121]) by smtp.corp.redhat.com (Postfix) with ESMTPS id 93A4E1410F1E; Fri, 28 Apr 2023 10:54:32 +0000 (UTC) Received: by blackfin.pond.sub.org (Postfix, from userid 1000) id 9494921D191B; Fri, 28 Apr 2023 12:54:29 +0200 (CEST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1682679278; 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: in-reply-to:in-reply-to:references:references; bh=iVvvPS2dqAgWTfaMRuiVetY5mBN48Fdbpg9a+jBHono=; b=bJzjkNOAUpqYcEd1t7aKffDZ7QQz7b5nurV5ygzGtwSclCarSgmqrhnomGJYTDKZssqufE SLABnV2dgs2m2EG4Z8AuewVjfc7Rx/+RF45rDHxQ4CBm/GU0qYVVQ8ypQkWAByQwYUIWki oKKxMQ1jrlci60ljaCP3S+VgyAKZ2xU= X-MC-Unique: _B3_BmH7NcOgLuqJl7pEdg-1 From: Markus Armbruster To: qemu-devel@nongnu.org Cc: michael.roth@amd.com, peter.maydell@linaro.org, pbonzini@redhat.com, marcandre.lureau@redhat.com, berrange@redhat.com, thuth@redhat.com, philmd@linaro.org, mst@redhat.com, imammedo@redhat.com, anisinha@redhat.com, eblake@redhat.com, kraxel@redhat.com, kwolf@redhat.com, hreitz@redhat.com, arei.gonglei@huawei.com, pizhenwei@bytedance.com, jsnow@redhat.com, vsementsov@yandex-team.ru, eduardo@habkost.net, marcel.apfelbaum@gmail.com, wangyanan55@huawei.com, quintela@redhat.com, peterx@redhat.com, leobras@redhat.com, jasowang@redhat.com, yuval.shaia.ml@gmail.com, pavel.dovgaluk@ispras.ru, jiri@resnulli.us, stefanb@linux.vnet.ibm.com, stefanha@redhat.com, lukasstraub2@web.de, kkostiuk@redhat.com, qemu-block@nongnu.org, victortoso@redhat.com Subject: [PATCH 09/17] tests/qapi-schema/doc-good: Improve a comment Date: Fri, 28 Apr 2023 12:54:21 +0200 Message-Id: <20230428105429.1687850-10-armbru@redhat.com> In-Reply-To: <20230428105429.1687850-1-armbru@redhat.com> References: <20230428105429.1687850-1-armbru@redhat.com> MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable X-Scanned-By: MIMEDefang 3.1 on 10.11.54.7 Received-SPF: pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) client-ip=209.51.188.17; envelope-from=qemu-devel-bounces+importer=patchew.org@nongnu.org; helo=lists.gnu.org; Received-SPF: pass client-ip=170.10.133.124; envelope-from=armbru@redhat.com; helo=us-smtp-delivery-124.mimecast.com X-Spam_score_int: -22 X-Spam_score: -2.3 X-Spam_bar: -- X-Spam_report: (-2.3 / 5.0 requ) BAYES_00=-1.9, DKIMWL_WL_HIGH=-0.171, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, RCVD_IN_DNSWL_NONE=-0.0001, RCVD_IN_MSPIKE_H2=-0.001, SPF_HELO_NONE=0.001, SPF_PASS=-0.001, T_SCC_BODY_TEXT_LINE=-0.01 autolearn=ham autolearn_force=no X-Spam_action: no action X-BeenThere: qemu-devel@nongnu.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: qemu-devel-bounces+importer=patchew.org@nongnu.org Sender: qemu-devel-bounces+importer=patchew.org@nongnu.org X-ZohoMail-DKIM: pass (identity @redhat.com) X-ZM-MESSAGEID: 1682679434824100005 Content-Type: text/plain; charset="utf-8" The QAPI generator doesn't reject undocumented members and features (yet). doc-good.json covers this, with clear "is undocumented" notes to signal intent. Except for @Variant1 member @var1, where it's "(but no @var: line)". Less clear. Replace by "@var1 is undocumented". Signed-off-by: Markus Armbruster Reviewed-by: Juan Quintela --- tests/qapi-schema/doc-good.json | 4 +++- tests/qapi-schema/doc-good.out | 2 ++ 2 files changed, 5 insertions(+), 1 deletion(-) diff --git a/tests/qapi-schema/doc-good.json b/tests/qapi-schema/doc-good.j= son index 74745fb405..445471daee 100644 --- a/tests/qapi-schema/doc-good.json +++ b/tests/qapi-schema/doc-good.json @@ -83,7 +83,9 @@ # # A paragraph # -# Another paragraph (but no @var: line) +# Another paragraph +# +# @var1 is undocumented # # Features: # @variant1-feat: a feature diff --git a/tests/qapi-schema/doc-good.out b/tests/qapi-schema/doc-good.out index 9dd65b9d92..afa48dcd94 100644 --- a/tests/qapi-schema/doc-good.out +++ b/tests/qapi-schema/doc-good.out @@ -123,6 +123,8 @@ doc symbol=3DVariant1 A paragraph =20 Another paragraph (but no @var: line) + +@var1 is undocumented arg=3Dvar1 =20 feature=3Dvariant1-feat --=20 2.39.2