Skip to content
  • Peter Maydell's avatar
    docs/devel/ebpf_rss.rst: Format literals correctly · f0d7b970
    Peter Maydell authored
    
    
    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: default avatarPeter Maydell <peter.maydell@linaro.org>
    Reviewed-by: default avatarRichard Henderson <richard.henderson@linaro.org>
    Reviewed-by: Philippe Mathieu-Daudé's avatarPhilippe Mathieu-Daudé <philmd@redhat.com>
    Message-id: 20210726142338.31872-4-peter.maydell@linaro.org
    f0d7b970