| Message ID | 20230411105424.3994585-1-peter.maydell@linaro.org |
|---|---|
| State | Superseded |
| Headers | show |
| Series | docs/devel/kconfig.rst: Fix incorrect markup | expand |
Peter Maydell <peter.maydell@linaro.org> writes: > In rST markup syntax, the inline markup (*italics*, **bold** and > ``monospaced``) must be separated from the surrending text by > non-word characters, otherwise it is not interpreted as markup. > To force interpretation as markup in the middle of a word, > you need to use a backslash-escaped space (which will not > appear as a space in the output). > > Fix a missing backslash-space in this file, which meant that the `` > after "select" was output literally and the monospacing was > incorrectly extended all the way to the end of the next monospaced > word. > > Signed-off-by: Peter Maydell <peter.maydell@linaro.org> Reviewed-by: Alex Bennée <alex.bennee@linaro.org>
On 11/4/23 12:54, Peter Maydell wrote: > In rST markup syntax, the inline markup (*italics*, **bold** and > ``monospaced``) must be separated from the surrending text by > non-word characters, otherwise it is not interpreted as markup. > To force interpretation as markup in the middle of a word, > you need to use a backslash-escaped space (which will not > appear as a space in the output). > > Fix a missing backslash-space in this file, which meant that the `` > after "select" was output literally and the monospacing was > incorrectly extended all the way to the end of the next monospaced > word. Apparently the single case (git-grep -E '``[^ ]+``[a-z]', other are separated with '/'). Reviewed-by: Philippe Mathieu-Daudé <philmd@linaro.org> > Signed-off-by: Peter Maydell <peter.maydell@linaro.org> > --- > docs/devel/kconfig.rst | 2 +- > 1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/docs/devel/kconfig.rst b/docs/devel/kconfig.rst index cc1a456edf0..ac9453eba90 100644 --- a/docs/devel/kconfig.rst +++ b/docs/devel/kconfig.rst @@ -274,7 +274,7 @@ or commenting out lines in the second group. It is also possible to run QEMU's configure script with the ``--without-default-devices`` option. When this is done, everything defaults -to ``n`` unless it is ``select``ed or explicitly switched on in the +to ``n`` unless it is ``select``\ ed or explicitly switched on in the ``.mak`` files. In other words, ``default`` and ``imply`` directives are disabled. When QEMU is built with this option, the user will probably want to change some lines in the first group, for example like this::
In rST markup syntax, the inline markup (*italics*, **bold** and ``monospaced``) must be separated from the surrending text by non-word characters, otherwise it is not interpreted as markup. To force interpretation as markup in the middle of a word, you need to use a backslash-escaped space (which will not appear as a space in the output). Fix a missing backslash-space in this file, which meant that the `` after "select" was output literally and the monospacing was incorrectly extended all the way to the end of the next monospaced word. Signed-off-by: Peter Maydell <peter.maydell@linaro.org> --- docs/devel/kconfig.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)