lkml.org 
[lkml]   [2017]   [May]   [15]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
 
Messages in this thread
Patch in this message
/
From
Subject[PATCH 1/6] Documentation: coding-style: Escape \n\t to fix HTML rendering
Date
Without this patch, Sphinx renders the sentence as follows, thus hiding
the backslashes:

[...] end each string except the last with <cite>nt</cite> to
properly indent the next instruction [...]

Signed-off-by: Jonathan Neuschäfer <j.neuschaefer@gmx.net>
---
Documentation/process/coding-style.rst | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/Documentation/process/coding-style.rst b/Documentation/process/coding-style.rst
index d20d52a4d812..7710c7e0240c 100644
--- a/Documentation/process/coding-style.rst
+++ b/Documentation/process/coding-style.rst
@@ -980,7 +980,7 @@ do so, though, and doing so unnecessarily can limit optimization.

When writing a single inline assembly statement containing multiple
instructions, put each instruction on a separate line in a separate quoted
-string, and end each string except the last with \n\t to properly indent the
+string, and end each string except the last with ``\n\t`` to properly indent the
next instruction in the assembly output:

.. code-block:: c
--
2.11.0
\
 
 \ /
  Last update: 2017-05-15 15:41    [W:0.050 / U:1.532 seconds]
©2003-2020 Jasper Spaans|hosted at Digital Ocean and TransIP|Read the blog|Advertise on this site