From: Emil Velikov Date: Mon, 2 Sep 2024 22:20:19 +0000 (+0100) Subject: libkmod/docs: document and reference kmod_symbol_bind X-Git-Tag: v34~430 X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=d20b1976710045f1334e26939ea3b7cc8bf6b2fb;p=thirdparty%2Fkmod.git libkmod/docs: document and reference kmod_symbol_bind Signed-off-by: Emil Velikov Link: https://github.com/kmod-project/kmod/pull/94 Signed-off-by: Lucas De Marchi --- diff --git a/libkmod/docs/libkmod-sections.txt b/libkmod/docs/libkmod-sections.txt index 7debc8c9..dd502647 100644 --- a/libkmod/docs/libkmod-sections.txt +++ b/libkmod/docs/libkmod-sections.txt @@ -79,6 +79,7 @@ kmod_module_get_options kmod_module_get_path kmod_module_get_dependency_symbols +kmod_symbol_bind kmod_module_dependency_symbol_get_bind kmod_module_dependency_symbol_get_crc kmod_module_dependency_symbol_get_symbol diff --git a/libkmod/libkmod.h b/libkmod/libkmod.h index e21aabcf..66122065 100644 --- a/libkmod/libkmod.h +++ b/libkmod/libkmod.h @@ -968,14 +968,32 @@ const char *kmod_module_get_path(const struct kmod_module *mod); */ int kmod_module_get_dependency_symbols(const struct kmod_module *mod, struct kmod_list **list); +/** + * kmod_symbol_bind: + * @KMOD_SYMBOL_NONE: no or unknown symbol type + * @KMOD_SYMBOL_LOCAL: local symbol, accessible only within the module + * @KMOD_SYMBOL_GLOBAL: global symbol, accessible by all modules + * @KMOD_SYMBOL_WEAK: weak symbol, a lower precedence global symbols + * @KMOD_SYMBOL_UNDEF: undefined or not yet resolved symbol + * + * The symbol bind type, see kmod_module_dependency_symbol_get_bind(). + */ +enum kmod_symbol_bind { + KMOD_SYMBOL_NONE = '\0', + KMOD_SYMBOL_LOCAL = 'L', + KMOD_SYMBOL_GLOBAL = 'G', + KMOD_SYMBOL_WEAK = 'W', + KMOD_SYMBOL_UNDEF = 'U' +}; + /** * kmod_module_dependency_symbol_get_bind: * @entry: a list entry representing a kmod module dependency_symbol * * Get the bind type of a kmod module dependency_symbol. * - * Returns: the bind of this kmod module dependency_symbol on success - * or < 0 on failure. + * Returns: the bind of this kmod module dependency_symbol on success, + * or < 0 on failure. Valid bind types are #kmod_symbol_bind. */ int kmod_module_dependency_symbol_get_bind(const struct kmod_list *entry); @@ -1206,15 +1224,6 @@ const char *kmod_module_info_get_value(const struct kmod_list *entry); void kmod_module_info_free_list(struct kmod_list *list); -enum kmod_symbol_bind { - KMOD_SYMBOL_NONE = '\0', - KMOD_SYMBOL_LOCAL = 'L', - KMOD_SYMBOL_GLOBAL = 'G', - KMOD_SYMBOL_WEAK = 'W', - KMOD_SYMBOL_UNDEF = 'U' -}; - - /** * SECTION:libkmod-loaded