qom: Add description field in ObjectProperty struct

The descriptions can serve as documentation in the code,
and they can be used to provide better help.

Copy property descriptions when copying alias properties.

Cc: Markus Armbruster <armbru@redhat.com>
Signed-off-by: Gonglei <arei.gonglei@huawei.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:
Gonglei 2014-10-07 14:33:21 +08:00 committed by Andreas Färber
parent 51b2e8c331
commit 8074264203
2 changed files with 34 additions and 0 deletions

View file

@ -369,6 +369,7 @@ static void object_property_del_all(Object *obj)
g_free(prop->name);
g_free(prop->type);
g_free(prop->description);
g_free(prop);
}
}
@ -803,6 +804,7 @@ void object_property_del(Object *obj, const char *name, Error **errp)
g_free(prop->name);
g_free(prop->type);
g_free(prop->description);
g_free(prop);
}
@ -1672,10 +1674,28 @@ void object_property_add_alias(Object *obj, const char *name,
}
op->resolve = property_resolve_alias;
object_property_set_description(obj, name,
target_prop->description,
&error_abort);
out:
g_free(prop_type);
}
void object_property_set_description(Object *obj, const char *name,
const char *description, Error **errp)
{
ObjectProperty *op;
op = object_property_find(obj, name, errp);
if (!op) {
return;
}
g_free(op->description);
op->description = g_strdup(description);
}
static void object_instance_init(Object *obj)
{
object_property_add_str(obj, "type", qdev_get_type, NULL, NULL);