Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

x86/insn-eval: Fix function param name in get_eff_addr_sib()

Change "regoff" to "base_offset" in 2 places in the kernel-doc comments to
prevent warnings:

insn-eval.c:1152: warning: Function parameter or member 'base_offset' not described in 'get_eff_addr_sib'
insn-eval.c:1152: warning: Excess function parameter 'regoff' description in 'get_eff_addr_sib'

Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Signed-off-by: Borislav Petkov (AMD) <bp@alien8.de>
Link: https://lore.kernel.org/r/20240211062452.16411-1-rdunlap@infradead.org

authored by

Randy Dunlap and committed by
Borislav Petkov (AMD)
7d4002e8 841c3516

+3 -3
+3 -3
arch/x86/lib/insn-eval.c
··· 1129 1129 * get_eff_addr_sib() - Obtain referenced effective address via SIB 1130 1130 * @insn: Instruction. Must be valid. 1131 1131 * @regs: Register values as seen when entering kernel mode 1132 - * @regoff: Obtained operand offset, in pt_regs, associated with segment 1132 + * @base_offset: Obtained operand offset, in pt_regs, associated with segment 1133 1133 * @eff_addr: Obtained effective address 1134 1134 * 1135 1135 * Obtain the effective address referenced by the SIB byte of @insn. After 1136 1136 * identifying the registers involved in the indexed, register-indirect memory 1137 1137 * reference, its value is obtained from the operands in @regs. The computed 1138 1138 * address is stored @eff_addr. Also, the register operand that indicates the 1139 - * associated segment is stored in @regoff, this parameter can later be used to 1140 - * determine such segment. 1139 + * associated segment is stored in @base_offset; this parameter can later be 1140 + * used to determine such segment. 1141 1141 * 1142 1142 * Returns: 1143 1143 *