qdev: Add description field in PropertyInfo struct
The descriptions can serve as documentation in the code, and they can be used to provide better help. Cc: Markus Armbruster <armbru@redhat.com> Signed-off-by: Gonglei <arei.gonglei@huawei.com> Signed-off-by: Paolo Bonzini <pbonzini@redhat.com> Reviewed-by: Paolo Bonzini <pbonzini@redhat.com> Reviewed-by: Michael S. Tsirkin <mst@redhat.com> Signed-off-by: Andreas Färber <afaerber@suse.de>
This commit is contained in:
parent
b6cc36abb2
commit
51b2e8c331
|
@ -113,6 +113,7 @@ static void set_drive(Object *obj, Visitor *v, void *opaque,
|
||||||
PropertyInfo qdev_prop_drive = {
|
PropertyInfo qdev_prop_drive = {
|
||||||
.name = "str",
|
.name = "str",
|
||||||
.legacy_name = "drive",
|
.legacy_name = "drive",
|
||||||
|
.description = "ID of a drive to use as a backend",
|
||||||
.get = get_drive,
|
.get = get_drive,
|
||||||
.set = set_drive,
|
.set = set_drive,
|
||||||
.release = release_drive,
|
.release = release_drive,
|
||||||
|
@ -170,6 +171,7 @@ static void set_chr(Object *obj, Visitor *v, void *opaque,
|
||||||
PropertyInfo qdev_prop_chr = {
|
PropertyInfo qdev_prop_chr = {
|
||||||
.name = "str",
|
.name = "str",
|
||||||
.legacy_name = "chr",
|
.legacy_name = "chr",
|
||||||
|
.description = "ID of a chardev to use as a backend",
|
||||||
.get = get_chr,
|
.get = get_chr,
|
||||||
.set = set_chr,
|
.set = set_chr,
|
||||||
.release = release_chr,
|
.release = release_chr,
|
||||||
|
@ -249,6 +251,7 @@ static void set_netdev(Object *obj, Visitor *v, void *opaque,
|
||||||
PropertyInfo qdev_prop_netdev = {
|
PropertyInfo qdev_prop_netdev = {
|
||||||
.name = "str",
|
.name = "str",
|
||||||
.legacy_name = "netdev",
|
.legacy_name = "netdev",
|
||||||
|
.description = "ID of a netdev to use as a backend",
|
||||||
.get = get_netdev,
|
.get = get_netdev,
|
||||||
.set = set_netdev,
|
.set = set_netdev,
|
||||||
};
|
};
|
||||||
|
@ -329,6 +332,7 @@ static void set_vlan(Object *obj, Visitor *v, void *opaque,
|
||||||
PropertyInfo qdev_prop_vlan = {
|
PropertyInfo qdev_prop_vlan = {
|
||||||
.name = "int32",
|
.name = "int32",
|
||||||
.legacy_name = "vlan",
|
.legacy_name = "vlan",
|
||||||
|
.description = "Integer VLAN id to connect to",
|
||||||
.print = print_vlan,
|
.print = print_vlan,
|
||||||
.get = get_vlan,
|
.get = get_vlan,
|
||||||
.set = set_vlan,
|
.set = set_vlan,
|
||||||
|
|
|
@ -121,6 +121,7 @@ static void prop_set_bit(Object *obj, Visitor *v, void *opaque,
|
||||||
PropertyInfo qdev_prop_bit = {
|
PropertyInfo qdev_prop_bit = {
|
||||||
.name = "bool",
|
.name = "bool",
|
||||||
.legacy_name = "on/off",
|
.legacy_name = "on/off",
|
||||||
|
.description = "on/off",
|
||||||
.get = prop_get_bit,
|
.get = prop_get_bit,
|
||||||
.set = prop_set_bit,
|
.set = prop_set_bit,
|
||||||
};
|
};
|
||||||
|
@ -456,6 +457,7 @@ inval:
|
||||||
PropertyInfo qdev_prop_macaddr = {
|
PropertyInfo qdev_prop_macaddr = {
|
||||||
.name = "str",
|
.name = "str",
|
||||||
.legacy_name = "macaddr",
|
.legacy_name = "macaddr",
|
||||||
|
.description = "Ethernet 6-byte MAC Address, example: 52:54:00:12:34:56",
|
||||||
.get = get_mac,
|
.get = get_mac,
|
||||||
.set = set_mac,
|
.set = set_mac,
|
||||||
};
|
};
|
||||||
|
@ -478,6 +480,8 @@ QEMU_BUILD_BUG_ON(sizeof(BiosAtaTranslation) != sizeof(int));
|
||||||
PropertyInfo qdev_prop_bios_chs_trans = {
|
PropertyInfo qdev_prop_bios_chs_trans = {
|
||||||
.name = "BiosAtaTranslation",
|
.name = "BiosAtaTranslation",
|
||||||
.legacy_name = "bios-chs-trans",
|
.legacy_name = "bios-chs-trans",
|
||||||
|
.description = "Logical CHS translation algorithm, "
|
||||||
|
"auto/none/lba/large/rechs",
|
||||||
.enum_table = BiosAtaTranslation_lookup,
|
.enum_table = BiosAtaTranslation_lookup,
|
||||||
.get = get_enum,
|
.get = get_enum,
|
||||||
.set = set_enum,
|
.set = set_enum,
|
||||||
|
@ -552,6 +556,7 @@ static int print_pci_devfn(DeviceState *dev, Property *prop, char *dest,
|
||||||
PropertyInfo qdev_prop_pci_devfn = {
|
PropertyInfo qdev_prop_pci_devfn = {
|
||||||
.name = "int32",
|
.name = "int32",
|
||||||
.legacy_name = "pci-devfn",
|
.legacy_name = "pci-devfn",
|
||||||
|
.description = "Slot and optional function number, example: 06.0 or 06",
|
||||||
.print = print_pci_devfn,
|
.print = print_pci_devfn,
|
||||||
.get = get_int32,
|
.get = get_int32,
|
||||||
.set = set_pci_devfn,
|
.set = set_pci_devfn,
|
||||||
|
@ -599,6 +604,7 @@ static void set_blocksize(Object *obj, Visitor *v, void *opaque,
|
||||||
PropertyInfo qdev_prop_blocksize = {
|
PropertyInfo qdev_prop_blocksize = {
|
||||||
.name = "uint16",
|
.name = "uint16",
|
||||||
.legacy_name = "blocksize",
|
.legacy_name = "blocksize",
|
||||||
|
.description = "A power of two between 512 and 32768",
|
||||||
.get = get_uint16,
|
.get = get_uint16,
|
||||||
.set = set_blocksize,
|
.set = set_blocksize,
|
||||||
};
|
};
|
||||||
|
@ -707,6 +713,8 @@ inval:
|
||||||
PropertyInfo qdev_prop_pci_host_devaddr = {
|
PropertyInfo qdev_prop_pci_host_devaddr = {
|
||||||
.name = "str",
|
.name = "str",
|
||||||
.legacy_name = "pci-host-devaddr",
|
.legacy_name = "pci-host-devaddr",
|
||||||
|
.description = "Address (bus/device/function) of "
|
||||||
|
"the host device, example: 04:10.0",
|
||||||
.get = get_pci_host_devaddr,
|
.get = get_pci_host_devaddr,
|
||||||
.set = set_pci_host_devaddr,
|
.set = set_pci_host_devaddr,
|
||||||
};
|
};
|
||||||
|
|
|
@ -231,6 +231,7 @@ struct Property {
|
||||||
struct PropertyInfo {
|
struct PropertyInfo {
|
||||||
const char *name;
|
const char *name;
|
||||||
const char *legacy_name;
|
const char *legacy_name;
|
||||||
|
const char *description;
|
||||||
const char **enum_table;
|
const char **enum_table;
|
||||||
int (*print)(DeviceState *dev, Property *prop, char *dest, size_t len);
|
int (*print)(DeviceState *dev, Property *prop, char *dest, size_t len);
|
||||||
ObjectPropertyAccessor *get;
|
ObjectPropertyAccessor *get;
|
||||||
|
|
|
@ -8045,6 +8045,7 @@ static void powerpc_set_compat(Object *obj, Visitor *v,
|
||||||
static PropertyInfo powerpc_compat_propinfo = {
|
static PropertyInfo powerpc_compat_propinfo = {
|
||||||
.name = "str",
|
.name = "str",
|
||||||
.legacy_name = "powerpc-server-compat",
|
.legacy_name = "powerpc-server-compat",
|
||||||
|
.description = "compatibility mode, power6/power7/power8",
|
||||||
.get = powerpc_get_compat,
|
.get = powerpc_get_compat,
|
||||||
.set = powerpc_set_compat,
|
.set = powerpc_set_compat,
|
||||||
};
|
};
|
||||||
|
|
Loading…
Reference in a new issue