linux-kernel - Re: [PATCH RESEND 1/4] x86/mm: pgtable: Fix W=1 build 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] [thread-next>] [day] [month] [year] [list]

Message-ID: <aCWPp4wYwauSuTed@gmail.com>
Date: Thu, 15 May 2025 08:54:31 +0200
From: Ingo Molnar <mingo@...nel.org>
To: Shivank Garg <shivankg@....com>
Cc: tglx@...utronix.de, mingo@...hat.com, bp@...en8.de,
	dave.hansen@...ux.intel.com, x86@...nel.org, hpa@...or.com,
	luto@...nel.org, peterz@...radead.org, rafael@...nel.org,
	pavel@...nel.org, akpm@...ux-foundation.org,
	linux-kernel@...r.kernel.org, linux-pm@...r.kernel.org,
	sohil.mehta@...el.com, rui.zhang@...el.com, yuntao.wang@...ux.dev,
	kai.huang@...el.com, xiaoyao.li@...el.com, peterx@...hat.com,
	sandipan.das@....com, ak@...ux.intel.com, rostedt@...dmis.org
Subject: Re: [PATCH RESEND 1/4] x86/mm: pgtable: Fix W=1 build kernel-doc
 warnings


* Shivank Garg <shivankg@....com> wrote:

> 
> 
> On 5/14/2025 2:50 PM, Ingo Molnar wrote:
> > 
> > * Shivank Garg <shivankg@....com> wrote:
> > 
> >>>> @@ -665,6 +665,9 @@ void native_set_fixmap(unsigned /* enum fixed_addresses */ idx,
> >>>>  #ifdef CONFIG_X86_5LEVEL
> >>>>  /**
> >>>>   * p4d_set_huge - setup kernel P4D mapping
> >>>> + * @p4d: Pointer to a p4d entry.
> >>>> + * @addr: Virtual Address associated with p4d.
> >>>> + * @prot: Protection bits to use.
> >>>
> >>> How about using the same capitalization you already see in this 
> >>> description?
> > 
> >> Please review the revised patch with suggested changes.
> > 
> > I think you misunderstood: why are you using 'p4d', while a line before 
> > it's 'P4D'? It's an acronym, and only used lowercase when it's a local 
> > variable. 'p4d is a pointer to a p4d entry' is doubly confusing in that 
> > regard ...
> > 
> > Same for PMD/PUD etc.
> > 
> 
> Thank you for the clarification. I understand it now.
> I hope the attached patch looks good now.

No. Please re-read your patches and see whether you caught everything, 
not just the things I pointed out ...

>  /**
>   * reserve_top_address - reserves a hole in the top of kernel address space
> - * @reserve - size of hole to reserve
> + * @reserve: size of hole to reserve.

And here the original capitalization in your -v1 patch was better.

>   * p4d_set_huge - setup kernel P4D mapping
> + * @p4d: pointer to a P4D entry.
> + * @addr: virtual Address associated with p4d.
> + * @prot: protection bits to use.

Why is 'address' capitalized here?

>  /**
>   * pud_set_huge - setup kernel PUD mapping
> + * @pud: pointer to a PUD entry.
> + * @addr: virtual Address associated with pud.
> + * @prot: protection bits to use.

s/pud
 /the PUD entry

Also, similar errors are elsewhere as well.

Thanks,

	Ingo