mirror of
https://github.com/xemu-project/xemu.git
synced 2024-11-24 20:19:44 +00:00
55ec69f8b1
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>
|
||
|---|---|---|
| .. | ||
| atomics.rst | ||
| bitops.rst | ||
| blkdebug.txt | ||
| blkverify.txt | ||
| build-system.rst | ||
| clocks.rst | ||
| conf.py | ||
| decodetree.rst | ||
| fuzzing.txt | ||
| index.rst | ||
| kconfig.rst | ||
| loads-stores.rst | ||
| lockcnt.txt | ||
| memory.rst | ||
| migration.rst | ||
| multi-thread-tcg.rst | ||
| multiple-iothreads.txt | ||
| qapi-code-gen.txt | ||
| rcu.txt | ||
| replay.txt | ||
| reset.rst | ||
| s390-dasd-ipl.rst | ||
| secure-coding-practices.rst | ||
| stable-process.rst | ||
| tcg-icount.rst | ||
| tcg-plugins.rst | ||
| tcg.rst | ||
| testing.rst | ||
| tracing.txt | ||
| virtio-migration.txt | ||
| writing-qmp-commands.txt | ||