From nobody Mon May 12 22:28:56 2025
Delivered-To: importer@patchew.org
Authentication-Results: mx.zohomail.com;
	dkim=pass;
	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=pass(p=none dis=none)  header.from=redhat.com
ARC-Seal: i=1; a=rsa-sha256; t=1734445853; cv=none;
	d=zohomail.com; s=zohoarc;
	b=kwKPS6KCMO0iMwSSw7uVzn0h8mn90hdsUC7pKJSqDKfdRtkHzoU8AbqiCbhWqqELGy8wi1JAWcMsq2p48Cdu4EPrOvbku4WnwDxx103oJhBjDp1gU2pZL8s8i2tEtfyRNsDpXwzlDTs/j5u9TBA6Qs8WUBYcmjdF0+yn95qTSiQ=
ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com;
 s=zohoarc;
	t=1734445853;
 h=Content-Transfer-Encoding:Cc:Cc:Date:Date:From:From:In-Reply-To:List-Subscribe:List-Post:List-Id:List-Archive:List-Help:List-Unsubscribe:MIME-Version:Message-ID:References:Sender:Subject:Subject:To:To:Message-Id:Reply-To;
	bh=6SqltVUWNc6UgRkUvEyjQbL5CA7fkjtW7Wbr++SLBQk=;
	b=WiNQg6Nsjv7rhWeYxkKQW9nCIw0vmVv4/HhsE4ilHQ9zZIw1sms7p41rZxdddzA0wsui8BNZt/O8FIVMSkMn4klBOZ0wn4vS+rCTdHNxbzasPSl4v/O5NsvPpKLGBFwvaz74rHC4iDbZf89c1WjqkALPAUjnuQEgegysK24qsGE=
ARC-Authentication-Results: i=1; mx.zohomail.com;
	dkim=pass;
	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=pass header.from=<armbru@redhat.com> (p=none dis=none)
Return-Path: <qemu-devel-bounces+importer=patchew.org@nongnu.org>
Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) by
 mx.zohomail.com
	with SMTPS id 1734445853325472.97136483990494;
 Tue, 17 Dec 2024 06:30:53 -0800 (PST)
Received: from localhost ([::1] helo=lists1p.gnu.org)
	by lists.gnu.org with esmtp (Exim 4.90_1)
	(envelope-from <qemu-devel-bounces@nongnu.org>)
	id 1tNYag-0002gV-VD; Tue, 17 Dec 2024 09:30:27 -0500
Received: from eggs.gnu.org ([2001:470:142:3::10])
 by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256)
 (Exim 4.90_1) (envelope-from <armbru@redhat.com>) id 1tNYZU-00011S-KW
 for qemu-devel@nongnu.org; Tue, 17 Dec 2024 09:29:15 -0500
Received: from us-smtp-delivery-124.mimecast.com ([170.10.129.124])
 by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256)
 (Exim 4.90_1) (envelope-from <armbru@redhat.com>) id 1tNYZM-0004wq-P1
 for qemu-devel@nongnu.org; Tue, 17 Dec 2024 09:29:10 -0500
Received: from mx-prod-mc-05.mail-002.prod.us-west-2.aws.redhat.com
 (ec2-54-186-198-63.us-west-2.compute.amazonaws.com [54.186.198.63]) by
 relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.3,
 cipher=TLS_AES_256_GCM_SHA384) id us-mta-637-mnlxul7lP9GIfrE2gJfNTw-1; Tue,
 17 Dec 2024 09:29:01 -0500
Received: from mx-prod-int-04.mail-002.prod.us-west-2.aws.redhat.com
 (mx-prod-int-04.mail-002.prod.us-west-2.aws.redhat.com [10.30.177.40])
 (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)
 key-exchange X25519 server-signature RSA-PSS (2048 bits) server-digest
 SHA256)
 (No client certificate requested)
 by mx-prod-mc-05.mail-002.prod.us-west-2.aws.redhat.com (Postfix) with ESMTPS
 id 3FF591955EA3; Tue, 17 Dec 2024 14:29:00 +0000 (UTC)
Received: from blackfin.pond.sub.org (unknown [10.39.192.27])
 by mx-prod-int-04.mail-002.prod.us-west-2.aws.redhat.com (Postfix) with
 ESMTPS
 id F41DE19560AD; Tue, 17 Dec 2024 14:28:59 +0000 (UTC)
Received: by blackfin.pond.sub.org (Postfix, from userid 1000)
 id 1688F21E6613; Tue, 17 Dec 2024 15:28:55 +0100 (CET)
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com;
 s=mimecast20190719; t=1734445744;
 h=from:from:reply-to:subject:subject:date:date:message-id:message-id:
 to:to:cc:cc:mime-version:mime-version:
 content-transfer-encoding:content-transfer-encoding:
 in-reply-to:in-reply-to:references:references;
 bh=6SqltVUWNc6UgRkUvEyjQbL5CA7fkjtW7Wbr++SLBQk=;
 b=aZwWInuK9TZu+AHd4/9xTN7GkuPpPfsNI1scNz8A19NXMCVuqcg8jMMVY7qpGswaK4lRXp
 PJUHjV2JDgWUvyjV53q/Q7oe8Z0KT6N48Hm4VOGJIv1FXcnmqA3BAJkrK7jowRXuZVDPli
 M1wqCNVhCkHv4BwGIsLN2wHcPi5w6RY=
X-MC-Unique: mnlxul7lP9GIfrE2gJfNTw-1
X-Mimecast-MFC-AGG-ID: mnlxul7lP9GIfrE2gJfNTw
From: Markus Armbruster <armbru@redhat.com>
To: qemu-devel@nongnu.org
Cc: pbonzini@redhat.com,
	berrange@redhat.com,
	eduardo@habkost.net
Subject: [PATCH 5/6] qdev: Improve PropertyInfo member @description for enum
 properties
Date: Tue, 17 Dec 2024 15:28:53 +0100
Message-ID: <20241217142855.3805068-6-armbru@redhat.com>
In-Reply-To: <20241217142855.3805068-1-armbru@redhat.com>
References: <20241217142855.3805068-1-armbru@redhat.com>
MIME-Version: 1.0
Content-Transfer-Encoding: quoted-printable
X-Scanned-By: MIMEDefang 3.0 on 10.30.177.40
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;
Received-SPF: pass client-ip=170.10.129.124; envelope-from=armbru@redhat.com;
 helo=us-smtp-delivery-124.mimecast.com
X-Spam_score_int: -31
X-Spam_score: -3.2
X-Spam_bar: ---
X-Spam_report: (-3.2 / 5.0 requ) BAYES_00=-1.9, DKIMWL_WL_HIGH=-0.001,
 DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1,
 RCVD_IN_DNSWL_NONE=-0.0001, RCVD_IN_MSPIKE_H2=-1.116,
 RCVD_IN_VALIDITY_CERTIFIED_BLOCKED=0.001,
 RCVD_IN_VALIDITY_RPBL_BLOCKED=0.001,
 SPF_HELO_NONE=0.001, SPF_PASS=-0.001 autolearn=ham autolearn_force=no
X-Spam_action: no action
X-BeenThere: qemu-devel@nongnu.org
X-Mailman-Version: 2.1.29
Precedence: list
List-Id: <qemu-devel.nongnu.org>
List-Unsubscribe: <https://lists.nongnu.org/mailman/options/qemu-devel>,
 <mailto:qemu-devel-request@nongnu.org?subject=unsubscribe>
List-Archive: <https://lists.nongnu.org/archive/html/qemu-devel>
List-Post: <mailto:qemu-devel@nongnu.org>
List-Help: <mailto:qemu-devel-request@nongnu.org?subject=help>
List-Subscribe: <https://lists.nongnu.org/mailman/listinfo/qemu-devel>,
 <mailto:qemu-devel-request@nongnu.org?subject=subscribe>
Errors-To: qemu-devel-bounces+importer=patchew.org@nongnu.org
Sender: qemu-devel-bounces+importer=patchew.org@nongnu.org
X-ZohoMail-DKIM: pass (identity @redhat.com)
X-ZM-MESSAGEID: 1734445855207116600
Content-Type: text/plain; charset="utf-8"

Consistently use format "DESCRIPTION (VALUE/VALUE...)".

Signed-off-by: Markus Armbruster <armbru@redhat.com>
---
 hw/core/qdev-properties-system.c | 26 +++++++++++---------------
 1 file changed, 11 insertions(+), 15 deletions(-)

diff --git a/hw/core/qdev-properties-system.c b/hw/core/qdev-properties-sys=
tem.c
index bd6ea9673d..9d1f358263 100644
--- a/hw/core/qdev-properties-system.c
+++ b/hw/core/qdev-properties-system.c
@@ -603,6 +603,7 @@ QEMU_BUILD_BUG_ON(sizeof(LostTickPolicy) !=3D sizeof(in=
t));
=20
 const PropertyInfo qdev_prop_losttickpolicy =3D {
     .type  =3D "LostTickPolicy",
+    .description =3D "Policy for handling lost ticks (discard/delay/slew)",
     .enum_table  =3D &LostTickPolicy_lookup,
     .get   =3D qdev_propinfo_get_enum,
     .set   =3D qdev_propinfo_set_losttickpolicy,
@@ -642,8 +643,7 @@ QEMU_BUILD_BUG_ON(sizeof(BlockdevOnError) !=3D sizeof(i=
nt));
=20
 const PropertyInfo qdev_prop_blockdev_on_error =3D {
     .type =3D "BlockdevOnError",
-    .description =3D "Error handling policy, "
-                   "report/ignore/enospc/stop/auto",
+    .description =3D "Error handling policy (report/ignore/enospc/stop/aut=
o)",
     .enum_table =3D &BlockdevOnError_lookup,
     .get =3D qdev_propinfo_get_enum,
     .set =3D qdev_propinfo_set_enum,
@@ -656,8 +656,8 @@ QEMU_BUILD_BUG_ON(sizeof(BiosAtaTranslation) !=3D sizeo=
f(int));
=20
 const PropertyInfo qdev_prop_bios_chs_trans =3D {
     .type =3D "BiosAtaTranslation",
-    .description =3D "Logical CHS translation algorithm, "
-                   "auto/none/lba/large/rechs",
+    .description =3D "Logical CHS translation algorithm "
+                   " (auto/none/lba/large/rechs)",
     .enum_table =3D &BiosAtaTranslation_lookup,
     .get =3D qdev_propinfo_get_enum,
     .set =3D qdev_propinfo_set_enum,
@@ -668,8 +668,7 @@ const PropertyInfo qdev_prop_bios_chs_trans =3D {
=20
 const PropertyInfo qdev_prop_fdc_drive_type =3D {
     .type =3D "FloppyDriveType",
-    .description =3D "FDC drive type, "
-                   "144/288/120/none/auto",
+    .description =3D "Floppy drive type (144/288/120/none/auto)",
     .enum_table =3D &FloppyDriveType_lookup,
     .get =3D qdev_propinfo_get_enum,
     .set =3D qdev_propinfo_set_enum,
@@ -680,8 +679,8 @@ const PropertyInfo qdev_prop_fdc_drive_type =3D {
=20
 const PropertyInfo qdev_prop_multifd_compression =3D {
     .type =3D "MultiFDCompression",
-    .description =3D "multifd_compression values, "
-                   "none/zlib/zstd/qpl/uadk/qatzip",
+    .description =3D "multifd_compression values"
+                   " (none/zlib/zstd/qpl/uadk/qatzip)",
     .enum_table =3D &MultiFDCompression_lookup,
     .get =3D qdev_propinfo_get_enum,
     .set =3D qdev_propinfo_set_enum,
@@ -694,8 +693,7 @@ QEMU_BUILD_BUG_ON(sizeof(MigMode) !=3D sizeof(int));
=20
 const PropertyInfo qdev_prop_mig_mode =3D {
     .type =3D "MigMode",
-    .description =3D "mig_mode values, "
-                   "normal,cpr-reboot",
+    .description =3D "Migration mode (normal/cpr-reboot)",
     .enum_table =3D &MigMode_lookup,
     .get =3D qdev_propinfo_get_enum,
     .set =3D qdev_propinfo_set_enum,
@@ -708,8 +706,7 @@ QEMU_BUILD_BUG_ON(sizeof(GranuleMode) !=3D sizeof(int));
=20
 const PropertyInfo qdev_prop_granule_mode =3D {
     .type =3D "GranuleMode",
-    .description =3D "granule_mode values, "
-                   "4k, 8k, 16k, 64k, host",
+    .description =3D "Granule page size (4k/8k/16k/64k/host)",
     .enum_table =3D &GranuleMode_lookup,
     .get =3D qdev_propinfo_get_enum,
     .set =3D qdev_propinfo_set_enum,
@@ -718,8 +715,7 @@ const PropertyInfo qdev_prop_granule_mode =3D {
=20
 const PropertyInfo qdev_prop_zero_page_detection =3D {
     .type =3D "ZeroPageDetection",
-    .description =3D "zero_page_detection values, "
-                   "none,legacy,multifd",
+    .description =3D "Zero page detection (none/legacy/multifd)",
     .enum_table =3D &ZeroPageDetection_lookup,
     .get =3D qdev_propinfo_get_enum,
     .set =3D qdev_propinfo_set_enum,
@@ -1232,7 +1228,7 @@ QEMU_BUILD_BUG_ON(sizeof(S390CpuEntitlement) !=3D siz=
eof(int));
=20
 const PropertyInfo qdev_prop_cpus390entitlement =3D {
     .type  =3D "S390CpuEntitlement",
-    .description =3D "low/medium (default)/high",
+    .description =3D "auto/low/medium/high (default medium)",
     .enum_table  =3D &S390CpuEntitlement_lookup,
     .get   =3D qdev_propinfo_get_enum,
     .set   =3D qdev_propinfo_set_enum,
--=20
2.47.0