[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[PATCH v6 02/21] qapi/block.json: Add newline after "Example:" for block
From: |
Peter Maydell |
Subject: |
[PATCH v6 02/21] qapi/block.json: Add newline after "Example:" for block-latency-histogram-set |
Date: |
Fri, 25 Sep 2020 17:22:57 +0100 |
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 allows 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>
---
qapi/block.json | 12 ++++++++----
1 file changed, 8 insertions(+), 4 deletions(-)
diff --git a/qapi/block.json b/qapi/block.json
index c54a393cf3a..a009f7d3a2d 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.20.1
- [PATCH v6 00/21] Convert QAPI doc comments to generate rST instead of texinfo, Peter Maydell, 2020/09/25
- [PATCH v6 02/21] qapi/block.json: Add newline after "Example:" for block-latency-histogram-set,
Peter Maydell <=
- [PATCH v6 01/21] qapi: Fix doc comment indentation again, Peter Maydell, 2020/09/25
- [PATCH v6 03/21] tests/qapi/doc-good.json: Prepare for qapi-doc Sphinx extension, Peter Maydell, 2020/09/25
- [PATCH v6 04/21] scripts/qapi: Move doc-comment whitespace stripping to doc.py, Peter Maydell, 2020/09/25
- [PATCH v6 06/21] qapi/machine.json: Escape a literal '*' in doc comment, Peter Maydell, 2020/09/25
- [PATCH v6 08/21] docs/interop: Convert qemu-ga-ref to rST, Peter Maydell, 2020/09/25