]> Git Repo - qemu.git/commit
docs/devel/ebpf_rss.rst: Format literals correctly
authorPeter Maydell <[email protected]>
Mon, 26 Jul 2021 14:23:31 +0000 (15:23 +0100)
committerPeter Maydell <[email protected]>
Mon, 2 Aug 2021 10:42:38 +0000 (11:42 +0100)
commitf0d7b970ac69bdf72fcf40a729c9e8605f4d1bc0
treeeae0b6c3506707ed3374bbc79721e88dd043b910
parentd463f3c79ade6f678bded5f150341206750a37b7
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 <[email protected]>
Reviewed-by: Richard Henderson <[email protected]>
Reviewed-by: Philippe Mathieu-Daudé <[email protected]>
Message-id: 20210726142338[email protected]
docs/devel/ebpf_rss.rst
This page took 0.024648 seconds and 4 git commands to generate.