Skip to content
  • Peter Maydell's avatar
    docs: Format literals correctly · 6df743dc
    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).
    
    This commit fixes various places in the manual which were
    using single backticks when double backticks (for literal text)
    were intended, and covers those files where only one or two
    instances of these errors were made.
    
    Signed-off-by: default avatarPeter Maydell <peter.maydell@linaro.org>
    Reviewed-by: default avatarRichard Henderson <richard.henderson@linaro.org>
    6df743dc