libkmod/docs: document and reference kmod_module_initstate

Mostly move the existing documentation from kmod_module_get_initstate()

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 fe7509fe282734044622a73ed7eaf076bf8c8df8..7debc8c941eb4d836fbd2ee8b3f7e7cf04e7c68c 100644 (file)
--- a/libkmod/docs/libkmod-sections.txt
+++ b/libkmod/docs/libkmod-sections.txt
@@ -108,6 +108,7 @@ kmod_module_info_free_list
 <SECTION>
 <FILE>libkmod-loaded</FILE>
 kmod_module_new_from_loaded
+kmod_module_initstate
 kmod_module_get_initstate
 kmod_module_initstate_str
 kmod_module_get_size

diff --git a/libkmod/libkmod.h b/libkmod/libkmod.h
index c4583a3ad8946c83d395f91cdaec051d5430c393..47b70bb40b0ee710a228406c006894dd10a1797a 100644 (file)
--- a/libkmod/libkmod.h
+++ b/libkmod/libkmod.h
@@ -1247,17 +1247,22 @@ enum kmod_symbol_bind {
 int kmod_module_new_from_loaded(struct kmod_ctx *ctx,
                                                struct kmod_list **list);
 
-/*
- * Information regarding "live information" from module's state, as returned
- * by kernel
+/**
+ * kmod_module_initstate:
+ * @KMOD_MODULE_BUILTIN: module is builtin
+ * @KMOD_MODULE_LIVE: module is live in kernel
+ * @KMOD_MODULE_COMING: module is being loaded
+ * @KMOD_MODULE_GOING: module is being unloaded
+ * @_KMOD_MODULE_PAD: DO NOT USE; padding to make sure enum is not mapped to char
+ *
+ * The module "live information" as reported by the kernel, see
+ * kmod_module_get_initstate().
  */
-
 enum kmod_module_initstate {
        KMOD_MODULE_BUILTIN = 0,
        KMOD_MODULE_LIVE,
        KMOD_MODULE_COMING,
        KMOD_MODULE_GOING,
-       /* Padding to make sure enum is not mapped to char */
        _KMOD_MODULE_PAD = 1U << 31,
 };
 
@@ -1268,11 +1273,8 @@ enum kmod_module_initstate {
  * Get the initstate of this @mod, as returned by Linux Kernel, by reading
  * /sys filesystem.
  *
- * Returns: < 0 on error or module state if module is found in kernel, valid states are
- * KMOD_MODULE_BUILTIN: module is builtin;
- * KMOD_MODULE_LIVE: module is live in kernel;
- * KMOD_MODULE_COMING: module is being loaded;
- * KMOD_MODULE_GOING: module is being unloaded.
+ * Returns: < 0 on error or module state if module is found in kernel, valid
+ * states are #kmod_module_initstate.
  */
 int kmod_module_get_initstate(const struct kmod_module *mod);