aboutsummaryrefslogtreecommitdiff
path: root/Documentation/doc-guide
diff options
context:
space:
mode:
authorAndré Almeida2019-06-11 17:03:16 -0300
committerJonathan Corbet2019-06-14 14:43:02 -0600
commit83e8b971f81cebe4f9a84cc76d328ac955b62a7a (patch)
tree38acba95942c1c931f5aabfd6c0e102077555863 /Documentation/doc-guide
parent407b584d155be67a9311a62da8d7874f62b987ac (diff)
sphinx.rst: Add note about code snippets embedded in the text
There's a paragraph that explains how to create fixed width text block, but it doesn't explains how to create fixed width text inline, although this feature is really used through the documentation. Fix that adding a quick note about it. Signed-off-by: André Almeida <andrealmeid@collabora.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Diffstat (limited to 'Documentation/doc-guide')
-rw-r--r--Documentation/doc-guide/sphinx.rst2
1 files changed, 1 insertions, 1 deletions
diff --git a/Documentation/doc-guide/sphinx.rst b/Documentation/doc-guide/sphinx.rst
index 4ba081f43e98..e60a56640c63 100644
--- a/Documentation/doc-guide/sphinx.rst
+++ b/Documentation/doc-guide/sphinx.rst
@@ -217,7 +217,7 @@ Here are some specific guidelines for the kernel documentation:
examples, etc.), use ``::`` for anything that doesn't really benefit
from syntax highlighting, especially short snippets. Use
``.. code-block:: <language>`` for longer code blocks that benefit
- from highlighting.
+ from highlighting. For a short snippet of code embedded in the text, use \`\`.
the C domain