diff options
| author | Peter Maydell <peter.maydell@linaro.org> | 2021-07-26 15:23:31 +0100 |
|---|---|---|
| committer | Peter Maydell <peter.maydell@linaro.org> | 2021-08-02 11:42:38 +0100 |
| commit | f0d7b970ac69bdf72fcf40a729c9e8605f4d1bc0 (patch) | |
| tree | eae0b6c3506707ed3374bbc79721e88dd043b910 /docs/devel/secure-coding-practices.rst | |
| parent | d463f3c79ade6f678bded5f150341206750a37b7 (diff) | |
| download | focaccia-qemu-f0d7b970ac69bdf72fcf40a729c9e8605f4d1bc0.tar.gz focaccia-qemu-f0d7b970ac69bdf72fcf40a729c9e8605f4d1bc0.zip | |
docs/devel/ebpf_rss.rst: Format literals correctly
In rST markup, single backticks `like this` represent "interpreted text", which can be handled as a bunch of different things if tagged with a specific "role": https://docutils.sourceforge.io/docs/ref/rst/restructuredtext.html#interpreted-text (the most common one for us is "reference to a URL, which gets hyperlinked"). The default "role" if none is specified is "title_reference", intended for references to book or article titles, and it renders into the HTML as <cite>...</cite> (usually comes out as italics). To format a literal (generally rendered as fixed-width font), double-backticks are required. ebpf_rss.rst gets this wrong in a few places; correct them. Signed-off-by: Peter Maydell <peter.maydell@linaro.org> Reviewed-by: Richard Henderson <richard.henderson@linaro.org> Reviewed-by: Philippe Mathieu-Daudé <philmd@redhat.com> Message-id: 20210726142338.31872-4-peter.maydell@linaro.org
Diffstat (limited to 'docs/devel/secure-coding-practices.rst')
0 files changed, 0 insertions, 0 deletions