]> git.dujemihanovic.xyz Git - u-boot.git/commit
doc: fix three-dash references in reStructuredText
authorGrzegorz Szymaszek <gszymaszek@short.pl>
Sat, 6 Jan 2024 10:36:54 +0000 (11:36 +0100)
committerHeinrich Schuchardt <heinrich.schuchardt@canonical.com>
Sat, 13 Jan 2024 17:17:46 +0000 (18:17 +0100)
commit753f76e417a91c19dd32571bf5398c5526fb21a5
treea222893952ae88eec4d63b51d39462b72b2707cd
parent86efd049344fe160185654548fa9ec1301d78758
doc: fix three-dash references in reStructuredText

The "Sending patches" and "Patman patch manager" documents refer to the
three-dash, "---", that separates patch parts. The symbol is written in
the documentation in the same form as it is in actual patches: as three
U+002D HYPHEN-MINUS characters. When building the documentation, Sphinx
converts this symbol to a U+2014 EM DASH, that is invalid in this case.

Make the three-dash symbol a reStructuredText inline literal to prevent
its conversion; that is, enclose it in a pair of double backquotes (`).

Signed-off-by: Grzegorz Szymaszek <gszymaszek@short.pl>
Reviewed-by: Mattijs Korpershoek <mkorpershoek@baylibre.com>
doc/develop/sending_patches.rst
tools/patman/patman.rst