From nobody Mon Feb 9 20:32:50 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=1683619272; cv=none; d=zohomail.com; s=zohoarc; b=M8tcJzyVtmVifofgGCDsNC2M7LLB2ogemCtIeeCpDa2+TYXK/iH220dqabXUnIo7i96Ixpva2Qbh2lmgMJyxmW74iRFllgZeo+Fxk4DfcH0Ox/TWYdPOQjQLtU7+jrZpnWqGJ98BG0VZdFUakKYdkQ8Algarzcgyy72ZisWE+9c= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1683619272; 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=f8GkCEEclTa/vCiWYYZKkp9W8uMgp+i41cL/VV1rFZY=; b=IxbiDpPDJrGGWCrlzUHGoKycxlvfiiQVQtsozsCyALBO0X7KVGGcnyA0xhoMj5+91adn68O2L4vviwOyefZVVn0cpP8n4wypky0Kim2UiCu4Km+rFLgGptrvFgQE0tX1ctgZEFHVaWAHdUKkPu5gov0rszjIHHoLRzyJuXnpZdA= 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 1683619272900918.010458065488; Tue, 9 May 2023 01:01:12 -0700 (PDT) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1pwIGq-0008UY-1q; Tue, 09 May 2023 04:00:28 -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 1pwIGk-0008Tz-Jl for qemu-devel@nongnu.org; Tue, 09 May 2023 04:00:22 -0400 Received: from us-smtp-delivery-124.mimecast.com ([170.10.129.124]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1pwIGj-0008UB-3Q for qemu-devel@nongnu.org; Tue, 09 May 2023 04:00:22 -0400 Received: from mimecast-mx02.redhat.com (mx3-rdu2.redhat.com [66.187.233.73]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id us-mta-53-6sl1HN6MPDKpC5UG0g6SCA-1; Tue, 09 May 2023 04:00:19 -0400 Received: from smtp.corp.redhat.com (int-mx02.intmail.prod.int.rdu2.redhat.com [10.11.54.2]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx02.redhat.com (Postfix) with ESMTPS id CDA2A3C10692; Tue, 9 May 2023 08:00:18 +0000 (UTC) Received: from blackfin.pond.sub.org (unknown [10.39.192.121]) by smtp.corp.redhat.com (Postfix) with ESMTPS id AB3D640C6E68; Tue, 9 May 2023 08:00:18 +0000 (UTC) Received: by blackfin.pond.sub.org (Postfix, from userid 1000) id 31BB221E660B; Tue, 9 May 2023 10:00:11 +0200 (CEST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1683619220; 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=f8GkCEEclTa/vCiWYYZKkp9W8uMgp+i41cL/VV1rFZY=; b=Ul2ta1zFLWII92o3yd7TSORbw2G+9rBdiQL/xbTDdh23obBzQJATVgMdrw98z5kg03V1rn uOOlZqzNEWfyGw9yoh/8QeUlPpXFjWmyzRcQ3LV1y1TVhN7xzr+dluD7NiuCCFrhjaNvHA /4/VV5L6Cf8QOBQeA3+rvBxu2aWaOAg= X-MC-Unique: 6sl1HN6MPDKpC5UG0g6SCA-1 From: Markus Armbruster To: qemu-devel@nongnu.org Cc: richard.henderson@linaro.org, Juan Quintela Subject: [PULL 09/17] tests/qapi-schema/doc-good: Improve a comment Date: Tue, 9 May 2023 10:00:03 +0200 Message-Id: <20230509080011.3231661-10-armbru@redhat.com> In-Reply-To: <20230509080011.3231661-1-armbru@redhat.com> References: <20230509080011.3231661-1-armbru@redhat.com> MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable X-Scanned-By: MIMEDefang 3.1 on 10.11.54.2 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.129.124; envelope-from=armbru@redhat.com; helo=us-smtp-delivery-124.mimecast.com X-Spam_score_int: -20 X-Spam_score: -2.1 X-Spam_bar: -- X-Spam_report: (-2.1 / 5.0 requ) BAYES_00=-1.9, DKIMWL_WL_HIGH=-0.001, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, RCVD_IN_DNSWL_NONE=-0.0001, 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: 1683619274208100003 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 Message-Id: <20230428105429.1687850-10-armbru@redhat.com> 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