| Message ID | 20200925162316.21205-3-peter.maydell@linaro.org |
|---|---|
| State | New |
| Headers | show |
| Series | Convert QAPI doc comments to generate rST instead of texinfo | expand |
Peter Maydell <peter.maydell@linaro.org> writes: > 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: I figure you're talking about PATCH 5 here. Correct? If yes, I'd like to tweak this to "This will allow us". Okay? > > Examples: > Line one > Line two > > Examples: Line one > Line two > > Signed-off-by: Peter Maydell <peter.maydell@linaro.org>
On Mon, 28 Sep 2020 at 13:42, Markus Armbruster <armbru@redhat.com> wrote: > > Peter Maydell <peter.maydell@linaro.org> writes: > > > 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: > > I figure you're talking about PATCH 5 here. Correct? > > If yes, I'd like to tweak this to "This will allow us". Okay? Sure. (In my idiolect both those phrasings have pretty much identical meaning in this context.) thanks -- PMM
Peter Maydell <peter.maydell@linaro.org> writes: > On Mon, 28 Sep 2020 at 13:42, Markus Armbruster <armbru@redhat.com> wrote: >> >> Peter Maydell <peter.maydell@linaro.org> writes: >> >> > 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: >> >> I figure you're talking about PATCH 5 here. Correct? >> >> If yes, I'd like to tweak this to "This will allow us". Okay? > > Sure. (In my idiolect both those phrasings have pretty much > identical meaning in this context.) > > thanks > -- PMM Neglected to say Reviewed-by: Markus Armbruster <armbru@redhat.com>
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" } }
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(-)