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
40 from sphinx.ext.autodoc import AutodocReporter
44 class KernelDocDirective(Directive):
45 """Extract kernel-doc comments from the specified file"""
47 optional_arguments = 4
49 'doc': directives.unchanged_required,
50 'functions': directives.unchanged_required,
51 'export': directives.unchanged,
52 'internal': directives.unchanged,
57 env = self.state.document.settings.env
58 cmd = [env.config.kerneldoc_bin, '-rst', '-enable-lineno']
60 filename = env.config.kerneldoc_srctree + '/' + self.arguments[0]
61 export_file_patterns = []
63 # Tell sphinx of the dependency
64 env.note_dependency(os.path.abspath(filename))
66 tab_width = self.options.get('tab-width', self.state.document.settings.tab_width)
68 # FIXME: make this nicer and more robust against errors
69 if 'export' in self.options:
71 export_file_patterns = str(self.options.get('export')).split()
72 elif 'internal' in self.options:
74 export_file_patterns = str(self.options.get('internal')).split()
75 elif 'doc' in self.options:
76 cmd += ['-function', str(self.options.get('doc'))]
77 elif 'functions' in self.options:
78 for f in str(self.options.get('functions')).split():
79 cmd += ['-function', f]
81 for pattern in export_file_patterns:
82 for f in glob.glob(env.config.kerneldoc_srctree + '/' + pattern):
83 env.note_dependency(os.path.abspath(f))
84 cmd += ['-export-file', f]
89 env.app.verbose('calling kernel-doc \'%s\'' % (" ".join(cmd)))
91 p = subprocess.Popen(cmd, stdout=subprocess.PIPE, stderr=subprocess.PIPE)
92 out, err = p.communicate()
94 out, err = codecs.decode(out, 'utf-8'), codecs.decode(err, 'utf-8')
99 env.app.warn('kernel-doc \'%s\' failed with return code %d' % (" ".join(cmd), p.returncode))
100 return [nodes.error(None, nodes.paragraph(text = "kernel-doc missing"))]
101 elif env.config.kerneldoc_verbosity > 0:
102 sys.stderr.write(err)
104 lines = statemachine.string2lines(out, tab_width, convert_whitespace=True)
108 line_regex = re.compile("^#define LINENO ([0-9]+)$")
110 match = line_regex.search(line)
112 # sphinx counts lines from 0
113 lineoffset = int(match.group(1)) - 1
114 # we must eat our comments since the upset the markup
116 result.append(line, filename, lineoffset)
119 node = nodes.section()
120 buf = self.state.memo.title_styles, self.state.memo.section_level, self.state.memo.reporter
121 self.state.memo.reporter = AutodocReporter(result, self.state.memo.reporter)
122 self.state.memo.title_styles, self.state.memo.section_level = [], 0
124 self.state.nested_parse(result, 0, node, match_titles=1)
126 self.state.memo.title_styles, self.state.memo.section_level, self.state.memo.reporter = buf
130 except Exception as e: # pylint: disable=W0703
131 env.app.warn('kernel-doc \'%s\' processing failed with: %s' %
132 (" ".join(cmd), str(e)))
133 return [nodes.error(None, nodes.paragraph(text = "kernel-doc missing"))]
136 app.add_config_value('kerneldoc_bin', None, 'env')
137 app.add_config_value('kerneldoc_srctree', None, 'env')
138 app.add_config_value('kerneldoc_verbosity', 1, 'env')
140 app.add_directive('kernel-doc', KernelDocDirective)
143 version = __version__,
144 parallel_read_safe = True,
145 parallel_write_safe = True