From 753f76e417a91c19dd32571bf5398c5526fb21a5 Mon Sep 17 00:00:00 2001 From: Grzegorz Szymaszek Date: Sat, 6 Jan 2024 11:36:54 +0100 Subject: 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 Reviewed-by: Mattijs Korpershoek --- tools/patman/patman.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'tools') diff --git a/tools/patman/patman.rst b/tools/patman/patman.rst index a8b317eed63..e01355824c5 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 -- cgit v1.2.3