| Message ID | 20230202182950.10471-1-mpdesouza@suse.com (mailing list archive) |
|---|---|
| State | New, archived |
| Headers | show |
| Series | module.h: Document klp_modinfo struct members | expand |
On Thu, Feb 02, 2023 at 03:29:50PM -0300, Marcos Paulo de Souza wrote: > 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@suse.com> Why not just embrace kdoc and then refer to it in the rst files? Luis
On Thu, Feb 02, 2023 at 11:02:27AM -0800, Luis Chamberlain wrote: > On Thu, Feb 02, 2023 at 03:29:50PM -0300, Marcos Paulo de Souza wrote: > > 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@suse.com> > > Why not just embrace kdoc and then refer to it in the rst files? Seems to be a very good idea Luis. I'll try to find some examples in our Docs how this is done. Thanks > > Luis
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
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@suse.com> --- include/linux/module.h | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-)