From nobody Tue Feb 10 09:10:35 2026 Delivered-To: importer@patchew.org Received-SPF: pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) client-ip=209.51.188.17; envelope-from=qemu-devel-bounces+importer=patchew.org@nongnu.org; helo=lists.gnu.org; Authentication-Results: mx.zohomail.com; dkim=fail; spf=pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org; dmarc=fail(p=none dis=none) header.from=redhat.com ARC-Seal: i=1; a=rsa-sha256; t=1575200458; cv=none; d=zohomail.com; s=zohoarc; b=G7Ifdefxlo9+qvc+r9Rl/gYPfCMS2JsyU2XOMUZMFr6CcQQMFcJtAaDYWRqp7sCoqeUYdrPtw1OiCCw2YHIb/AQWUc4Sx7JsYB8xL6fBtrkj/cteibUHZ1TKK0GgiWokSd2l7qXZpiSpRYwigjgEwj7S40yBfYejg4xjPLpuGdI= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1575200458; h=Content-Type:Content-Transfer-Encoding:Cc:Date:From:In-Reply-To:List-Subscribe:List-Post:List-Id:List-Archive:List-Help:List-Unsubscribe:MIME-Version:Message-ID:References:Sender:Subject:To; bh=16EeidR84h6uFImS/TYX0QxZfzE4Dov83ev40SRRU7E=; b=BS5tPLJFk+k0RQwAe48QUGrOQJJWedO4Nq/I+KohkPpcN8uDb3he+wuRW4ClaZ0d44S78noYSaKcDdspk5l3B0Eo3AOl8oliGPEWtaDfRCBhlmCx5gf7TcUfrb9e9eJcmZuMY9xbIbtuVYX3txHV2s/KSUyiVBkgXhAyIaWUngc= ARC-Authentication-Results: i=1; mx.zohomail.com; dkim=fail; spf=pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org; dmarc=fail header.from= (p=none dis=none) header.from= Return-Path: Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) by mx.zohomail.com with SMTPS id 1575200458835775.8379408457834; Sun, 1 Dec 2019 03:40:58 -0800 (PST) Received: from localhost ([::1]:50406 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1ibNaz-0001fz-4O for importer@patchew.org; Sun, 01 Dec 2019 06:40:57 -0500 Received: from eggs.gnu.org ([2001:470:142:3::10]:38207) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1ibNGV-0003UJ-1c for qemu-devel@nongnu.org; Sun, 01 Dec 2019 06:19:48 -0500 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1ibNGT-00023p-QJ for qemu-devel@nongnu.org; Sun, 01 Dec 2019 06:19:46 -0500 Received: from us-smtp-delivery-1.mimecast.com ([205.139.110.120]:52177 helo=us-smtp-1.mimecast.com) by eggs.gnu.org with esmtps (TLS1.0:DHE_RSA_AES_256_CBC_SHA1:32) (Exim 4.71) (envelope-from ) id 1ibNGT-00022u-MJ for qemu-devel@nongnu.org; Sun, 01 Dec 2019 06:19:45 -0500 Received: from mimecast-mx01.redhat.com (mimecast-mx01.redhat.com [209.132.183.4]) (Using TLS) by relay.mimecast.com with ESMTP id us-mta-396-MJxRRxzoNvWUr_K3Mc0hLA-1; Sun, 01 Dec 2019 06:19:44 -0500 Received: from smtp.corp.redhat.com (int-mx05.intmail.prod.int.phx2.redhat.com [10.5.11.15]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx01.redhat.com (Postfix) with ESMTPS id 7104780183C for ; Sun, 1 Dec 2019 11:19:43 +0000 (UTC) Received: from localhost (unknown [10.36.112.15]) by smtp.corp.redhat.com (Postfix) with ESMTP id 8DAF35D6A0; Sun, 1 Dec 2019 11:19:39 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1575199185; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=16EeidR84h6uFImS/TYX0QxZfzE4Dov83ev40SRRU7E=; b=OLvOcXzydvZj8HDf6uq+5CJl9nxnFf/M8oDq2MM+uVucC2J5og23PuDna0MfQi5Xqyeppc Frb9eYKHLLEKU880tNkQyHIZxFM0K3cqLjnBm/7EuRKaYZZJ7GoV9Cirn59d4cw9sBIWuM yAq2/jEn9a6jtT6GBQHTL47wSpOihUU= From: =?UTF-8?q?Marc-Andr=C3=A9=20Lureau?= To: qemu-devel@nongnu.org Subject: [PATCH 24/26] qom: introduce object_property_help() Date: Sun, 1 Dec 2019 15:15:29 +0400 Message-Id: <20191201111531.1136947-25-marcandre.lureau@redhat.com> In-Reply-To: <20191201111531.1136947-1-marcandre.lureau@redhat.com> References: <20191201111531.1136947-1-marcandre.lureau@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 2.79 on 10.5.11.15 X-MC-Unique: MJxRRxzoNvWUr_K3Mc0hLA-1 X-Mimecast-Spam-Score: 0 Content-Transfer-Encoding: quoted-printable X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.2.x-3.x [generic] [fuzzy] X-Received-From: 205.139.110.120 X-BeenThere: qemu-devel@nongnu.org X-Mailman-Version: 2.1.23 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: pbonzini@redhat.com, berrange@redhat.com, ehabkost@redhat.com, =?UTF-8?q?Marc-Andr=C3=A9=20Lureau?= Errors-To: qemu-devel-bounces+importer=patchew.org@nongnu.org Sender: "Qemu-devel" X-ZohoMail-DKIM: fail (Header signature does not verify) Content-Type: text/plain; charset="utf-8" Let's factor out the code to format a help string for a property. We are going to reuse it in qdev next, which will bring some consistency. Signed-off-by: Marc-Andr=C3=A9 Lureau --- include/qom/object.h | 14 ++++++++++++++ qom/object_interfaces.c | 39 +++++++++++++++++++++++---------------- 2 files changed, 37 insertions(+), 16 deletions(-) diff --git a/include/qom/object.h b/include/qom/object.h index aa2cf1ca75..adbccb7705 100644 --- a/include/qom/object.h +++ b/include/qom/object.h @@ -1834,4 +1834,18 @@ Object *container_get(Object *root, const char *path= ); * Returns the instance_size of the given @typename. */ size_t object_type_get_instance_size(const char *typename); + +/** + * object_property_help: + * @name: the name of the property + * @type: the type of the property + * @defval: the default value + * @description: description of the property + * + * Returns: a user-friendly formatted string describing the property + * for help purposes. + */ +char *object_property_help(const char *name, const char *type, + const char *defval, const char *description); + #endif diff --git a/qom/object_interfaces.c b/qom/object_interfaces.c index edb4cc4a3d..b7157d6ab0 100644 --- a/qom/object_interfaces.c +++ b/qom/object_interfaces.c @@ -158,6 +158,25 @@ int user_creatable_add_opts_foreach(void *opaque, Qemu= Opts *opts, Error **errp) return 0; } =20 +char *object_property_help(const char *name, const char *type, + const char *defval, const char *description) +{ + GString *str =3D g_string_new(NULL); + + g_string_append_printf(str, " %s=3D<%s>", name, type); + if (defval) { + g_string_append_printf(str, " (default: %s)", defval); + } + if (description) { + if (str->len < 24) { + g_string_append_printf(str, "%*s", 24 - (int)str->len, ""); + } + g_string_append_printf(str, " - %s", description); + } + + return g_string_free(str, false); +} + bool user_creatable_print_help(const char *type, QemuOpts *opts) { ObjectClass *klass; @@ -184,27 +203,15 @@ bool user_creatable_print_help(const char *type, Qemu= Opts *opts) =20 object_class_property_iter_init(&iter, klass); while ((prop =3D object_property_iter_next(&iter))) { - GString *str; - char *defval; + g_autofree char *defval =3D object_property_get_default(prop); =20 if (!prop->set) { continue; } =20 - str =3D g_string_new(NULL); - g_string_append_printf(str, " %s=3D<%s>", prop->name, prop->t= ype); - defval =3D object_property_get_default(prop); - if (defval) { - g_string_append_printf(str, " (default: %s)", defval); - g_free(defval); - } - if (prop->description) { - if (str->len < 24) { - g_string_append_printf(str, "%*s", 24 - (int)str->len,= ""); - } - g_string_append_printf(str, " - %s", prop->description); - } - g_ptr_array_add(array, g_string_free(str, false)); + g_ptr_array_add(array, + object_property_help(prop->name, prop->type, + defval, prop->description= )); } g_ptr_array_sort(array, (GCompareFunc)qemu_pstrcmp0); if (array->len > 0) { --=20 2.24.0