Skip to content

Commit f42ddca

Browse files
return42Jonathan Corbet
authored andcommitted
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 <[email protected]> Tested-by: Mauro Carvalho Chehab <[email protected]> Signed-off-by: Jonathan Corbet <[email protected]>
1 parent 8ed292f commit f42ddca

File tree

1 file changed

+9
-3
lines changed

1 file changed

+9
-3
lines changed

Documentation/sphinx/kernel-doc.py

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,7 @@
3737
from docutils.statemachine import ViewList
3838
from docutils.parsers.rst import directives
3939
from sphinx.util.compat import Directive
40+
from sphinx.ext.autodoc import AutodocReporter
4041

4142
class KernelDocDirective(Directive):
4243
"""Extract kernel-doc comments from the specified file"""
@@ -117,12 +118,17 @@ def run(self):
117118
lineoffset += 1
118119

119120
node = nodes.section()
120-
node.document = self.state.document
121-
self.state.nested_parse(result, self.content_offset, node)
121+
buf = self.state.memo.title_styles, self.state.memo.section_level, self.state.memo.reporter
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
122128

123129
return node.children
124130

125-
except Exception as e:
131+
except Exception as e: # pylint: disable=W0703
126132
env.app.warn('kernel-doc \'%s\' processing failed with: %s' %
127133
(" ".join(cmd), str(e)))
128134
return [nodes.error(None, nodes.paragraph(text = "kernel-doc missing"))]

0 commit comments

Comments
 (0)