libkmod/docs: document and reference kmod_symbol_bind

Signed-off-by: Emil Velikov <emil.l.velikov@gmail.com>
Link: https://github.com/kmod-project/kmod/pull/94
Signed-off-by: Lucas De Marchi <lucas.de.marchi@gmail.com>

diff --git a/libkmod/docs/libkmod-sections.txt b/libkmod/docs/libkmod-sections.txt
index 7debc8c941eb4d836fbd2ee8b3f7e7cf04e7c68c..dd502647c9e09be3b18af926abbc9bfcd622c90c 100644 (file)
--- 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 e21aabcffdeb07ab48db483ef6b45f836868a091..6612206524e5dc919bc3389312bdbbffd51ac0f8 100644 (file)
--- 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