[ovs-dev] [PATCH] docs: Fix formatting of patch comments line.

Joe Stringer joe at ovn.org
Wed Jan 4 21:58:00 UTC 2017


Sphinx was formatting the `---` as an extended dash, not verbatim as
three hyphens (which is what is necessary for git to determine that it's
a comment, and ignore it when applying the patch).

Signed-off-by: Joe Stringer <joe at ovn.org>
---
 Documentation/internals/contributing/submitting-patches.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/Documentation/internals/contributing/submitting-patches.rst b/Documentation/internals/contributing/submitting-patches.rst
index 36e3b17958fd..edbc1aa8d9ff 100644
--- a/Documentation/internals/contributing/submitting-patches.rst
+++ b/Documentation/internals/contributing/submitting-patches.rst
@@ -384,7 +384,7 @@ Comments
 
 If you want to include any comments in your email that should not be part of
 the commit's change log message, put them after the description, separated by a
-line that contains just `---`.  It may be helpful to include a diffstat here
+line that contains just ``---``.  It may be helpful to include a diffstat here
 for changes that touch multiple files.
 
 Patch
-- 
2.10.2



More information about the dev mailing list