[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[PATCH 14/15] qapi: Move @String out of common.json to discourage reuse
From: |
Markus Armbruster |
Subject: |
[PATCH 14/15] qapi: Move @String out of common.json to discourage reuse |
Date: |
Mon, 5 Feb 2024 08:47:08 +0100 |
Use of String is problematic, because it results in awkward interface
documentation. The previous commit cleaned up one instance.
Move String out of common.json next to its remaining users in net.json
to discourage reuse elsewhere.
Signed-off-by: Markus Armbruster <armbru@redhat.com>
---
qapi/common.json | 11 -----------
qapi/net.json | 12 +++++++++++-
include/net/filter.h | 2 +-
3 files changed, 12 insertions(+), 13 deletions(-)
diff --git a/qapi/common.json b/qapi/common.json
index 6fed9cde1a..f1bb841951 100644
--- a/qapi/common.json
+++ b/qapi/common.json
@@ -51,17 +51,6 @@
{ 'enum': 'OnOffSplit',
'data': [ 'on', 'off', 'split' ] }
-##
-# @String:
-#
-# A fat type wrapping 'str', to be embedded in lists.
-#
-# Since: 1.2
-##
-{ 'struct': 'String',
- 'data': {
- 'str': 'str' } }
-
##
# @StrOrNull:
#
diff --git a/qapi/net.json b/qapi/net.json
index 68493d6ac9..0a993e1a3d 100644
--- a/qapi/net.json
+++ b/qapi/net.json
@@ -6,7 +6,6 @@
# = Net devices
##
-{ 'include': 'common.json' }
{ 'include': 'sockets.json' }
##
@@ -105,6 +104,17 @@
'*addr': 'str',
'*vectors': 'uint32' } }
+##
+# @String:
+#
+# A fat type wrapping 'str', to be embedded in lists.
+#
+# Since: 1.2
+##
+{ 'struct': 'String',
+ 'data': {
+ 'str': 'str' } }
+
##
# @NetdevUserOptions:
#
diff --git a/include/net/filter.h b/include/net/filter.h
index 27ffc630df..f15f7932b2 100644
--- a/include/net/filter.h
+++ b/include/net/filter.h
@@ -9,7 +9,7 @@
#ifndef QEMU_NET_FILTER_H
#define QEMU_NET_FILTER_H
-#include "qapi/qapi-types-net.h"
+#include "qapi/qapi-types-common.h"
#include "qemu/queue.h"
#include "qom/object.h"
#include "net/queue.h"
--
2.43.0
- Re: [PATCH 04/15] qapi: Indent tagged doc comment sections properly, (continued)
- [PATCH 15/15] qapi: Add missing union tag documentation, Markus Armbruster, 2024/02/05
- [PATCH 11/15] qapi/dump: Clean up documentation of DumpGuestMemoryCapability, Markus Armbruster, 2024/02/05
- [PATCH 06/15] qapi: Require member documentation (with loophole), Markus Armbruster, 2024/02/05
- [PATCH 10/15] qapi/yank: Clean up documentaion of yank, Markus Armbruster, 2024/02/05
- [PATCH 14/15] qapi: Move @String out of common.json to discourage reuse,
Markus Armbruster <=
- [PATCH 12/15] qapi: Plug trivial documentation holes around former simple unions, Markus Armbruster, 2024/02/05
- [PATCH 07/15] qga/qapi-schema: Clean up documentation of guest-set-memory-blocks, Markus Armbruster, 2024/02/05
- [PATCH 05/15] sphinx/qapidoc: Drop code to generate doc for simple union tag, Markus Armbruster, 2024/02/05
- [PATCH 13/15] qapi: Improve documentation of file descriptor socket addresses, Markus Armbruster, 2024/02/05