Commit 80742642 authored by Gonglei's avatar Gonglei Committed by Andreas Färber
Browse files

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: default avatarGonglei <arei.gonglei@huawei.com>
Reviewed-by: default avatarPaolo Bonzini <pbonzini@redhat.com>
Reviewed-by: default avatarMichael S. Tsirkin <mst@redhat.com>
Signed-off-by: default avatarAndreas Färber <afaerber@suse.de>
parent 51b2e8c3

include/qom/object.h

+14 −0
Original line number Diff line number Diff line
@@ -338,6 +338,7 @@ typedef struct ObjectProperty 
{

    gchar *name;

    gchar *type;

    gchar *description;

    ObjectPropertyAccessor *get;

    ObjectPropertyAccessor *set;

    ObjectPropertyResolve *resolve;
@@ -1274,6 +1275,19 @@ void object_property_add_alias(Object *obj, const char *name, 
                               Object *target_obj, const char *target_name,

                               Error **errp);



/**

 * object_property_set_description:

 * @obj: the object owning the property

 * @name: the name of the property

 * @description: the description of the property on the object

 * @errp: if an error occurs, a pointer to an area to store the error

 *

 * Set an object property's description.

 *

 */

void object_property_set_description(Object *obj, const char *name,

                                     const char *description, Error **errp);



/**

 * object_child_foreach:

 * @obj: the object whose children will be navigated

qom/object.c

+20 −0
Original line number Diff line number Diff line
@@ -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);