Skip to content

Commit

Permalink
kallsyms: remove docstring of _module_kallsyms()
Browse files Browse the repository at this point in the history
This is intended to be a private function. It doesn't appear in __all__,
but the docstring still results in it being included in the Sphinx docs.
Remove the docstring and verify that the function no longer appears in
Sphinx.

Signed-off-by: Stephen Brennan <[email protected]>
  • Loading branch information
brenns10 authored and osandov committed Oct 14, 2024
1 parent b380087 commit a43ae0b
Showing 1 changed file with 0 additions and 12 deletions.
12 changes: 0 additions & 12 deletions drgn/helpers/linux/kallsyms.py
Original file line number Diff line number Diff line change
Expand Up @@ -159,18 +159,6 @@ def _elf_sym_to_symbol(name: str, obj: Object, has_typetab: bool) -> Symbol:


def _module_kallsyms(module: Object) -> List[Symbol]:
"""
Return a list of symbols for a kernel module
When compiled with ``CONFIG_KALLSYMS``, the kernel maintains ELF symbol
information about each module within ``struct module``. This function
accesses this symbol information, and returns a list of drgn :class:`Symbol`
objects for the module. Keep in mind that unless ``CONFIG_KALLSYMS_ALL`` is
enabled, these symbols are typically only function symbols.
:param module: :class:`Object` of type ``struct module *``
:returns: a list of symbols
"""
try:
ks = module.kallsyms
except AttributeError:
Expand Down

0 comments on commit a43ae0b

Please sign in to comment.