docs/sphinx/kerneldoc.py

1 # coding=utf-8
51     """Extract kernel-doc comments from the specified file"""
64         cmd = env.config.kerneldoc_bin + ['-rst', '-enable-lineno']
66         # Pass the version string to kernel-doc, as it needs to use a different
69         cmd += ['-sphinx-version', sphinx.__version__]
71         # Pass through the warnings-as-errors flag
73             cmd += ['-Werror']
81         tab_width = self.options.get('tab-width', self.state.document.settings.tab_width)
85             cmd += ['-export']
88             cmd += ['-internal']
91             cmd += ['-function', str(self.options.get('doc'))]
96                     cmd += ['-function', f]
98                 cmd += ['-no-doc-sections']
103                 cmd += ['-export-file', f]
108             logger.verbose('calling kernel-doc \'%s\'' % (" ".join(cmd)))
113             out, err = codecs.decode(out, 'utf-8'), codecs.decode(err, 'utf-8')
119                     'kernel-doc \'%s\' failed with return code %d' %
122                 return [nodes.error(None, nodes.paragraph(text = "kernel-doc missing"))]
130             line_regex = re.compile("^#define LINENO ([0-9]+)$")
135                     lineoffset = int(match.group(1)) - 1
147             logger.warning('kernel-doc \'%s\' processing failed with: %s' %
149             return [nodes.error(None, nodes.paragraph(text = "kernel-doc missing"))]
162     app.add_directive('kernel-doc', KernelDocDirective)