[PATCH] docs/devel/qapi-code-gen: Update examples to match current code

Markus Armbruster posted 1 patch 4 years, 7 months ago
Test checkpatch passed
Patches applied successfully (tree, apply log)
git fetch https://github.com/patchew-project/qemu tags/patchew/20210712150214.624281-1-armbru@redhat.com
Maintainers: Michael Roth <michael.roth@amd.com>, Markus Armbruster <armbru@redhat.com>
docs/devel/qapi-code-gen.txt | 23 ++++++++++++++++-------
1 file changed, 16 insertions(+), 7 deletions(-)
[PATCH] docs/devel/qapi-code-gen: Update examples to match current code
Posted by Markus Armbruster 4 years, 7 months ago
Signed-off-by: Markus Armbruster <armbru@redhat.com>
---
 docs/devel/qapi-code-gen.txt | 23 ++++++++++++++++-------
 1 file changed, 16 insertions(+), 7 deletions(-)

diff --git a/docs/devel/qapi-code-gen.txt b/docs/devel/qapi-code-gen.txt
index c1cb6f987d..233022184b 100644
--- a/docs/devel/qapi-code-gen.txt
+++ b/docs/devel/qapi-code-gen.txt
@@ -1496,8 +1496,12 @@ Example:
 
 
     bool visit_type_UserDefOne_members(Visitor *v, UserDefOne *obj, Error **errp);
-    bool visit_type_UserDefOne(Visitor *v, const char *name, UserDefOne **obj, Error **errp);
-    bool visit_type_UserDefOneList(Visitor *v, const char *name, UserDefOneList **obj, Error **errp);
+
+    bool visit_type_UserDefOne(Visitor *v, const char *name,
+                     UserDefOne **obj, Error **errp);
+
+    bool visit_type_UserDefOneList(Visitor *v, const char *name,
+                     UserDefOneList **obj, Error **errp);
 
     bool visit_type_q_obj_my_command_arg_members(Visitor *v, q_obj_my_command_arg *obj, Error **errp);
 
@@ -1518,7 +1522,8 @@ Example:
         return true;
     }
 
-    bool visit_type_UserDefOne(Visitor *v, const char *name, UserDefOne **obj, Error **errp)
+    bool visit_type_UserDefOne(Visitor *v, const char *name,
+                     UserDefOne **obj, Error **errp)
     {
         bool ok = false;
 
@@ -1528,6 +1533,7 @@ Example:
         if (!*obj) {
             /* incomplete */
             assert(visit_is_dealloc(v));
+            ok = true;
             goto out_obj;
         }
         if (!visit_type_UserDefOne_members(v, *obj, errp)) {
@@ -1543,7 +1549,8 @@ Example:
         return ok;
     }
 
-    bool visit_type_UserDefOneList(Visitor *v, const char *name, UserDefOneList **obj, Error **errp)
+    bool visit_type_UserDefOneList(Visitor *v, const char *name,
+                     UserDefOneList **obj, Error **errp)
     {
         bool ok = false;
         UserDefOneList *tail;
@@ -1628,11 +1635,13 @@ Example:
     $ cat qapi-generated/example-qapi-commands.c
 [Uninteresting stuff omitted...]
 
-    static void qmp_marshal_output_UserDefOne(UserDefOne *ret_in, QObject **ret_out, Error **errp)
+
+    static void qmp_marshal_output_UserDefOne(UserDefOne *ret_in,
+                                    QObject **ret_out, Error **errp)
     {
         Visitor *v;
 
-        v = qobject_output_visitor_new(ret_out);
+        v = qobject_output_visitor_new_qmp(ret_out);
         if (visit_type_UserDefOne(v, "unused", &ret_in, errp)) {
             visit_complete(v, ret_out);
         }
@@ -1650,7 +1659,7 @@ Example:
         UserDefOne *retval;
         q_obj_my_command_arg arg = {0};
 
-        v = qobject_input_visitor_new(QOBJECT(args));
+        v = qobject_input_visitor_new_qmp(QOBJECT(args));
         if (!visit_start_struct(v, NULL, NULL, 0, errp)) {
             goto out;
         }
-- 
2.31.1


Re: [PATCH] docs/devel/qapi-code-gen: Update examples to match current code
Posted by John Snow 4 years, 6 months ago
On Mon, Jul 12, 2021 at 11:02 AM Markus Armbruster <armbru@redhat.com>
wrote:

> Signed-off-by: Markus Armbruster <armbru@redhat.com>
>

I assume this is about making the examples match the current output
exactly, so we're doing some updates for spacing and so on.

I'll trust it.

Acked-by: John Snow <jsnow@redhat.com>


> ---
>  docs/devel/qapi-code-gen.txt | 23 ++++++++++++++++-------
>  1 file changed, 16 insertions(+), 7 deletions(-)
>
> diff --git a/docs/devel/qapi-code-gen.txt b/docs/devel/qapi-code-gen.txt
> index c1cb6f987d..233022184b 100644
> --- a/docs/devel/qapi-code-gen.txt
> +++ b/docs/devel/qapi-code-gen.txt
> @@ -1496,8 +1496,12 @@ Example:
>
>
>      bool visit_type_UserDefOne_members(Visitor *v, UserDefOne *obj, Error
> **errp);
> -    bool visit_type_UserDefOne(Visitor *v, const char *name, UserDefOne
> **obj, Error **errp);
> -    bool visit_type_UserDefOneList(Visitor *v, const char *name,
> UserDefOneList **obj, Error **errp);
> +
> +    bool visit_type_UserDefOne(Visitor *v, const char *name,
> +                     UserDefOne **obj, Error **errp);
> +
> +    bool visit_type_UserDefOneList(Visitor *v, const char *name,
> +                     UserDefOneList **obj, Error **errp);
>
>      bool visit_type_q_obj_my_command_arg_members(Visitor *v,
> q_obj_my_command_arg *obj, Error **errp);
>
> @@ -1518,7 +1522,8 @@ Example:
>          return true;
>      }
>
> -    bool visit_type_UserDefOne(Visitor *v, const char *name, UserDefOne
> **obj, Error **errp)
> +    bool visit_type_UserDefOne(Visitor *v, const char *name,
> +                     UserDefOne **obj, Error **errp)
>      {
>          bool ok = false;
>
> @@ -1528,6 +1533,7 @@ Example:
>          if (!*obj) {
>              /* incomplete */
>              assert(visit_is_dealloc(v));
> +            ok = true;
>              goto out_obj;
>          }
>          if (!visit_type_UserDefOne_members(v, *obj, errp)) {
> @@ -1543,7 +1549,8 @@ Example:
>          return ok;
>      }
>
> -    bool visit_type_UserDefOneList(Visitor *v, const char *name,
> UserDefOneList **obj, Error **errp)
> +    bool visit_type_UserDefOneList(Visitor *v, const char *name,
> +                     UserDefOneList **obj, Error **errp)
>      {
>          bool ok = false;
>          UserDefOneList *tail;
> @@ -1628,11 +1635,13 @@ Example:
>      $ cat qapi-generated/example-qapi-commands.c
>  [Uninteresting stuff omitted...]
>
> -    static void qmp_marshal_output_UserDefOne(UserDefOne *ret_in, QObject
> **ret_out, Error **errp)
> +
> +    static void qmp_marshal_output_UserDefOne(UserDefOne *ret_in,
> +                                    QObject **ret_out, Error **errp)
>      {
>          Visitor *v;
>
> -        v = qobject_output_visitor_new(ret_out);
> +        v = qobject_output_visitor_new_qmp(ret_out);
>          if (visit_type_UserDefOne(v, "unused", &ret_in, errp)) {
>              visit_complete(v, ret_out);
>          }
> @@ -1650,7 +1659,7 @@ Example:
>          UserDefOne *retval;
>          q_obj_my_command_arg arg = {0};
>
> -        v = qobject_input_visitor_new(QOBJECT(args));
> +        v = qobject_input_visitor_new_qmp(QOBJECT(args));
>          if (!visit_start_struct(v, NULL, NULL, 0, errp)) {
>              goto out;
>          }
> --
> 2.31.1
>
>