[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[PATCH v4 04/13] qapi: Add spaces after symbol declaration for consisten
From: |
John Snow |
Subject: |
[PATCH v4 04/13] qapi: Add spaces after symbol declaration for consistency |
Date: |
Thu, 30 Sep 2021 16:57:07 -0400 |
Several QGA definitions omit a blank line after the symbol
declaration. This works OK currently, but it's the only place where we
do this. Adjust it for consistency.
Future commits may wind up enforcing this formatting.
Signed-off-by: John Snow <jsnow@redhat.com>
---
This isn't strictly necessary and I don't actually get around to
enforcing it in this series, but I figured I'd share it with the list
anyway. We can just drop this patch but I wanted to see your thoughts.
Signed-off-by: John Snow <jsnow@redhat.com>
---
qapi/block-core.json | 1 +
qga/qapi-schema.json | 3 +++
tests/qapi-schema/doc-good.json | 8 ++++++++
3 files changed, 12 insertions(+)
diff --git a/qapi/block-core.json b/qapi/block-core.json
index 4114f8b6fc3..52a6dae9522 100644
--- a/qapi/block-core.json
+++ b/qapi/block-core.json
@@ -3132,6 +3132,7 @@
##
# @BlockdevQcow2EncryptionFormat:
+#
# @aes: AES-CBC with plain64 initialization vectors
#
# Since: 2.10
diff --git a/qga/qapi-schema.json b/qga/qapi-schema.json
index c60f5e669d7..94e4aacdcc6 100644
--- a/qga/qapi-schema.json
+++ b/qga/qapi-schema.json
@@ -1140,6 +1140,7 @@
##
# @GuestExec:
+#
# @pid: pid of child process in guest OS
#
# Since: 2.5
@@ -1171,6 +1172,7 @@
##
# @GuestHostName:
+#
# @host-name: Fully qualified domain name of the guest OS
#
# Since: 2.10
@@ -1197,6 +1199,7 @@
##
# @GuestUser:
+#
# @user: Username
# @domain: Logon domain (windows only)
# @login-time: Time of login of this user on the computer. If multiple
diff --git a/tests/qapi-schema/doc-good.json b/tests/qapi-schema/doc-good.json
index a20acffd8b9..86dc25d2bd8 100644
--- a/tests/qapi-schema/doc-good.json
+++ b/tests/qapi-schema/doc-good.json
@@ -53,6 +53,7 @@
##
# @Enum:
+#
# @one: The _one_ {and only}
#
# Features:
@@ -67,6 +68,7 @@
##
# @Base:
+#
# @base1:
# the first member
##
@@ -75,6 +77,7 @@
##
# @Variant1:
+#
# A paragraph
#
# Another paragraph (but no @var: line)
@@ -91,11 +94,13 @@
##
# @Variant2:
+#
##
{ 'struct': 'Variant2', 'data': {} }
##
# @Object:
+#
# Features:
# @union-feat1: a feature
##
@@ -109,6 +114,7 @@
##
# @Alternate:
+#
# @i: an integer
# @b is undocumented
#
@@ -126,6 +132,7 @@
##
# @cmd:
+#
# @arg1: the first argument
#
# @arg2: the second
@@ -175,6 +182,7 @@
##
# @EVT_BOXED:
+#
# Features:
# @feat3: a feature
##
--
2.31.1
- [PATCH v4 00/13] qapi: static typing conversion, pt5b, John Snow, 2021/09/30
- [PATCH v4 01/13] qapi/pylintrc: ignore 'consider-using-f-string' warning, John Snow, 2021/09/30
- [PATCH v4 02/13] qapi/gen: use dict.items() to iterate over _modules, John Snow, 2021/09/30
- [PATCH v4 04/13] qapi: Add spaces after symbol declaration for consistency,
John Snow <=
- [PATCH v4 05/13] qapi/parser: remove FIXME comment from _append_body_line, John Snow, 2021/09/30
- [PATCH v4 03/13] qapi/parser: fix unused check_args_section arguments, John Snow, 2021/09/30
- [PATCH v4 06/13] qapi/parser: clarify _end_section() logic, John Snow, 2021/09/30
- [PATCH v4 07/13] qapi/parser: Introduce NullSection, John Snow, 2021/09/30
- [PATCH v4 08/13] qapi/parser: add import cycle workaround, John Snow, 2021/09/30
- [PATCH v4 11/13] qapi/parser: enable mypy checks, John Snow, 2021/09/30
- [PATCH v4 10/13] qapi/parser: Add FIXME for consolidating JSON-related types, John Snow, 2021/09/30
- [PATCH v4 12/13] qapi/parser: Silence too-few-public-methods warning, John Snow, 2021/09/30
- [PATCH v4 13/13] qapi/parser: enable pylint checks, John Snow, 2021/09/30
- [PATCH v4 09/13] qapi/parser: add type hint annotations (QAPIDoc), John Snow, 2021/09/30