]> git.kernelconcepts.de Git - karo-tx-linux.git/commitdiff
docs: Get rid of some kernel-documentation warnings
authorJonathan Corbet <corbet@lwn.net>
Mon, 18 Jul 2016 01:24:02 +0000 (19:24 -0600)
committerJonathan Corbet <corbet@lwn.net>
Mon, 18 Jul 2016 01:24:02 +0000 (19:24 -0600)
Sphinx wants to interpret all literal blocks as being in the chosen
language and complains when an attempt to parse a block fails.
kernel-documentation.rst has a few blocks that are not in C; make that
explicit to shut down the associated warnings.

Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Documentation/kernel-documentation.rst

index 391decc66a18fd3da282cc009d6f239441de4a8d..c4eb5049da390767753032acfc583ac282bd0f0b 100644 (file)
@@ -366,6 +366,8 @@ Domain`_ references.
 Cross-referencing from reStructuredText
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
+.. highlight:: none
+
 To cross-reference the functions and types defined in the kernel-doc comments
 from reStructuredText documents, please use the `Sphinx C Domain`_
 references. For example::
@@ -388,6 +390,8 @@ For further details, please refer to the `Sphinx C Domain`_ documentation.
 Function documentation
 ----------------------
 
+.. highlight:: c
+
 The general format of a function and function-like macro kernel-doc comment is::
 
   /**
@@ -568,6 +572,8 @@ DocBook XML [DEPRECATED]
 Converting DocBook to Sphinx
 ----------------------------
 
+.. highlight:: none
+
 Over time, we expect all of the documents under ``Documentation/DocBook`` to be
 converted to Sphinx and reStructuredText. For most DocBook XML documents, a good
 enough solution is to use the simple ``Documentation/sphinx/tmplcvt`` script,