OSDN Git Service

docs/devel/qapi-code-gen.txt: Update to new rST backend conventions
authorPeter Maydell <peter.maydell@linaro.org>
Fri, 25 Sep 2020 16:23:12 +0000 (17:23 +0100)
committerMarkus Armbruster <armbru@redhat.com>
Tue, 29 Sep 2020 15:55:39 +0000 (17:55 +0200)
commit55ec69f8b16d9ef03076fbaa0a9f97279218c29c
tree2bb72fa10e9cbf0bfe5ac0488d469add6afa5fe8
parenta27ff0a24916e7a6cdc90e4a984423069d8dfea6
docs/devel/qapi-code-gen.txt: Update to new rST backend conventions

Update the documentation of QAPI document comment syntax to match
the new rST backend requirements. The principal changes are:
 * whitespace is now significant, and multiline definitions
   must have their second and subsequent lines indented to
   match the first line
 * general rST format markup is permitted, not just the small
   set of markup the old texinfo generator handled. For most
   things (notably bulleted and itemized lists) the old format
   was the same as rST is.
 * Specific things that might trip people up:
   - instead of *bold* and _italic_ rST has **bold** and *italic*
   - lists need a preceding and following blank line
   - a lone literal '*' will need to be backslash-escaped to
     avoid a rST syntax error
 * the old leading '|' for example (literal text) blocks is
   replaced by the standard rST '::' literal block.
 * we support arbitrary levels of sub- and sub-sub-heading, not
   just a main and sub-heading like the old texinfo generator
 * lists can now be nested

Reviewed-by: Richard Henderson <richard.henderson@linaro.org>
Signed-off-by: Peter Maydell <peter.maydell@linaro.org>
Message-Id: <20200925162316.21205-18-peter.maydell@linaro.org>
Reviewed-by: Markus Armbruster <armbru@redhat.com>
[Commit message improved slightly]
Signed-off-by: Markus Armbruster <armbru@redhat.com>
docs/devel/qapi-code-gen.txt