diff options
| author | Markus Heiser <markus.heiser@darmarIT.de> | 2016-07-20 06:38:58 -0400 |
|---|---|---|
| committer | Jonathan Corbet <corbet@lwn.net> | 2016-07-20 18:51:12 -0400 |
| commit | f42ddca7bebcc069f470143434c119c96cd15bb5 (patch) | |
| tree | 0e99d50637784486b235c4750cc1081f6784e86f | |
| parent | 8ed292fe864e9ed7d335515e97590122a56d7cba (diff) | |
doc-rst: kernel-doc directive, fix state machine reporter
Add a reporter replacement that assigns the correct source name and line
number to a system message, as recorded in a ViewList.
[1] http://mid.gmane.org/CAKMK7uFMQ2wOp99t-8v06Om78mi9OvRZWuQsFJD55QA20BB3iw@mail.gmail.com
Signed-off-by: Markus Heiser <markus.heiser@darmarIT.de>
Tested-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| -rw-r--r-- | Documentation/sphinx/kernel-doc.py | 12 |
1 files changed, 9 insertions, 3 deletions
diff --git a/Documentation/sphinx/kernel-doc.py b/Documentation/sphinx/kernel-doc.py index dedb24e3bb7a..f6920c0af6ee 100644 --- a/Documentation/sphinx/kernel-doc.py +++ b/Documentation/sphinx/kernel-doc.py | |||
| @@ -37,6 +37,7 @@ from docutils import nodes, statemachine | |||
| 37 | from docutils.statemachine import ViewList | 37 | from docutils.statemachine import ViewList |
| 38 | from docutils.parsers.rst import directives | 38 | from docutils.parsers.rst import directives |
| 39 | from sphinx.util.compat import Directive | 39 | from sphinx.util.compat import Directive |
| 40 | from sphinx.ext.autodoc import AutodocReporter | ||
| 40 | 41 | ||
| 41 | class KernelDocDirective(Directive): | 42 | class KernelDocDirective(Directive): |
| 42 | """Extract kernel-doc comments from the specified file""" | 43 | """Extract kernel-doc comments from the specified file""" |
| @@ -117,12 +118,17 @@ class KernelDocDirective(Directive): | |||
| 117 | lineoffset += 1 | 118 | lineoffset += 1 |
| 118 | 119 | ||
| 119 | node = nodes.section() | 120 | node = nodes.section() |
| 120 | node.document = self.state.document | 121 | buf = self.state.memo.title_styles, self.state.memo.section_level, self.state.memo.reporter |
| 121 | self.state.nested_parse(result, self.content_offset, node) | 122 | self.state.memo.reporter = AutodocReporter(result, self.state.memo.reporter) |
| 123 | self.state.memo.title_styles, self.state.memo.section_level = [], 0 | ||
| 124 | try: | ||
| 125 | self.state.nested_parse(result, 0, node, match_titles=1) | ||
| 126 | finally: | ||
| 127 | self.state.memo.title_styles, self.state.memo.section_level, self.state.memo.reporter = buf | ||
| 122 | 128 | ||
| 123 | return node.children | 129 | return node.children |
| 124 | 130 | ||
| 125 | except Exception as e: | 131 | except Exception as e: # pylint: disable=W0703 |
| 126 | env.app.warn('kernel-doc \'%s\' processing failed with: %s' % | 132 | env.app.warn('kernel-doc \'%s\' processing failed with: %s' % |
| 127 | (" ".join(cmd), str(e))) | 133 | (" ".join(cmd), str(e))) |
| 128 | return [nodes.error(None, nodes.paragraph(text = "kernel-doc missing"))] | 134 | return [nodes.error(None, nodes.paragraph(text = "kernel-doc missing"))] |
