From: Emil Velikov <emil.l.velikov@gmail.com>
Date: Mon, 2 Sep 2024 22:20:19 +0000 (+0100)
Subject: libkmod/docs: document and reference kmod_insert
X-Git-Tag: v34~437
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=9e1c6c5336d3cf30d3e25947ba74ff4353d04f9c;p=thirdparty%2Fkmod.git

libkmod/docs: document and reference kmod_insert

Mostly move the existing documentation from kmod_module_insert_module().

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 6ae614f4..6bde32e3 100644
--- a/libkmod/docs/libkmod-sections.txt
+++ b/libkmod/docs/libkmod-sections.txt
@@ -58,6 +58,7 @@ kmod_module_ref
 kmod_module_unref
 kmod_module_unref_list
 
+kmod_insert
 kmod_module_insert_module
 kmod_module_probe_insert_module
 kmod_module_remove_module
diff --git a/libkmod/libkmod.h b/libkmod/libkmod.h
index 39e83238..b197c69d 100644
--- a/libkmod/libkmod.h
+++ b/libkmod/libkmod.h
@@ -640,12 +640,6 @@ struct kmod_module *kmod_module_unref(struct kmod_module *mod);
 int kmod_module_unref_list(struct kmod_list *list);
 
 
-/* Insertion flags */
-enum kmod_insert {
-	KMOD_INSERT_FORCE_VERMAGIC = 0x1,
-	KMOD_INSERT_FORCE_MODVERSION = 0x2,
-};
-
 /* Flags to kmod_module_probe_insert_module() */
 enum kmod_probe {
 	KMOD_PROBE_FORCE_VERMAGIC =		0x00001,
@@ -667,13 +661,23 @@ enum kmod_filter {
 	KMOD_FILTER_BUILTIN = 0x00002,
 };
 
+/**
+ * kmod_insert:
+ * @KMOD_INSERT_FORCE_VERMAGIC: ignore kernel version magic
+ * @KMOD_INSERT_FORCE_MODVERSION: ignore symbol version hashes
+ *
+ * Insertion flags, used by kmod_module_insert_module().
+ */
+enum kmod_insert {
+	KMOD_INSERT_FORCE_VERMAGIC = 0x1,
+	KMOD_INSERT_FORCE_MODVERSION = 0x2,
+};
+
 /**
  * kmod_module_insert_module:
  * @mod: kmod module
  * @flags: flags are not passed to Linux Kernel, but instead they dictate the
- * behavior of this function, valid flags are
- * KMOD_INSERT_FORCE_VERMAGIC: ignore kernel version magic;
- * KMOD_INSERT_FORCE_MODVERSION: ignore symbol version hashes.
+ * behavior of this function, valid flags #kmod_insert
  * @options: module's options to pass to Linux Kernel.
  *
  * Insert a module in Linux kernel. It opens the file pointed by @mod,