diff options
author | Jonathan Corbet <corbet@lwn.net> | 2016-07-17 21:24:02 -0400 |
---|---|---|
committer | Jonathan Corbet <corbet@lwn.net> | 2016-07-17 21:24:02 -0400 |
commit | fd7db68b9363a80d3c6f3b55e05ec56211ea6254 (patch) | |
tree | f800dea31f534f3e004b79a02dad29d43bb006d2 | |
parent | 547218864afb2745d9d137f005f3380ef96b26ab (diff) |
docs: Get rid of some kernel-documentation warnings
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>
-rw-r--r-- | Documentation/kernel-documentation.rst | 6 |
1 files changed, 6 insertions, 0 deletions
diff --git a/Documentation/kernel-documentation.rst b/Documentation/kernel-documentation.rst index 391decc66a18..c4eb5049da39 100644 --- a/Documentation/kernel-documentation.rst +++ b/Documentation/kernel-documentation.rst | |||
@@ -366,6 +366,8 @@ Domain`_ references. | |||
366 | Cross-referencing from reStructuredText | 366 | Cross-referencing from reStructuredText |
367 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | 367 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
368 | 368 | ||
369 | .. highlight:: none | ||
370 | |||
369 | To cross-reference the functions and types defined in the kernel-doc comments | 371 | To cross-reference the functions and types defined in the kernel-doc comments |
370 | from reStructuredText documents, please use the `Sphinx C Domain`_ | 372 | from reStructuredText documents, please use the `Sphinx C Domain`_ |
371 | references. For example:: | 373 | references. For example:: |
@@ -388,6 +390,8 @@ For further details, please refer to the `Sphinx C Domain`_ documentation. | |||
388 | Function documentation | 390 | Function documentation |
389 | ---------------------- | 391 | ---------------------- |
390 | 392 | ||
393 | .. highlight:: c | ||
394 | |||
391 | The general format of a function and function-like macro kernel-doc comment is:: | 395 | The general format of a function and function-like macro kernel-doc comment is:: |
392 | 396 | ||
393 | /** | 397 | /** |
@@ -568,6 +572,8 @@ DocBook XML [DEPRECATED] | |||
568 | Converting DocBook to Sphinx | 572 | Converting DocBook to Sphinx |
569 | ---------------------------- | 573 | ---------------------------- |
570 | 574 | ||
575 | .. highlight:: none | ||
576 | |||
571 | Over time, we expect all of the documents under ``Documentation/DocBook`` to be | 577 | Over time, we expect all of the documents under ``Documentation/DocBook`` to be |
572 | converted to Sphinx and reStructuredText. For most DocBook XML documents, a good | 578 | converted to Sphinx and reStructuredText. For most DocBook XML documents, a good |
573 | enough solution is to use the simple ``Documentation/sphinx/tmplcvt`` script, | 579 | enough solution is to use the simple ``Documentation/sphinx/tmplcvt`` script, |