diff options
| author |   Jonathan Corbet <corbet@lwn.net> | 2016-07-17 19:24:02 -0600 |
|---|---|---|
| committer | Jonathan Corbet <corbet@lwn.net> | 2016-07-17 19:24:02 -0600 |
| commit | fd7db68b9363a80d3c6f3b55e05ec56211ea6254 (patch) | |
| tree | f800dea31f534f3e004b79a02dad29d43bb006d2 /Documentation/kernel-documentation.rst | |
| parent | doc-rst: add an option to ignore DocBooks when generating docs (diff) | |
| download | linux-dev-fd7db68b9363a80d3c6f3b55e05ec56211ea6254.tar.xz linux-dev-fd7db68b9363a80d3c6f3b55e05ec56211ea6254.zip | |
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>
Diffstat (limited to 'Documentation/kernel-documentation.rst')
| -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. 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, |