[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[PULL 10/29] qapi/block.json: Add newline after "Example:" for block-lat
From: |
Markus Armbruster |
Subject: |
[PULL 10/29] qapi/block.json: Add newline after "Example:" for block-latency-histogram-set |
Date: |
Tue, 29 Sep 2020 22:19:07 +0200 |
From: Peter Maydell <peter.maydell@linaro.org>
The block-latency-histogram-set command is the only one which uses
the Example/Examples section with the first line of the documentation
immediately following the ':'. Bring it into line with the rest.
This will allow us to avoid special-casing the indentation handling
for "Examples" sections; instead for Examples as for any other section
header these two indentations will be equivalent:
Examples:
Line one
Line two
Examples: Line one
Line two
Signed-off-by: Peter Maydell <peter.maydell@linaro.org>
Message-Id: <20200925162316.21205-3-peter.maydell@linaro.org>
Reviewed-by: Markus Armbruster <armbru@redhat.com>
[Commit message tweaked]
Signed-off-by: Markus Armbruster <armbru@redhat.com>
---
qapi/block.json | 12 ++++++++----
1 file changed, 8 insertions(+), 4 deletions(-)
diff --git a/qapi/block.json b/qapi/block.json
index c54a393cf3..a009f7d3a2 100644
--- a/qapi/block.json
+++ b/qapi/block.json
@@ -528,7 +528,8 @@
#
# Since: 4.0
#
-# Example: set new histograms for all io types with intervals
+# Example:
+# set new histograms for all io types with intervals
# [0, 10), [10, 50), [50, 100), [100, +inf):
#
# -> { "execute": "block-latency-histogram-set",
@@ -536,7 +537,8 @@
# "boundaries": [10, 50, 100] } }
# <- { "return": {} }
#
-# Example: set new histogram only for write, other histograms will remain
+# Example:
+# set new histogram only for write, other histograms will remain
# not changed (or not created):
#
# -> { "execute": "block-latency-histogram-set",
@@ -544,7 +546,8 @@
# "boundaries-write": [10, 50, 100] } }
# <- { "return": {} }
#
-# Example: set new histograms with the following intervals:
+# Example:
+# set new histograms with the following intervals:
# read, flush: [0, 10), [10, 50), [50, 100), [100, +inf)
# write: [0, 1000), [1000, 5000), [5000, +inf)
#
@@ -554,7 +557,8 @@
# "boundaries-write": [1000, 5000] } }
# <- { "return": {} }
#
-# Example: remove all latency histograms:
+# Example:
+# remove all latency histograms:
#
# -> { "execute": "block-latency-histogram-set",
# "arguments": { "id": "drive0" } }
--
2.26.2
- [PULL 00/29] QAPI patches patches for 2020-09-29, Markus Armbruster, 2020/09/29
- [PULL 01/29] qapi: Restrict LostTickPolicy enum to machine code, Markus Armbruster, 2020/09/29
- [PULL 19/29] qga/qapi-schema.json: Add some headings, Markus Armbruster, 2020/09/29
- [PULL 10/29] qapi/block.json: Add newline after "Example:" for block-latency-histogram-set,
Markus Armbruster <=
- [PULL 04/29] qapi: Restrict query-vm-generation-id command to machine code, Markus Armbruster, 2020/09/29
- [PULL 07/29] qapi: Extract ACPI commands to 'acpi.json', Markus Armbruster, 2020/09/29
- [PULL 06/29] qapi: Restrict device memory commands to machine code, Markus Armbruster, 2020/09/29
- [PULL 08/29] qapi: Extract PCI commands to 'pci.json', Markus Armbruster, 2020/09/29
- [PULL 11/29] tests/qapi/doc-good.json: Prepare for qapi-doc Sphinx extension, Markus Armbruster, 2020/09/29
- [PULL 03/29] qapi: Restrict balloon-related commands to machine code, Markus Armbruster, 2020/09/29
- [PULL 09/29] qapi: Fix doc comment indentation again, Markus Armbruster, 2020/09/29
- [PULL 27/29] Remove Texinfo related line from git.orderfile, Markus Armbruster, 2020/09/29
- [PULL 20/29] tests/qapi-schema: Convert doc-good.json to rST-style strong/emphasis, Markus Armbruster, 2020/09/29
- [PULL 29/29] Remove texinfo dependency from docker and CI configs, Markus Armbruster, 2020/09/29