diff options
| author | Grzegorz Szymaszek <gszymaszek@short.pl> | 2024-01-06 11:36:54 +0100 |
|---|---|---|
| committer | Heinrich Schuchardt <heinrich.schuchardt@canonical.com> | 2024-01-13 18:17:46 +0100 |
| commit | 753f76e417a91c19dd32571bf5398c5526fb21a5 (patch) | |
| tree | a222893952ae88eec4d63b51d39462b72b2707cd /tools | |
| parent | 86efd049344fe160185654548fa9ec1301d78758 (diff) | |
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>
Diffstat (limited to 'tools')
| -rw-r--r-- | tools/patman/patman.rst | 2 |
1 files changed, 1 insertions, 1 deletions
diff --git a/tools/patman/patman.rst b/tools/patman/patman.rst index a8b317eed6..e01355824c 100644 --- a/tools/patman/patman.rst +++ b/tools/patman/patman.rst @@ -280,7 +280,7 @@ Series-notes: Commit-notes: Similar, but for a single commit (patch). These notes will appear - immediately below the --- cut in the patch file:: + immediately below the ``---`` cut in the patch file:: Commit-notes: blah blah |