mirror of
https://github.com/Motorhead1991/qemu.git
synced 2025-12-11 16:00:50 -07:00
qom: Use command line syntax for default values in help
object_property_help() uses the conventional command line syntax instead
of the JSON syntax. In particular,
- Key-value pairs are written in the command line syntax.
- bool description passed to the function says on/off instead of
true/false.
However, there is one exception: default values are formatted into JSON.
While the command line and JSON syntaxes are consistent in many cases,
there are two types where they disagree:
string: The command line syntax omits quotes while JSON requires them.
bool: JSON only accepts true/false for bool but the command line syntax
accepts on/off too, and on/off are also more popular than
true/false. For example, the docs directory has 2045 "on"
occurances while it has only 194 "true" occurances.
on/off are also accepted by OnOffAuto so users do not have to
remember the type is bool or OnOffAuto to use the values.
Omit quotes for strings and use on/off for bools when formatting
default values for better consistency.
Signed-off-by: Akihiko Odaki <akihiko.odaki@daynix.com>
Link: https://lore.kernel.org/r/20250207-bool-v1-1-5749d5d6df24@daynix.com
Signed-off-by: Paolo Bonzini <pbonzini@redhat.com>
This commit is contained in:
parent
b69801dd6b
commit
36324c6774
1 changed files with 21 additions and 3 deletions
|
|
@ -4,9 +4,11 @@
|
||||||
#include "qapi/error.h"
|
#include "qapi/error.h"
|
||||||
#include "qapi/qapi-visit-qom.h"
|
#include "qapi/qapi-visit-qom.h"
|
||||||
#include "qobject/qobject.h"
|
#include "qobject/qobject.h"
|
||||||
|
#include "qobject/qbool.h"
|
||||||
#include "qobject/qdict.h"
|
#include "qobject/qdict.h"
|
||||||
#include "qapi/qmp/qerror.h"
|
#include "qapi/qmp/qerror.h"
|
||||||
#include "qobject/qjson.h"
|
#include "qobject/qjson.h"
|
||||||
|
#include "qobject/qstring.h"
|
||||||
#include "qapi/qobject-input-visitor.h"
|
#include "qapi/qobject-input-visitor.h"
|
||||||
#include "qapi/qobject-output-visitor.h"
|
#include "qapi/qobject-output-visitor.h"
|
||||||
#include "qom/object_interfaces.h"
|
#include "qom/object_interfaces.h"
|
||||||
|
|
@ -177,9 +179,25 @@ char *object_property_help(const char *name, const char *type,
|
||||||
g_string_append(str, description);
|
g_string_append(str, description);
|
||||||
}
|
}
|
||||||
if (defval) {
|
if (defval) {
|
||||||
g_autofree char *def_json = g_string_free(qobject_to_json(defval),
|
g_autofree char *def_json = NULL;
|
||||||
false);
|
const char *def;
|
||||||
g_string_append_printf(str, " (default: %s)", def_json);
|
|
||||||
|
switch (qobject_type(defval)) {
|
||||||
|
case QTYPE_QSTRING:
|
||||||
|
def = qstring_get_str(qobject_to(QString, defval));
|
||||||
|
break;
|
||||||
|
|
||||||
|
case QTYPE_QBOOL:
|
||||||
|
def = qbool_get_bool(qobject_to(QBool, defval)) ? "on" : "off";
|
||||||
|
break;
|
||||||
|
|
||||||
|
default:
|
||||||
|
def_json = g_string_free(qobject_to_json(defval), false);
|
||||||
|
def = def_json;
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
|
||||||
|
g_string_append_printf(str, " (default: %s)", def);
|
||||||
}
|
}
|
||||||
|
|
||||||
return g_string_free(str, false);
|
return g_string_free(str, false);
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue