Message ID | 20170104215800.21339-1-joe@ovn.org |
---|---|
State | Accepted |
Headers | show |
On Wed, Jan 04, 2017 at 01:58:00PM -0800, Joe Stringer wrote: > 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@ovn.org> Acked-by: Ben Pfaff <blp@ovn.org>
On Wed, 2017-01-04 at 13:58 -0800, Joe Stringer wrote: > 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@ovn.org> Aye, good catch. Acked-by: Stephen Finucane <stephen@that.guru>
On 5 January 2017 at 01:28, Stephen Finucane <stephen@that.guru> wrote: > On Wed, 2017-01-04 at 13:58 -0800, Joe Stringer wrote: >> 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@ovn.org> > > Aye, good catch. > > Acked-by: Stephen Finucane <stephen@that.guru> Thanks, applied to master.
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
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@ovn.org> --- Documentation/internals/contributing/submitting-patches.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)