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

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [day] [month] [year] [list]

Message-ID: <cf39523d-e801-5aa9-c8a2-fd77d2310d45@infradead.org>
Date:   Sat, 11 Mar 2023 16:43:30 -0800
From:   Randy Dunlap <rdunlap@...radead.org>
To:     Anuradha Weeraman <anuradha@...ian.org>,
        Thomas Gleixner <tglx@...utronix.de>,
        Ingo Molnar <mingo@...hat.com>, Borislav Petkov <bp@...en8.de>,
        Dave Hansen <dave.hansen@...ux.intel.com>, x86@...nel.org,
        "H. Peter Anvin" <hpa@...or.com>,
        Andy Lutomirski <luto@...nel.org>,
        Peter Zijlstra <peterz@...radead.org>,
        Brian Gerst <brgerst@...il.com>,
        "Jason A. Donenfeld" <Jason@...c4.com>,
        Juergen Gross <jgross@...e.com>,
        Andrew Morton <akpm@...ux-foundation.org>,
        "Mike Rapoport (IBM)" <rppt@...nel.org>,
        Suren Baghdasaryan <surenb@...gle.com>,
        Jan Beulich <jbeulich@...e.com>, linux-kernel@...r.kernel.org
Subject: Re: [PATCH] x86: Fix W=1 kernel-doc warnings

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@...ian.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@...radead.org>
Tested-by: Randy Dunlap <rdunlap@...radead.org>


Thanks.
-- 
~Randy