[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[Qemu-devel] [PATCH] qapi: Remove unwanted commas after #optional keywor
From: |
Stefan Weil |
Subject: |
[Qemu-devel] [PATCH] qapi: Remove unwanted commas after #optional keyword |
Date: |
Sun, 22 Jan 2017 15:54:07 +0100 |
We don't want that commas to be part of the generated documentation,
so remove them.
Signed-off-by: Stefan Weil <address@hidden>
---
This is an alternative solution for the issue which is also addressed
by my previous patch http://patchwork.ozlabs.org/patch/718177/.
It's also possible to apply both patches.
Stefan
qapi-schema.json | 4 ++--
qapi/block-core.json | 10 +++++-----
qapi/event.json | 6 +++---
3 files changed, 10 insertions(+), 10 deletions(-)
diff --git a/qapi-schema.json b/qapi-schema.json
index ddc878390e..176e1a5a0b 100644
--- a/qapi-schema.json
+++ b/qapi-schema.json
@@ -1506,7 +1506,7 @@
#
# The network connection information for server
#
-# @auth: #optional, authentication method
+# @auth: #optional authentication method
#
# Since: 2.1
##
@@ -1694,7 +1694,7 @@
#
# Information about a SPICE server
#
-# @auth: #optional, authentication method
+# @auth: #optional authentication method
#
# Since: 2.1
##
diff --git a/qapi/block-core.json b/qapi/block-core.json
index 1b3e6eb0e8..932f5bb3b4 100644
--- a/qapi/block-core.json
+++ b/qapi/block-core.json
@@ -3126,10 +3126,10 @@
#
# @filename: filename of the new image to be loaded
#
-# @format: #optional, format to open the new image with (defaults to
+# @format: #optional format to open the new image with (defaults to
# the probed format)
#
-# @read-only-mode: #optional, change the read-only mode of the device;
defaults
+# @read-only-mode: #optional change the read-only mode of the device; defaults
# to 'retain'
#
# Since: 2.5
@@ -3208,10 +3208,10 @@
# corruption being detected. It should not be parsed by machine as it is
# not guaranteed to be stable
#
-# @offset: #optional, if the corruption resulted from an image access, this is
+# @offset: #optional if the corruption resulted from an image access, this is
# the host's access offset into the image
#
-# @size: #optional, if the corruption resulted from an image access, this is
+# @size: #optional if the corruption resulted from an image access, this is
# the access size
#
# @fatal: if set, the image is marked corrupt and therefore unusable after this
@@ -3302,7 +3302,7 @@
#
# @speed: rate limit, bytes per second
#
-# @error: #optional, error message. Only present on failure. This field
+# @error: #optional error message. Only present on failure. This field
# contains a human-readable error message. There are no semantics
# other than that streaming has failed and clients should not try to
# interpret the error string
diff --git a/qapi/event.json b/qapi/event.json
index f3737b771f..7bf539b84d 100644
--- a/qapi/event.json
+++ b/qapi/event.json
@@ -186,7 +186,7 @@
# At this point, it's safe to reuse the specified device ID. Device removal can
# be initiated by the guest or by HMP/QMP commands.
#
-# @device: #optional, device name
+# @device: #optional device name
#
# @path: device path
#
@@ -209,7 +209,7 @@
# Emitted once until the 'query-rx-filter' command is executed, the first event
# will always be emitted
#
-# @name: #optional, net client name
+# @name: #optional net client name
#
# @path: device path
#
@@ -531,7 +531,7 @@
#
# @type: quorum operation type (Since 2.6)
#
-# @error: #optional, error message. Only present on failure. This field
+# @error: #optional error message. Only present on failure. This field
# contains a human-readable error message. There are no semantics other
# than that the block layer reported an error and clients should not
# try to interpret the error string.
--
2.11.0
- [Qemu-devel] [PATCH] qapi: Remove unwanted commas after #optional keyword,
Stefan Weil <=