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_filter
X-Git-Tag: v34~434
X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=0e5e18e8cfb22e2bcb79d9dae951a78190cf0c82;p=thirdparty%2Fkmod.git

libkmod/docs: document and reference kmod_filter

Mostly move the existing documentation from kmod_module_apply_filter().

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 ad026aa2..fe7509fe 100644
--- a/libkmod/docs/libkmod-sections.txt
+++ b/libkmod/docs/libkmod-sections.txt
@@ -69,6 +69,7 @@ kmod_module_get_module
 kmod_module_get_dependencies
 kmod_module_get_softdeps
 kmod_module_get_weakdeps
+kmod_filter
 kmod_module_apply_filter
 kmod_module_get_filtered_blacklist
 kmod_module_get_install_commands
diff --git a/libkmod/libkmod.h b/libkmod/libkmod.h
index f02001d6..c4583a3a 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);
 
 
-/* Flags to kmod_module_apply_filter() */
-enum kmod_filter {
-	KMOD_FILTER_BLACKLIST = 0x00001,
-	KMOD_FILTER_BUILTIN = 0x00002,
-};
-
 /**
  * kmod_insert:
  * @KMOD_INSERT_FORCE_VERMAGIC: ignore kernel version magic
@@ -838,12 +832,22 @@ int kmod_module_get_softdeps(const struct kmod_module *mod,
 int kmod_module_get_weakdeps(const struct kmod_module *mod,
 				struct kmod_list **weak);
 
+/**
+ * kmod_filter:
+ * @KMOD_FILTER_BLACKLIST: filter modules in blacklist out
+ * @KMOD_FILTER_BUILTIN: filter builtin modules out
+ *
+ * Bitmask defining what gets filtered out, used by kmod_module_apply_filter().
+ */
+enum kmod_filter {
+	KMOD_FILTER_BLACKLIST = 0x00001,
+	KMOD_FILTER_BUILTIN = 0x00002,
+};
+
 /**
  * kmod_module_apply_filter:
  * @ctx: kmod library context
- * @filter_type: bitmask to filter modules out, valid types are
- * KMOD_FILTER_BLACKLIST: filter modules in blacklist out;
- * KMOD_FILTER_BUILTIN: filter builtin modules out.
+ * @filter_type: bitmask to filter modules out, valid types are #kmod_filter
  * @input: list of kmod_module to be filtered
  * @output: where to save the new list
  *