[PATCH] x86: Fix W=1 kernel-doc warnings

[PATCH] x86: Fix W=1 kernel-doc warnings

[Anuradha Weeraman]

Fix W=1 kernel-doc warnings for:
  - arch/x86/lib/insn-eval.c
  - arch/x86/mm/pat/memtype.c

Signed-off-by: Anuradha Weeraman <anuradha@debian.org>
---
 arch/x86/lib/insn-eval.c  | 6 +++---
 arch/x86/mm/pat/memtype.c | 1 +
 2 files changed, 4 insertions(+), 3 deletions(-)

diff --git a/arch/x86/lib/insn-eval.c b/arch/x86/lib/insn-eval.c
index 558a605929db..0bc9d87ab95d 100644
--- a/arch/x86/lib/insn-eval.c
+++ b/arch/x86/lib/insn-eval.c
@@ -1129,15 +1129,15 @@ static int get_eff_addr_modrm_16(struct insn *insn, struct pt_regs *regs,
  * get_eff_addr_sib() - Obtain referenced effective address via SIB
  * @insn:	Instruction. Must be valid.
  * @regs:	Register values as seen when entering kernel mode
- * @regoff:	Obtained operand offset, in pt_regs, associated with segment
+ * @base_offset:Obtained operand offset, in pt_regs, associated with segment
  * @eff_addr:	Obtained effective address
  *
  * Obtain the effective address referenced by the SIB byte of @insn. After
  * identifying the registers involved in the indexed, register-indirect memory
  * reference, its value is obtained from the operands in @regs. The computed
  * address is stored @eff_addr. Also, the register operand that indicates the
- * associated segment is stored in @regoff, this parameter can later be used to
- * determine such segment.
+ * associated segment is stored in @base_offset, this parameter can later be
+ * used to determine such segment.
  *
  * Returns:
  *
diff --git a/arch/x86/mm/pat/memtype.c b/arch/x86/mm/pat/memtype.c
index 46a00aa858b6..380bec99fab5 100644
--- a/arch/x86/mm/pat/memtype.c
+++ b/arch/x86/mm/pat/memtype.c
@@ -700,6 +700,7 @@ static enum page_cache_mode lookup_memtype(u64 paddr)
 /**
  * pat_pfn_immune_to_uc_mtrr - Check whether the PAT memory type
  * of @pfn cannot be overridden by UC MTRR memory type.
+ * @pfn: page frame number
  *
  * Only to be called when PAT is enabled.
  *
-- 
2.39.2

Re: [PATCH] x86: Fix W=1 kernel-doc warnings

[Randy Dunlap]

Hi--

On 3/11/23 10:57, Anuradha Weeraman wrote:
> Fix W=1 kernel-doc warnings for:
>   - arch/x86/lib/insn-eval.c
>   - arch/x86/mm/pat/memtype.c
> 
> Signed-off-by: Anuradha Weeraman <anuradha@debian.org>
> ---
>  arch/x86/lib/insn-eval.c  | 6 +++---
>  arch/x86/mm/pat/memtype.c | 1 +
>  2 files changed, 4 insertions(+), 3 deletions(-)
> 
> diff --git a/arch/x86/lib/insn-eval.c b/arch/x86/lib/insn-eval.c
> index 558a605929db..0bc9d87ab95d 100644
> --- a/arch/x86/lib/insn-eval.c
> +++ b/arch/x86/lib/insn-eval.c
> @@ -1129,15 +1129,15 @@ static int get_eff_addr_modrm_16(struct insn *insn, struct pt_regs *regs,
>   * get_eff_addr_sib() - Obtain referenced effective address via SIB
>   * @insn:	Instruction. Must be valid.
>   * @regs:	Register values as seen when entering kernel mode
> - * @regoff:	Obtained operand offset, in pt_regs, associated with segment
> + * @base_offset:Obtained operand offset, in pt_regs, associated with segment

I would insert a space after @base_offset:
but ultimately it's up to the maintainers.

>   * @eff_addr:	Obtained effective address
>   *
>   * Obtain the effective address referenced by the SIB byte of @insn. After
>   * identifying the registers involved in the indexed, register-indirect memory
>   * reference, its value is obtained from the operands in @regs. The computed
>   * address is stored @eff_addr. Also, the register operand that indicates the
> - * associated segment is stored in @regoff, this parameter can later be used to
> - * determine such segment.
> + * associated segment is stored in @base_offset, this parameter can later be
> + * used to determine such segment.
>   *
>   * Returns:>   *
> diff --git a/arch/x86/mm/pat/memtype.c b/arch/x86/mm/pat/memtype.c
> index 46a00aa858b6..380bec99fab5 100644
> --- a/arch/x86/mm/pat/memtype.c
> +++ b/arch/x86/mm/pat/memtype.c
> @@ -700,6 +700,7 @@ static enum page_cache_mode lookup_memtype(u64 paddr)
>  /**
>   * pat_pfn_immune_to_uc_mtrr - Check whether the PAT memory type
>   * of @pfn cannot be overridden by UC MTRR memory type.
> + * @pfn: page frame number
>   *
>   * Only to be called when PAT is enabled.
>   *

Acked-by: Randy Dunlap <rdunlap@infradead.org>
Tested-by: Randy Dunlap <rdunlap@infradead.org>


Thanks.
-- 
~Randy