linux-mm.kvack.org archive mirror
 help / color / mirror / Atom feed
From: Matthew Wilcox <willy@infradead.org>
To: Vlastimil Babka <vbabka@suse.cz>
Cc: 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
Subject: Re: [PATCH v2 06/11] doc: Add slab internal kernel-doc
Date: Tue, 17 Jun 2025 15:16:52 +0100	[thread overview]
Message-ID: <aFF41KSWUoHPahrD@casper.infradead.org> (raw)
In-Reply-To: <3ff99403-9de6-4fad-81b5-3eeb657c4bbb@suse.cz>

On Tue, Jun 17, 2025 at 04:03:26PM +0200, Vlastimil Babka wrote:
> On 6/11/25 17:59, Matthew Wilcox (Oracle) wrote:
> > We don't have much real internal documentation to extract yet, but
> > let's make sure that what we do have is available.

> > +Functions and structures
> > +========================
> > +
> > +.. kernel-doc:: mm/slab.h
> > +.. kernel-doc:: mm/slub.c
> 
> mm/slab_common.c also has some kernel docs, should we add it too?
> 
> > +   :internal:

We already pick up the stuff that's EXPORT_SYMBOL here:

.. kernel-doc:: mm/slab_common.c
   :export:

(in core-api/mm-api.rst) and I didn't spot anything that's internal
documentation.  We can add it later if we start documenting internal
functions.


  reply	other threads:[~2025-06-17 14:17 UTC|newest]

Thread overview: 17+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2025-06-11 15:59 [PATCH v2 00/11] Various slab improvements Matthew Wilcox (Oracle)
2025-06-11 15:59 ` [PATCH v2 01/11] doc: Move SLUB documentation to the admin guide Matthew Wilcox (Oracle)
2025-06-11 15:59 ` [PATCH v2 02/11] slab: Rename slab->__page_flags to slab->flags Matthew Wilcox (Oracle)
2025-06-11 15:59 ` [PATCH v2 03/11] slab: Add SL_partial flag Matthew Wilcox (Oracle)
2025-06-11 15:59 ` [PATCH v2 04/11] slab: Add SL_pfmemalloc flag Matthew Wilcox (Oracle)
2025-06-11 15:59 ` [PATCH v2 05/11] slub: Fix a documentation build error for krealloc() Matthew Wilcox (Oracle)
2025-06-11 15:59 ` [PATCH v2 06/11] doc: Add slab internal kernel-doc Matthew Wilcox (Oracle)
2025-06-17 14:03   ` Vlastimil Babka
2025-06-17 14:16     ` Matthew Wilcox [this message]
2025-06-11 15:59 ` [PATCH v2 07/11] vmcoreinfo: Remove documentation of PG_slab and PG_hugetlb Matthew Wilcox (Oracle)
2025-06-11 15:59 ` [PATCH v2 08/11] proc: Remove mention of PG_slab Matthew Wilcox (Oracle)
2025-06-11 15:59 ` [PATCH v2 09/11] kfence: " Matthew Wilcox (Oracle)
2025-06-11 15:59 ` [PATCH v2 10/11] memcg_slabinfo: Fix use " Matthew Wilcox (Oracle)
2025-06-11 15:59 ` [PATCH v2 11/11] slab: Update MAINTAINERS entry Matthew Wilcox (Oracle)
2025-06-15 21:51   ` David Rientjes
2025-06-16  7:24   ` Harry Yoo
2025-06-23 12:28 ` [PATCH v2 00/11] Various slab improvements Vlastimil Babka

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=aFF41KSWUoHPahrD@casper.infradead.org \
    --to=willy@infradead.org \
    --cc=cl@gentwo.org \
    --cc=harry.yoo@oracle.com \
    --cc=linux-mm@kvack.org \
    --cc=rientjes@google.com \
    --cc=roman.gushchin@linux.dev \
    --cc=vbabka@suse.cz \
    /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