linux-mm.kvack.org archive mirror
 help / color / mirror / Atom feed
From: Sanjay Chitroda <sanjayembeddedse@gmail.com>
To: Matthew Wilcox <willy@infradead.org>
Cc: Vlastimil Babka <vbabka@suse.cz>,
	Andrew Morton <akpm@linux-foundation.org>,
	Christoph Lameter <cl@gentwo.org>,
	David Rientjes <rientjes@google.com>,
	Roman Gushchin <roman.gushchin@linux.dev>,
	Harry Yoo <harry.yoo@oracle.com>,
	linux-mm@kvack.org, linux-kernel@vger.kernel.org
Subject: Re: [PATCH] mm/slub: drop duplicate kernel-doc for ksize()
Date: Tue, 24 Feb 2026 09:14:03 +0530	[thread overview]
Message-ID: <599A72EE-58A7-47C0-9F0B-03A908D2AC5F@gmail.com> (raw)
In-Reply-To: <aZxvWlsrueUgWuOX@casper.infradead.org>



On 23 February 2026 8:46:42 pm IST, Matthew Wilcox <willy@infradead.org> wrote:
>On Fri, Feb 20, 2026 at 06:12:43PM +0530, Sanjay Chitroda wrote:
>> The ksize() API is already documented in the public header, and
>> Documentation/core-api/mm-api.rst pulls that canonical doc into the
>> book. The kernel-doc block added to mm/slub.c by commit
>> fab0694646d7 ("mm/slab: move [__]ksize and slab_ksize() to mm/slub.c")
>> introduced a second definition for the same symbol in the generated
>> docs, which makes Sphinx emit:
>> 
>>   WARNING: Duplicate C declaration, also defined at core-api/mm-api:521
>>   Declaration is '.. c:function:: size_t ksize(const void *objp)'
>> 
>> Remove the redundant kernel-doc comment from slub.c so only the
>
>Usually we keep the kernel-doc comment with the implementation, not with
>the prototype.

I agree with you, Kernel-doc comment should be present with implementation.
I have observed that multiple kernel-doc comments are there in slab.h with prototype, would you suggest to replace all possible at once ?

Or with reference to reported warning; we can keep kernel-doc with implementation and remove from prototype and rectify commit message to highlight ideal kernel-doc practice along with existing commit details so context would be better clear and relavent.


      parent reply	other threads:[~2026-02-24  3:44 UTC|newest]

Thread overview: 6+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2026-02-20 12:42 Sanjay Chitroda
2026-02-22  3:47 ` David Rientjes
2026-02-23 13:21   ` Sanjay Chitroda
2026-02-23 15:16 ` Matthew Wilcox
2026-02-24  3:10   ` Sanjay Embedded_SE
2026-02-24  3:44   ` Sanjay Chitroda [this message]

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=599A72EE-58A7-47C0-9F0B-03A908D2AC5F@gmail.com \
    --to=sanjayembeddedse@gmail.com \
    --cc=akpm@linux-foundation.org \
    --cc=cl@gentwo.org \
    --cc=harry.yoo@oracle.com \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux-mm@kvack.org \
    --cc=rientjes@google.com \
    --cc=roman.gushchin@linux.dev \
    --cc=vbabka@suse.cz \
    --cc=willy@infradead.org \
    /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 a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox