Re: [PATCH] kernel-doc: Fix symbol matching for dropped suffixes

[Jonathan Corbet <corbet@lwn.net>]

Matthew Wilcox <willy@infradead.org> writes:

>> I've applied this.  Naturally, it gifts us with a new docs build
>> warning:
>> 
>> > Documentation/core-api/mm-api:40: ./mm/slub.c:4936: WARNING: Block quote ends without a blank line; unexpected unindent. [docutils]
>> > Documentation/core-api/mm-api:40: ./mm/slub.c:4936: ERROR: Undefined substitution referenced: "--------". [docutils]
>> 
>> I was hoping your other slab patch series address this, but it doesn't
>> look that way...?
>
> Indeed it does.
>
> It's a pre-existing bug, that's only unmaked by this patch.

I knew that, that's why I hoped the other series maybe addressed it. 

> Honestly,
> I'm not that great at kerneldoc and I was hoping someone like Randy
> would notice and fix it ;-)

The attached fixes it, but may conflict with your other work.

jon

From 6b3b23e49b57a377716870bc752b884f324ad342 Mon Sep 17 00:00:00 2001
From: Jonathan Corbet <corbet@lwn.net>
Date: Mon, 9 Jun 2025 15:05:46 -0600
Subject: [PATCH] mm: slub: Fix a documentation build error for kerealloc()

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

  Documentation/core-api/mm-api:40: ./mm/slub.c:4936: WARNING: Block quote ends without a blank line; unexpected unindent. [docutils]
  Documentation/core-api/mm-api:40: ./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.

Signed-off-by: Jonathan Corbet <corbet@lwn.net>
---
 mm/slub.c | 10 +++++-----
 1 file changed, 5 insertions(+), 5 deletions(-)

diff --git a/mm/slub.c b/mm/slub.c
index 31e11ef256f9..45a963e363d3 100644
--- a/mm/slub.c
+++ b/mm/slub.c
@@ -4930,12 +4930,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.49.0