qapi: Fix argument documentation markup

Member / argument documentation of BlockdevAmendOptionsQcow2,
job-resume, and RDMA_GID_STATUS_CHANGED is parsed as ordinary text due
to missing colon or space before the colon.  The generated
documentation shows these members / arguments as "Not documented".

The fix is obvious: add missing colons, delete extra spaces.

Signed-off-by: Markus Armbruster <armbru@redhat.com>
Reviewed-by: Vladimir Sementsov-Ogievskiy <vsementsov@yandex-team.ru>
Reviewed-by: Marc-André Lureau <marcandre.lureau@redhat.com>
Message-Id: <20230425064223.820979-13-armbru@redhat.com>

diff --git a/qapi/block-core.json b/qapi/block-core.json
index 2382772e1720d475d42c0d95d47ee8d2aa6550c7..9dd5ed9a4725ae48b09e574698082c3743596a55 100644 (file)
--- a/qapi/block-core.json
+++ b/qapi/block-core.json
@@ -5155,7 +5155,7 @@
 # Driver specific image amend options for qcow2.
 # For now, only encryption options can be amended
 #
-# @encrypt          Encryption options to be amended
+# @encrypt: Encryption options to be amended
 #
 # Since: 5.1
 ##

diff --git a/qapi/job.json b/qapi/job.json
index d5f84e9615ba46a5957f5ce2b3d187f28af551c2..bc4104757afe185ab45ff24d2c2c3df56a5db31c 100644 (file)
--- a/qapi/job.json
+++ b/qapi/job.json
@@ -148,7 +148,7 @@
 # This command returns immediately after resuming a paused job. Resuming an
 # already running job is an error.
 #
-# @id : The job identifier.
+# @id: The job identifier.
 #
 # Since: 3.0
 ##

diff --git a/qapi/rdma.json b/qapi/rdma.json
index a1d2175a8b3614d237f0cfb0a57f2f680a57cff9..5b6b66afa4df5ef375b4d3b18aa6dd2f04f2f2fd 100644 (file)
--- a/qapi/rdma.json
+++ b/qapi/rdma.json
@@ -17,7 +17,7 @@
 #
 # @subnet-prefix: Subnet Prefix
 #
-# @interface-id : Interface ID
+# @interface-id: Interface ID
 #
 # Since: 4.0
 #