diff mbox series

[v2,06/22] qapi: Inline and remove QERR_INVALID_PARAMETER definition

Message ID 20231005045041.52649-7-philmd@linaro.org
State New
Headers show
Series qapi: Kill 'qapi/qmp/qerror.h' for good | expand

Commit Message

Philippe Mathieu-Daudé Oct. 5, 2023, 4:50 a.m. UTC 
Address the comment added in commit 4629ed1e98
("qerror: Finally unused, clean up"), from 2015:

  /*
   * These macros will go away, please don't use
   * in new code, and do not add new ones!
   */

Mechanical transformation using:

  $ sed -i -e "s/QERR_INVALID_PARAMETER,/\"Invalid parameter '%s'\",/" \
    $(git grep -lw QERR_INVALID_PARAMETER)

then manually removing the definition in include/qapi/qmp/qerror.h.

Signed-off-by: Philippe Mathieu-Daudé <philmd@linaro.org>
---
 include/qapi/qmp/qerror.h | 3 ---
 monitor/hmp-cmds.c        | 2 +-
 qapi/opts-visitor.c       | 2 +-
 util/qemu-option.c        | 8 ++++----
 4 files changed, 6 insertions(+), 9 deletions(-)

Comments

Markus Armbruster Oct. 20, 2023, 7:16 a.m. UTC | #1 
Philippe Mathieu-Daudé <philmd@linaro.org> writes:

> Address the comment added in commit 4629ed1e98
> ("qerror: Finally unused, clean up"), from 2015:
>
>   /*
>    * These macros will go away, please don't use
>    * in new code, and do not add new ones!
>    */
>
> Mechanical transformation using:
>
>   $ sed -i -e "s/QERR_INVALID_PARAMETER,/\"Invalid parameter '%s'\",/" \
>     $(git grep -lw QERR_INVALID_PARAMETER)
>
> then manually removing the definition in include/qapi/qmp/qerror.h.
>
> Signed-off-by: Philippe Mathieu-Daudé <philmd@linaro.org>
> ---
>  include/qapi/qmp/qerror.h | 3 ---
>  monitor/hmp-cmds.c        | 2 +-
>  qapi/opts-visitor.c       | 2 +-
>  util/qemu-option.c        | 8 ++++----
>  4 files changed, 6 insertions(+), 9 deletions(-)
>
> diff --git a/include/qapi/qmp/qerror.h b/include/qapi/qmp/qerror.h
> index e93211085a..63ab775dc5 100644
> --- a/include/qapi/qmp/qerror.h
> +++ b/include/qapi/qmp/qerror.h
> @@ -17,9 +17,6 @@
>   * add new ones!
>   */
>  
> -#define QERR_INVALID_PARAMETER \
> -    "Invalid parameter '%s'"
> -
>  #define QERR_INVALID_PARAMETER_TYPE \
>      "Invalid parameter type for '%s', expected: %s"
>  
> diff --git a/monitor/hmp-cmds.c b/monitor/hmp-cmds.c
> index 6c559b48c8..9d6533643d 100644
> --- a/monitor/hmp-cmds.c
> +++ b/monitor/hmp-cmds.c
> @@ -138,7 +138,7 @@ void hmp_sync_profile(Monitor *mon, const QDict *qdict)
       const char *op = qdict_get_try_str(qdict, "op");

       if (op == NULL) {
           bool on = qsp_is_enabled();

           monitor_printf(mon, "sync-profile is %s\n", on ? "on" : "off");
           return;
       }
       if (!strcmp(op, "on")) {
           qsp_enable();
       } else if (!strcmp(op, "off")) {
           qsp_disable();
       } else if (!strcmp(op, "reset")) {
           qsp_reset();
>      } else {
>          Error *err = NULL;
>  
> -        error_setg(&err, QERR_INVALID_PARAMETER, op);

The use of QERR_INVALID_PARAMETER is wrong: (1) it takes a parameter
name, but we pass a parameter value, and (2) parameter @op is valid, its
value isn't.

> +        error_setg(&err, "Invalid parameter '%s'", op);
>          hmp_handle_error(mon, err);
>      }
>  }
> diff --git a/qapi/opts-visitor.c b/qapi/opts-visitor.c
> index 8f1efab8b9..3d1a28b419 100644
> --- a/qapi/opts-visitor.c
> +++ b/qapi/opts-visitor.c
> @@ -184,7 +184,7 @@ opts_check_struct(Visitor *v, Error **errp)
>          const QemuOpt *first;
>  
>          first = g_queue_peek_head(any);
> -        error_setg(errp, QERR_INVALID_PARAMETER, first->name);
> +        error_setg(errp, "Invalid parameter '%s'", first->name);
>          return false;
>      }
>      return true;
> diff --git a/util/qemu-option.c b/util/qemu-option.c
> index fb391a7904..201f7a87f3 100644
> --- a/util/qemu-option.c
> +++ b/util/qemu-option.c
> @@ -498,7 +498,7 @@ static bool opt_validate(QemuOpt *opt, Error **errp)
>  
>      desc = find_desc_by_name(list->desc, opt->name);
>      if (!desc && !opts_accepts_any(list)) {
> -        error_setg(errp, QERR_INVALID_PARAMETER, opt->name);
> +        error_setg(errp, "Invalid parameter '%s'", opt->name);
>          return false;
>      }
>  
> @@ -531,7 +531,7 @@ bool qemu_opt_set_bool(QemuOpts *opts, const char *name, bool val,
>  
>      desc = find_desc_by_name(list->desc, name);
>      if (!desc && !opts_accepts_any(list)) {
> -        error_setg(errp, QERR_INVALID_PARAMETER, name);
> +        error_setg(errp, "Invalid parameter '%s'", name);
>          return false;
>      }
>  
> @@ -554,7 +554,7 @@ bool qemu_opt_set_number(QemuOpts *opts, const char *name, int64_t val,
>  
>      desc = find_desc_by_name(list->desc, name);
>      if (!desc && !opts_accepts_any(list)) {
> -        error_setg(errp, QERR_INVALID_PARAMETER, name);
> +        error_setg(errp, "Invalid parameter '%s'", name);
>          return false;
>      }
>  
> @@ -1103,7 +1103,7 @@ bool qemu_opts_validate(QemuOpts *opts, const QemuOptDesc *desc, Error **errp)
>      QTAILQ_FOREACH(opt, &opts->head, next) {
>          opt->desc = find_desc_by_name(desc, opt->name);
>          if (!opt->desc) {
> -            error_setg(errp, QERR_INVALID_PARAMETER, opt->name);
> +            error_setg(errp, "Invalid parameter '%s'", opt->name);
>              return false;
>          }
diff mbox series

Patch

diff --git a/include/qapi/qmp/qerror.h b/include/qapi/qmp/qerror.h
index e93211085a..63ab775dc5 100644
--- a/include/qapi/qmp/qerror.h
+++ b/include/qapi/qmp/qerror.h
@@ -17,9 +17,6 @@ 
  * add new ones!
  */
 
-#define QERR_INVALID_PARAMETER \
-    "Invalid parameter '%s'"
-
 #define QERR_INVALID_PARAMETER_TYPE \
     "Invalid parameter type for '%s', expected: %s"
 
diff --git a/monitor/hmp-cmds.c b/monitor/hmp-cmds.c
index 6c559b48c8..9d6533643d 100644
--- a/monitor/hmp-cmds.c
+++ b/monitor/hmp-cmds.c
@@ -138,7 +138,7 @@  void hmp_sync_profile(Monitor *mon, const QDict *qdict)
     } else {
         Error *err = NULL;
 
-        error_setg(&err, QERR_INVALID_PARAMETER, op);
+        error_setg(&err, "Invalid parameter '%s'", op);
         hmp_handle_error(mon, err);
     }
 }
diff --git a/qapi/opts-visitor.c b/qapi/opts-visitor.c
index 8f1efab8b9..3d1a28b419 100644
--- a/qapi/opts-visitor.c
+++ b/qapi/opts-visitor.c
@@ -184,7 +184,7 @@  opts_check_struct(Visitor *v, Error **errp)
         const QemuOpt *first;
 
         first = g_queue_peek_head(any);
-        error_setg(errp, QERR_INVALID_PARAMETER, first->name);
+        error_setg(errp, "Invalid parameter '%s'", first->name);
         return false;
     }
     return true;
diff --git a/util/qemu-option.c b/util/qemu-option.c
index fb391a7904..201f7a87f3 100644
--- a/util/qemu-option.c
+++ b/util/qemu-option.c
@@ -498,7 +498,7 @@  static bool opt_validate(QemuOpt *opt, Error **errp)
 
     desc = find_desc_by_name(list->desc, opt->name);
     if (!desc && !opts_accepts_any(list)) {
-        error_setg(errp, QERR_INVALID_PARAMETER, opt->name);
+        error_setg(errp, "Invalid parameter '%s'", opt->name);
         return false;
     }
 
@@ -531,7 +531,7 @@  bool qemu_opt_set_bool(QemuOpts *opts, const char *name, bool val,
 
     desc = find_desc_by_name(list->desc, name);
     if (!desc && !opts_accepts_any(list)) {
-        error_setg(errp, QERR_INVALID_PARAMETER, name);
+        error_setg(errp, "Invalid parameter '%s'", name);
         return false;
     }
 
@@ -554,7 +554,7 @@  bool qemu_opt_set_number(QemuOpts *opts, const char *name, int64_t val,
 
     desc = find_desc_by_name(list->desc, name);
     if (!desc && !opts_accepts_any(list)) {
-        error_setg(errp, QERR_INVALID_PARAMETER, name);
+        error_setg(errp, "Invalid parameter '%s'", name);
         return false;
     }
 
@@ -1103,7 +1103,7 @@  bool qemu_opts_validate(QemuOpts *opts, const QemuOptDesc *desc, Error **errp)
     QTAILQ_FOREACH(opt, &opts->head, next) {
         opt->desc = find_desc_by_name(desc, opt->name);
         if (!opt->desc) {
-            error_setg(errp, QERR_INVALID_PARAMETER, opt->name);
+            error_setg(errp, "Invalid parameter '%s'", opt->name);
             return false;
         }