| Message ID | 20200213175647.17628-21-peter.maydell@linaro.org |
|---|---|
| State | Superseded |
| Headers | show |
| Series | Convert QAPI doc comments to generate rST instead of texinfo | expand |
On 2/13/20 6:56 PM, Peter Maydell wrote: > For rST, '*' is a kind of inline markup (for emphasis), so > "*-softmmu" is a syntax error because of the missing closing '*'. > Escape the '*' with a '\'. > > The texinfo document generator will leave the '\' in the > output, which is not ideal, but that generator is going to > go away in a subsequent commit. > > Signed-off-by: Peter Maydell <peter.maydell@linaro.org> > --- > qapi/machine.json | 2 +- > 1 file changed, 1 insertion(+), 1 deletion(-) > > diff --git a/qapi/machine.json b/qapi/machine.json > index 6c11e3cf3a4..58580602524 100644 > --- a/qapi/machine.json > +++ b/qapi/machine.json > @@ -12,7 +12,7 @@ > # > # The comprehensive enumeration of QEMU system emulation ("softmmu") > # targets. Run "./configure --help" in the project root directory, and > -# look for the *-softmmu targets near the "--target-list" option. The > +# look for the \*-softmmu targets near the "--target-list" option. The > # individual target constants are not documented here, for the time > # being. > # > Reviewed-by: Philippe Mathieu-Daudé <philmd@redhat.com>
diff --git a/qapi/machine.json b/qapi/machine.json index 6c11e3cf3a4..58580602524 100644 --- a/qapi/machine.json +++ b/qapi/machine.json @@ -12,7 +12,7 @@ # # The comprehensive enumeration of QEMU system emulation ("softmmu") # targets. Run "./configure --help" in the project root directory, and -# look for the *-softmmu targets near the "--target-list" option. The +# look for the \*-softmmu targets near the "--target-list" option. The # individual target constants are not documented here, for the time # being. #
For rST, '*' is a kind of inline markup (for emphasis), so "*-softmmu" is a syntax error because of the missing closing '*'. Escape the '*' with a '\'. The texinfo document generator will leave the '\' in the output, which is not ideal, but that generator is going to go away in a subsequent commit. Signed-off-by: Peter Maydell <peter.maydell@linaro.org> --- qapi/machine.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) -- 2.20.1