[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[PATCH 09/17] tests/qapi-schema/doc-good: Improve a comment
From: |
Markus Armbruster |
Subject: |
[PATCH 09/17] tests/qapi-schema/doc-good: Improve a comment |
Date: |
Fri, 28 Apr 2023 12:54:21 +0200 |
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 <armbru@redhat.com>
---
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.json
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=Variant1
A paragraph
Another paragraph (but no @var: line)
+
+@var1 is undocumented
arg=var1
feature=variant1-feat
--
2.39.2
- Re: [PATCH 04/17] meson: Fix to make QAPI generator output depend on main.py, (continued)
- [PATCH 07/17] qapi: Tidy up a slightly awkward TODO comment, Markus Armbruster, 2023/04/28
- [PATCH 14/17] qapi: Section parameter @indent is no longer used, drop, Markus Armbruster, 2023/04/28
- [PATCH 03/17] qapi: Fix crash on stray double quote character, Markus Armbruster, 2023/04/28
- [PATCH 10/17] tests/qapi-schema/doc-good: Improve argument description tests, Markus Armbruster, 2023/04/28
- [PATCH 09/17] tests/qapi-schema/doc-good: Improve a comment,
Markus Armbruster <=
- [PATCH 15/17] docs/devel/qapi-code-gen: Update doc comment conventions, Markus Armbruster, 2023/04/28
- [PATCH 06/17] sphinx/qapidoc: Do not emit TODO sections into user manuals, Markus Armbruster, 2023/04/28
- [PATCH 08/17] qapi/dump: Indent bulleted lists consistently, Markus Armbruster, 2023/04/28
- [PATCH 05/17] Revert "qapi: BlockExportRemoveMode: move comments to TODO", Markus Armbruster, 2023/04/28