From a43ae0b57c569cc1d23f9d077c1c300acb5a0261 Mon Sep 17 00:00:00 2001 From: Stephen Brennan Date: Mon, 14 Oct 2024 09:04:03 -0700 Subject: [PATCH] kallsyms: remove docstring of _module_kallsyms() 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 --- drgn/helpers/linux/kallsyms.py | 12 ------------ 1 file changed, 12 deletions(-) diff --git a/drgn/helpers/linux/kallsyms.py b/drgn/helpers/linux/kallsyms.py index 448cbe239..66df44f2b 100644 --- a/drgn/helpers/linux/kallsyms.py +++ b/drgn/helpers/linux/kallsyms.py @@ -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: