diff options
| author | Grzegorz Szymaszek | 2024-01-06 11:36:54 +0100 |
|---|---|---|
| committer | Heinrich Schuchardt | 2024-01-13 18:17:46 +0100 |
| commit | 753f76e417a91c19dd32571bf5398c5526fb21a5 (patch) | |
| tree | a222893952ae88eec4d63b51d39462b72b2707cd /doc | |
| 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 'doc')
| -rw-r--r-- | doc/develop/sending_patches.rst | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/doc/develop/sending_patches.rst b/doc/develop/sending_patches.rst index 5a6962f1021..3f25b1d0466 100644 --- a/doc/develop/sending_patches.rst +++ b/doc/develop/sending_patches.rst @@ -121,7 +121,7 @@ General Patch Submission Rules * For new features: a description of the feature and your implementation. * Additional comments which you don't want included in U-Boot's history can be - included below the first "---" in the message body. + included below the first "``---``" in the message body. * If your description gets too long, that's a strong indication that you should split up your patch. @@ -253,7 +253,7 @@ to observe the following rules. * Please make sure to keep a "change log", i.e. a description of what you have changed compared to previous versions of this patch. This change log should - be added below the "---" line in the patch, which starts the "comment + be added below the "``---``" line in the patch, which starts the "comment section", i.e. which contains text that does not get included into the actual commit message. Note: it is *not* sufficient to provide a change log in some cover letter |