[PATCH] module.h: Document klp_modinfo struct members

From: Marcos Paulo de Souza
Date: Thu Feb 02 2023 - 13:40:15 EST


The struct members description can be found on
Documentation/livepatch/module-elf-format.rst, but for a developer it's
easier to search for such information looking at the struct definition.

Signed-off-by: Marcos Paulo de Souza <mpdesouza@xxxxxxxx>
---
include/linux/module.h | 8 ++++----
1 file changed, 4 insertions(+), 4 deletions(-)

diff --git a/include/linux/module.h b/include/linux/module.h
index ec61fb53979a..4fbe06b29b39 100644
--- a/include/linux/module.h
+++ b/include/linux/module.h
@@ -353,10 +353,10 @@ struct mod_kallsyms {

#ifdef CONFIG_LIVEPATCH
struct klp_modinfo {
- Elf_Ehdr hdr;
- Elf_Shdr *sechdrs;
- char *secstrings;
- unsigned int symndx;
+ Elf_Ehdr hdr; /* Elf header */
+ Elf_Shdr *sechdrs; /* Section header table */
+ char *secstrings; /* String table for the section headers */
+ unsigned int symndx; /* The symbol table section index */
};
#endif

--
2.39.1