From a26e7f34561a22fea8f5fb961f0a83b154039076 Mon Sep 17 00:00:00 2001 From: Emil Velikov Date: Mon, 2 Sep 2024 23:20:19 +0100 Subject: [PATCH] libkmod/docs: document and reference kmod_index Mostly move the existing documentation from kmod_dump_index(). Signed-off-by: Emil Velikov Link: https://github.com/kmod-project/kmod/pull/94 Signed-off-by: Lucas De Marchi --- libkmod/docs/libkmod-sections.txt | 1 + libkmod/libkmod.h | 19 ++++++++++++------- 2 files changed, 13 insertions(+), 7 deletions(-) diff --git a/libkmod/docs/libkmod-sections.txt b/libkmod/docs/libkmod-sections.txt index 704409fc..6ae614f4 100644 --- a/libkmod/docs/libkmod-sections.txt +++ b/libkmod/docs/libkmod-sections.txt @@ -9,6 +9,7 @@ kmod_load_resources kmod_unload_resources kmod_resources kmod_validate_resources +kmod_index kmod_dump_index kmod_set_log_priority diff --git a/libkmod/libkmod.h b/libkmod/libkmod.h index fcfcecbb..39e83238 100644 --- a/libkmod/libkmod.h +++ b/libkmod/libkmod.h @@ -150,25 +150,30 @@ enum kmod_resources { */ int kmod_validate_resources(struct kmod_ctx *ctx); +/** + * kmod_index: + * @KMOD_INDEX_MODULES_DEP: index of module dependencies + * @KMOD_INDEX_MODULES_ALIAS: index of module aliases + * @KMOD_INDEX_MODULES_SYMBOL: index of symbol aliases + * @KMOD_INDEX_MODULES_BUILTIN_ALIAS: index of builtin module aliases + * @KMOD_INDEX_MODULES_BUILTIN: index of builtin module + * @_KMOD_INDEX_PAD: DO NOT USE; padding to make sure enum is not mapped to char + * + * The (module) index type, used by kmod_dump_index(). + */ enum kmod_index { KMOD_INDEX_MODULES_DEP = 0, KMOD_INDEX_MODULES_ALIAS, KMOD_INDEX_MODULES_SYMBOL, KMOD_INDEX_MODULES_BUILTIN_ALIAS, KMOD_INDEX_MODULES_BUILTIN, - /* Padding to make sure enum is not mapped to char */ _KMOD_INDEX_PAD = 1U << 31, }; /** * kmod_dump_index: * @ctx: kmod library context - * @type: index to dump, valid indexes are - * KMOD_INDEX_MODULES_DEP: index of module dependencies; - * KMOD_INDEX_MODULES_ALIAS: index of module aliases; - * KMOD_INDEX_MODULES_SYMBOL: index of symbol aliases; - * KMOD_INDEX_MODULES_BUILTIN_ALIAS: index of builtin module aliases. - * KMOD_INDEX_MODULES_BUILTIN: index of builtin module. + * @type: index to dump, valid indexes are #kmod_index * @fd: file descriptor to dump index to * * Dump index to file descriptor. Note that this function doesn't use stdio.h -- 2.47.2