From:   Marcos Paulo de Souza <mpdesouza@suse.com>
To:     mcgrof@kernel.org, linux-modules@vger.kernel.org,
        linux-kernel@vger.kernel.org, live-patching@vger.kernel.org
Cc:     Marcos Paulo de Souza <mpdesouza@suse.com>
Subject: [PATCH] module.h: Document klp_modinfo struct members
Date:   Thu,  2 Feb 2023 15:29:50 -0300
Message-Id: <20230202182950.10471-1-mpdesouza@suse.com>
MIME-Version: 1.0
Content-Transfer-Encoding: 8bit
Precedence: bulk

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(-)

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