[v2,1/2] module.h: Document klp_modinfo struct using kdoc

Message ID 20230203122222.1907-2-mpdesouza@suse.com
State New
Headers
Series [v2,1/2] module.h: Document klp_modinfo struct using kdoc |

Commit Message

Marcos Paulo de Souza Feb. 3, 2023, 12:22 p.m. UTC
  Previously the documentation existed only in Documentation/livepatch
directory.

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

Patch

diff --git a/include/linux/module.h b/include/linux/module.h
index ec61fb53979a..3382ef8f66a8 100644
--- a/include/linux/module.h
+++ b/include/linux/module.h
@@ -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;