Add doc to kmod_dump_index

diff --git a/libkmod/docs/libkmod-sections.txt b/libkmod/docs/libkmod-sections.txt
index 445206c8e18858468b0984d953e3957af10cdbee..1a5a5fd3f3272ca724d57cc3685c094c064d0d57 100644 (file)
--- a/libkmod/docs/libkmod-sections.txt
+++ b/libkmod/docs/libkmod-sections.txt
@@ -8,6 +8,7 @@ kmod_unref
 kmod_load_resources
 kmod_unload_resources
 kmod_validate_resources
+kmod_dump_index
 
 kmod_set_log_priority
 kmod_get_log_priority

diff --git a/libkmod/libkmod.c b/libkmod/libkmod.c
index f544c66d73bc65184aee21980240083556969d6f..800a1784ffeb916f49ea8ab0e52f1de377c3512f 100644 (file)
--- a/libkmod/libkmod.c
+++ b/libkmod/libkmod.c
@@ -746,6 +746,16 @@ KMOD_EXPORT void kmod_unload_resources(struct kmod_ctx *ctx)
        }
 }
 
+/**
+ * kmod_dump_index:
+ * @ctx: kmod library context
+ * @type: index to dump
+ * @fd: file descriptor to dump index to
+ *
+ * Dump index to file descriptor
+ *
+ * Returns: 0 on success or < 0 otherwise.
+ */
 KMOD_EXPORT int kmod_dump_index(struct kmod_ctx *ctx, enum kmod_index type,
                                                                        int fd)
 {

diff --git a/libkmod/libkmod.h b/libkmod/libkmod.h
index 64fe064cd880a2097e3cb5fa71ed1008dc23c717..b084011cee99fd5748e31ab0d11a5085ca508a9b 100644 (file)
--- a/libkmod/libkmod.h
+++ b/libkmod/libkmod.h
@@ -69,7 +69,7 @@ enum kmod_index {
        _KMOD_INDEX_PAD = (1 << 31),
 };
 
-int kmod_dump_index(struct kmod_ctx *ctx, enum kmod_index idx, int fd);
+int kmod_dump_index(struct kmod_ctx *ctx, enum kmod_index type, int fd);
 
 /*
  * kmod_list