On 3/9/20 8:44 AM, Peter Maydell wrote: > 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 > is the same as rST was. > * 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. > * headings and subheadings must now be in a freeform > documentation comment of their own > * we support arbitrary levels of sub- and sub-sub-heading, not > just a main and sub-heading like the old texinfo generator > > Signed-off-by: Peter Maydell <peter.mayd...@linaro.org> > --- > docs/devel/qapi-code-gen.txt | 90 ++++++++++++++++++++++++------------ > 1 file changed, 61 insertions(+), 29 deletions(-)
Reviewed-by: Richard Henderson <richard.hender...@linaro.org> r~
