| Message ID | 20240205074709.3613229-15-armbru@redhat.com |
|---|---|
| State | New |
| Headers | show |
| Series | qapi: Require member documentation (with loophole) | expand |
On Mon, Feb 05, 2024 at 08:47:08AM +0100, Markus Armbruster wrote: > 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(-) Reviewed-by: Daniel P. Berrangé <berrange@redhat.com> With regards, Daniel
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"
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(-)