All of lore.kernel.org
 help / color / mirror / Atom feed
From: Ingo Molnar <mingo@kernel.org>
To: Shivank Garg <shivankg@amd.com>
Cc: tglx@linutronix.de, mingo@redhat.com, bp@alien8.de,
	dave.hansen@linux.intel.com, x86@kernel.org, hpa@zytor.com,
	luto@kernel.org, peterz@infradead.org, rafael@kernel.org,
	pavel@kernel.org, akpm@linux-foundation.org,
	linux-kernel@vger.kernel.org, linux-pm@vger.kernel.org,
	sohil.mehta@intel.com, rui.zhang@intel.com,
	yuntao.wang@linux.dev, kai.huang@intel.com, xiaoyao.li@intel.com,
	peterx@redhat.com, sandipan.das@amd.com, ak@linux.intel.com,
	rostedt@goodmis.org
Subject: Re: [PATCH RESEND 1/4] x86/mm: pgtable: Fix W=1 build kernel-doc warnings
Date: Wed, 14 May 2025 11:20:07 +0200	[thread overview]
Message-ID: <aCRgRxmO6rsR-0k3@gmail.com> (raw)
In-Reply-To: <6c4b227e-abdd-4e7f-8abd-d85cae0f0ec3@amd.com>


* Shivank Garg <shivankg@amd.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.

Thanks,

	Ingo

  reply	other threads:[~2025-05-14  9:20 UTC|newest]

Thread overview: 22+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2025-05-14  6:26 [PATCH RESEND 1/4] x86/mm: pgtable: Fix W=1 build kernel-doc warnings Shivank Garg
2025-05-14  6:26 ` [PATCH RESEND 2/4] x86/power: hibernate: " Shivank Garg
2025-05-14  8:07   ` [tip: x86/cleanups] " tip-bot2 for Shivank Garg
2025-05-14  6:26 ` [PATCH RESEND 3/4] x86/mm/pat: Fix W=1 build kernel-doc warning Shivank Garg
2025-05-14  8:07   ` [tip: x86/cleanups] " tip-bot2 for Shivank Garg
2025-05-14  6:26 ` [PATCH RESEND 4/4] x86/apic: " Shivank Garg
2025-05-14  7:56   ` Ingo Molnar
2025-05-15  6:33     ` Shivank Garg
2025-05-15  6:38       ` Ingo Molnar
2025-05-15  6:49       ` Ingo Molnar
2025-05-15  7:19       ` Thomas Gleixner
2025-05-15  8:15         ` [PATCH] x86/apic: Better document spurious_interrupt() and __spurious_interrupt() Ingo Molnar
2025-05-14  7:54 ` [PATCH RESEND 1/4] x86/mm: pgtable: Fix W=1 build kernel-doc warnings Ingo Molnar
2025-05-14  8:06   ` Shivank Garg
2025-05-14  8:27   ` Shivank Garg
2025-05-14  9:20     ` Ingo Molnar [this message]
2025-05-15  3:54       ` Shivank Garg
2025-05-15  6:54         ` Ingo Molnar
2025-05-15  9:57           ` Shivank Garg
2025-05-15 15:06             ` Ingo Molnar
2025-05-15 18:10               ` Shivank Garg
2025-05-15 15:11 ` [tip: x86/core] x86/mm: Fix kernel-doc descriptions of various pgtable methods tip-bot2 for Shivank Garg

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=aCRgRxmO6rsR-0k3@gmail.com \
    --to=mingo@kernel.org \
    --cc=ak@linux.intel.com \
    --cc=akpm@linux-foundation.org \
    --cc=bp@alien8.de \
    --cc=dave.hansen@linux.intel.com \
    --cc=hpa@zytor.com \
    --cc=kai.huang@intel.com \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux-pm@vger.kernel.org \
    --cc=luto@kernel.org \
    --cc=mingo@redhat.com \
    --cc=pavel@kernel.org \
    --cc=peterx@redhat.com \
    --cc=peterz@infradead.org \
    --cc=rafael@kernel.org \
    --cc=rostedt@goodmis.org \
    --cc=rui.zhang@intel.com \
    --cc=sandipan.das@amd.com \
    --cc=shivankg@amd.com \
    --cc=sohil.mehta@intel.com \
    --cc=tglx@linutronix.de \
    --cc=x86@kernel.org \
    --cc=xiaoyao.li@intel.com \
    --cc=yuntao.wang@linux.dev \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body. 
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.