3 # Copyright © 2016 Intel Corporation
5 # Permission is hereby granted, free of charge, to any person obtaining a
6 # copy of this software and associated documentation files (the "Software"),
7 # to deal in the Software without restriction, including without limitation
8 # the rights to use, copy, modify, merge, publish, distribute, sublicense,
9 # and/or sell copies of the Software, and to permit persons to whom the
10 # Software is furnished to do so, subject to the following conditions:
12 # The above copyright notice and this permission notice (including the next
13 # paragraph) shall be included in all copies or substantial portions of the
16 # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17 # IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 # FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
19 # THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20 # LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
21 # FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
25 # Jani Nikula <jani.nikula@intel.com>
27 # Please make sure this works on both python2 and python3.
37 from docutils import nodes, statemachine
38 from docutils.statemachine import ViewList
39 from docutils.parsers.rst import directives, Directive
42 # AutodocReporter is only good up to Sphinx 1.7
46 Use_SSI = sphinx.__version__[:3] >= '1.7'
48 from sphinx.util.docutils import switch_source_input
50 from sphinx.ext.autodoc import AutodocReporter
56 class KernelDocDirective(Directive):
57 """Extract kernel-doc comments from the specified file"""
59 optional_arguments = 4
61 'doc': directives.unchanged_required,
62 'functions': directives.unchanged_required,
63 'export': directives.unchanged,
64 'internal': directives.unchanged,
69 env = self.state.document.settings.env
70 cmd = [env.config.kerneldoc_bin, '-rst', '-enable-lineno']
72 filename = env.config.kerneldoc_srctree + '/' + self.arguments[0]
73 export_file_patterns = []
75 # Tell sphinx of the dependency
76 env.note_dependency(os.path.abspath(filename))
78 tab_width = self.options.get('tab-width', self.state.document.settings.tab_width)
80 # FIXME: make this nicer and more robust against errors
81 if 'export' in self.options:
83 export_file_patterns = str(self.options.get('export')).split()
84 elif 'internal' in self.options:
86 export_file_patterns = str(self.options.get('internal')).split()
87 elif 'doc' in self.options:
88 cmd += ['-function', str(self.options.get('doc'))]
89 elif 'functions' in self.options:
90 for f in str(self.options.get('functions')).split():
91 cmd += ['-function', f]
93 for pattern in export_file_patterns:
94 for f in glob.glob(env.config.kerneldoc_srctree + '/' + pattern):
95 env.note_dependency(os.path.abspath(f))
96 cmd += ['-export-file', f]
101 kernellog.verbose(env.app,
102 'calling kernel-doc \'%s\'' % (" ".join(cmd)))
104 p = subprocess.Popen(cmd, stdout=subprocess.PIPE, stderr=subprocess.PIPE)
105 out, err = p.communicate()
107 out, err = codecs.decode(out, 'utf-8'), codecs.decode(err, 'utf-8')
109 if p.returncode != 0:
110 sys.stderr.write(err)
112 kernellog.warn(env.app,
113 'kernel-doc \'%s\' failed with return code %d' % (" ".join(cmd), p.returncode))
114 return [nodes.error(None, nodes.paragraph(text = "kernel-doc missing"))]
115 elif env.config.kerneldoc_verbosity > 0:
116 sys.stderr.write(err)
118 lines = statemachine.string2lines(out, tab_width, convert_whitespace=True)
122 line_regex = re.compile("^#define LINENO ([0-9]+)$")
124 match = line_regex.search(line)
126 # sphinx counts lines from 0
127 lineoffset = int(match.group(1)) - 1
128 # we must eat our comments since the upset the markup
130 result.append(line, filename, lineoffset)
133 node = nodes.section()
134 self.do_parse(result, node)
138 except Exception as e: # pylint: disable=W0703
139 kernellog.warn(env.app, 'kernel-doc \'%s\' processing failed with: %s' %
140 (" ".join(cmd), str(e)))
141 return [nodes.error(None, nodes.paragraph(text = "kernel-doc missing"))]
143 def do_parse(self, result, node):
145 with switch_source_input(self.state, result):
146 self.state.nested_parse(result, 0, node, match_titles=1)
148 save = self.state.memo.title_styles, self.state.memo.section_level, self.state.memo.reporter
149 self.state.memo.reporter = AutodocReporter(result, self.state.memo.reporter)
150 self.state.memo.title_styles, self.state.memo.section_level = [], 0
152 self.state.nested_parse(result, 0, node, match_titles=1)
154 self.state.memo.title_styles, self.state.memo.section_level, self.state.memo.reporter = save
158 app.add_config_value('kerneldoc_bin', None, 'env')
159 app.add_config_value('kerneldoc_srctree', None, 'env')
160 app.add_config_value('kerneldoc_verbosity', 1, 'env')
162 app.add_directive('kernel-doc', KernelDocDirective)
165 version = __version__,
166 parallel_read_safe = True,
167 parallel_write_safe = True