Skip to content

Commit 23d017c

Browse files
author
Markus Armbruster
committed
docs/devel/qapi-code-gen: Tidy up whitespace
Consistently use two spaces to separate sentences. Put "::" on a line of its own when it's preceded by whitespace. Signed-off-by: Markus Armbruster <[email protected]> Message-ID: <[email protected]> Reviewed-by: Eric Blake <[email protected]>
1 parent dfaecc0 commit 23d017c

File tree

1 file changed

+14
-12
lines changed

1 file changed

+14
-12
lines changed

docs/devel/qapi-code-gen.rst

Lines changed: 14 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -763,8 +763,8 @@ Names beginning with ``x-`` used to signify "experimental". This
763763
convention has been replaced by special feature "unstable".
764764

765765
Pragmas ``command-name-exceptions`` and ``member-name-exceptions`` let
766-
you violate naming rules. Use for new code is strongly discouraged. See
767-
`Pragma directives`_ for details.
766+
you violate naming rules. Use for new code is strongly discouraged.
767+
See `Pragma directives`_ for details.
768768

769769

770770
Downstream extensions
@@ -1013,7 +1013,7 @@ like this::
10131013
document the success and the error response, respectively.
10141014

10151015
"Errors" sections should be formatted as an rST list, each entry
1016-
detailing a relevant error condition. For example::
1016+
detailing a relevant error condition. For example::
10171017

10181018
# Errors:
10191019
# - If @device does not exist, DeviceNotFound
@@ -1026,13 +1026,13 @@ definition.
10261026
QMP). In other sections, the text is formatted, and rST markup can be
10271027
used.
10281028

1029-
QMP Examples can be added by using the ``.. qmp-example::``
1030-
directive. In its simplest form, this can be used to contain a single
1031-
QMP code block which accepts standard JSON syntax with additional server
1029+
QMP Examples can be added by using the ``.. qmp-example::`` directive.
1030+
In its simplest form, this can be used to contain a single QMP code
1031+
block which accepts standard JSON syntax with additional server
10321032
directionality indicators (``->`` and ``<-``), and elisions (``...``).
10331033

10341034
Optionally, a plaintext title may be provided by using the ``:title:``
1035-
directive option. If the title is omitted, the example title will
1035+
directive option. If the title is omitted, the example title will
10361036
default to "Example:".
10371037

10381038
A simple QMP example::
@@ -1043,10 +1043,10 @@ A simple QMP example::
10431043
# -> { "execute": "query-block" }
10441044
# <- { ... }
10451045

1046-
More complex or multi-step examples where exposition is needed before or
1047-
between QMP code blocks can be created by using the ``:annotated:``
1048-
directive option. When using this option, nested QMP code blocks must be
1049-
entered explicitly with rST's ``::`` syntax.
1046+
More complex or multi-step examples where exposition is needed before
1047+
or between QMP code blocks can be created by using the ``:annotated:``
1048+
directive option. When using this option, nested QMP code blocks must
1049+
be entered explicitly with rST's ``::`` syntax.
10501050

10511051
Highlighting in non-QMP languages can be accomplished by using the
10521052
``.. code-block:: lang`` directive, and non-highlighted text can be
@@ -1466,7 +1466,9 @@ As an example, we'll use the following schema, which describes a
14661466
single complex user-defined type, along with command which takes a
14671467
list of that type as a parameter, and returns a single element of that
14681468
type. The user is responsible for writing the implementation of
1469-
qmp_my_command(); everything else is produced by the generator. ::
1469+
qmp_my_command(); everything else is produced by the generator.
1470+
1471+
::
14701472

14711473
$ cat example-schema.json
14721474
{ 'struct': 'UserDefOne',

0 commit comments

Comments
 (0)