module.h: Document klp_modinfo struct using kdoc
authorMarcos Paulo de Souza <mpdesouza@suse.com>
Fri, 3 Feb 2023 12:22:21 +0000 (09:22 -0300)
committerLuis Chamberlain <mcgrof@kernel.org>
Mon, 6 Feb 2023 16:45:55 +0000 (08:45 -0800)
Previously the documentation existed only in Documentation/livepatch
directory.

Signed-off-by: Marcos Paulo de Souza <mpdesouza@suse.com>
Signed-off-by: Luis Chamberlain <mcgrof@kernel.org>
include/linux/module.h

index 8c5909c..6449ea5 100644 (file)
@@ -352,6 +352,14 @@ struct mod_kallsyms {
 };
 
 #ifdef CONFIG_LIVEPATCH
+/**
+ * struct klp_modinfo - Elf information preserved from the livepatch module
+ *
+ * @hdr: Elf header
+ * @sechdrs: Section header table
+ * @secstrings: String table for the section headers
+ * @symndx: The symbol table section index
+ */
 struct klp_modinfo {
        Elf_Ehdr hdr;
        Elf_Shdr *sechdrs;