Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel
os
linux
docs: kerneldoc.py: add support for kerneldoc -nosymbol
Currently, there's no way to exclude identifiers from
a kernel-doc markup. Add support for it.
Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
+15
+8
Documentation/doc-guide/kernel-doc.rst
+8
Documentation/doc-guide/kernel-doc.rst
···
490
490
.. kernel-doc:: lib/idr.c
491
491
:identifiers:
492
492
493
+
no-identifiers: *[ function/type ...]*
494
+
Exclude documentation for each *function* and *type* in *source*.
495
+
496
+
Example::
497
+
498
+
.. kernel-doc:: lib/bitmap.c
499
+
:no-identifiers: bitmap_parselist
500
+
493
501
functions: *[ function/type ...]*
494
502
This is an alias of the 'identifiers' directive and deprecated.
495
503
+7
Documentation/sphinx/kerneldoc.py
+7
Documentation/sphinx/kerneldoc.py
···
62
62
'export': directives.unchanged,
63
63
'internal': directives.unchanged,
64
64
'identifiers': directives.unchanged,
65
+
'no-identifiers': directives.unchanged,
65
66
'functions': directives.unchanged,
66
67
}
67
68
has_content = False
···
104
103
cmd += ['-function', i]
105
104
else:
106
105
cmd += ['-no-doc-sections']
106
+
107
+
if 'no-identifiers' in self.options:
108
+
no_identifiers = self.options.get('no-identifiers').split()
109
+
if no_identifiers:
110
+
for i in no_identifiers:
111
+
cmd += ['-nosymbol', i]
107
112
108
113
for pattern in export_file_patterns:
109
114
for f in glob.glob(env.config.kerneldoc_srctree + '/' + pattern):