linux-mm.kvack.org archive mirror
 help / color / mirror / Atom feed
From: "Matthew Wilcox (Oracle)" <willy@infradead.org>
To: Vlastimil Babka <vbabka@suse.cz>
Cc: Jonathan Corbet <corbet@lwn.net>,
	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,
	"Matthew Wilcox (Oracle)" <willy@infradead.org>
Subject: [PATCH v2 05/11] slub: Fix a documentation build error for krealloc()
Date: Wed, 11 Jun 2025 16:59:08 +0100	[thread overview]
Message-ID: <20250611155916.2579160-6-willy@infradead.org> (raw)
In-Reply-To: <20250611155916.2579160-1-willy@infradead.org>

From: Jonathan Corbet <corbet@lwn.net>

The kerneldoc comment for krealloc() contains an unmarked literal block,
leading to these warnings in the docs build:

  ./mm/slub.c:4936: WARNING: Block quote ends without a blank line; unexpected unindent. [docutils]
  ./mm/slub.c:4936: ERROR: Undefined substitution referenced: "--------". [docutils]

Mark up and indent the block properly to bring a bit of peace to our build
logs.

Fixes: 489a744e5fb1 (mm: krealloc: clarify valid usage of __GFP_ZERO)
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Signed-off-by: Matthew Wilcox (Oracle) <willy@infradead.org>
---
 mm/slub.c | 10 +++++-----
 1 file changed, 5 insertions(+), 5 deletions(-)

diff --git a/mm/slub.c b/mm/slub.c
index 8a1df2ad26ed..c49d820a12f9 100644
--- a/mm/slub.c
+++ b/mm/slub.c
@@ -4961,12 +4961,12 @@ __do_krealloc(const void *p, size_t new_size, gfp_t flags)
  * When slub_debug_orig_size() is off, krealloc() only knows about the bucket
  * size of an allocation (but not the exact size it was allocated with) and
  * hence implements the following semantics for shrinking and growing buffers
- * with __GFP_ZERO.
+ * with __GFP_ZERO::
  *
- *         new             bucket
- * 0       size             size
- * |--------|----------------|
- * |  keep  |      zero      |
+ *           new             bucket
+ *   0       size             size
+ *   |--------|----------------|
+ *   |  keep  |      zero      |
  *
  * Otherwise, the original allocation size 'orig_size' could be used to
  * precisely clear the requested size, and the new size will also be stored
-- 
2.47.2



  parent reply	other threads:[~2025-06-11 16:24 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 ` Matthew Wilcox (Oracle) [this message]
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
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=20250611155916.2579160-6-willy@infradead.org \
    --to=willy@infradead.org \
    --cc=cl@gentwo.org \
    --cc=corbet@lwn.net \
    --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;
as well as URLs for NNTP newsgroup(s).