summaryrefslogtreecommitdiffstats
path: root/docs/sphinx
diff options
context:
space:
mode:
authorPeter Maydell2020-01-24 17:26:00 +0100
committerPeter Maydell2020-02-03 11:46:32 +0100
commitb0cecc0d65ec7c4c06cfd987e79eab1a0afee39b (patch)
tree0cece93c6efce6b88db5f6be93bbb24e300dfe4e /docs/sphinx
parentMakefile: Ensure we don't run Sphinx in parallel for manpages (diff)
downloadqemu-b0cecc0d65ec7c4c06cfd987e79eab1a0afee39b.tar.gz
qemu-b0cecc0d65ec7c4c06cfd987e79eab1a0afee39b.tar.xz
qemu-b0cecc0d65ec7c4c06cfd987e79eab1a0afee39b.zip
hxtool: Support SRST/ERST directives
We want to add support for including rST document fragments in our .hx files, in the same way we currently have texinfo fragments. These will be delimited by SRST and ERST directives, in the same way the texinfo is delimited by STEXI/ETEXI. The rST fragments will not be extracted by the hxtool script, but by a different mechanism, so all we need to do in hxtool is have it ignore all the text inside a SRST/ERST section, with suitable error-checking for mismatched rST-vs-texi fragment delimiters. The resulting effective state machine has only three states: * flag = 0, rstflag = 0 : reading section for C output * flag = 1, rstflag = 0 : reading texi fragment * flag = 0, rstflag = 1 : reading rST fragment and flag = 1, rstflag = 1 is not possible. Using two variables makes the parallel between the rST handling and the texi handling clearer; in any case all this code will be deleted once we've converted entirely to rST. Signed-off-by: Peter Maydell <peter.maydell@linaro.org> Reviewed-by: Richard Henderson <richard.henderson@linaro.org> Reviewed-by: Alex Bennée <alex.bennee@linaro.org> Reviewed-by: Philippe Mathieu-Daudé <philmd@redhat.com> Message-id: 20200124162606.8787-3-peter.maydell@linaro.org
Diffstat (limited to 'docs/sphinx')
0 files changed, 0 insertions, 0 deletions