Skip to contentSkip to conversation

mm kernel-doc fixes

PATCH Applied Bagas Sanjaya 1 participant 5 messages Dec 19, 2025

Subsystems (5)
lore
Share & tools
lore
#0 lore raw

cover mm kernel-doc fixes

Hi,

Here are kernel-doc fixes for mm subsystem, based on mm-hotfixes-unstable branch. This series is split from previous assorted kernel-doc fixes series
[1] with review trailers applied.

I'm also including textsearch fix since there's currently no maintainer for include/linux/textsearch.h (get_maintainer.pl only shows LKML).

Enjoy!

[1]: https://lore.kernel.org/linux-fsdevel/[email protected]/

Bagas Sanjaya (4):
mm: Describe @flags parameter in memalloc_flags_save()
textsearch: Describe @list member in ts_ops search
mm: vmalloc: Fix up vrealloc_node_align() kernel-doc macro name mm, kfence: Describe @slab parameter in __kfence_obj_info()

 include/linux/kfence.h     | 1 +
 include/linux/sched/mm.h   | 1 +
 include/linux/textsearch.h | 1 +
 mm/vmalloc.c               | 2 +-
 4 files changed, 4 insertions(+), 1 deletion(-)

base-commit: 980dbceadd50af9437257d8095d4a3606818e8c4

Signature · 1 line
An old man doll... just what I always wanted! - Clara
#1 lore raw

PATCH 1/4 mm: Describe @flags parameter in memalloc_flags_save()

Sphinx reports kernel-doc warning:

WARNING: ./include/linux/sched/mm.h:332 function parameter 'flags' not described in 'memalloc_flags_save'

Describe @flags to fix it.

Fixes 3f6d5e6a468d02 ("mm: introduce memalloc_flags_{save,restore}")
---
 include/linux/sched/mm.h | 1 +
 1 file changed, 1 insertion(+)
include/linux/sched/mm.h +1 -0
index 0e1d73955fa511..95d0040df58413 100644
@@ -325,6 +325,7 @@ static inline void might_alloc(gfp_t gfp_mask)
 
 /**
  * memalloc_flags_save - Add a PF_* flag to current->flags, save old value
+ * @flags: Flags to add.
  *
  * This allows PF_* flags to be conveniently added, irrespective of current
  * value, and then the old version restored with memalloc_flags_restore().
Signature · 1 line
An old man doll... just what I always wanted! - Clara
#2 lore raw

PATCH 2/4 textsearch: Describe @list member in ts_ops search

In reply to Bagas Sanjaya

Sphinx reports kernel-doc warning:

WARNING: ./include/linux/textsearch.h:49 struct member 'list' not described in 'ts_ops'

Describe @list member to fix it.

Cc Thomas Graf <[email protected]>
Cc "David S. Miller" <[email protected]>
Fixes 2de4ff7bd658c9 ("[LIB]: Textsearch infrastructure.")
---
 include/linux/textsearch.h | 1 +
 1 file changed, 1 insertion(+)
include/linux/textsearch.h +1 -0
index 6673e4d4ac2e1b..4933777404d618 100644
@@ -35,6 +35,7 @@ struct ts_state
  * @get_pattern: return head of pattern
  * @get_pattern_len: return length of pattern
  * @owner: module reference to algorithm
+ * @list: list to search
  */
 struct ts_ops
 {
Signature · 1 line
An old man doll... just what I always wanted! - Clara
#3 lore raw

PATCH 3/4 mm: vmalloc: Fix up vrealloc_node_align() kernel-doc macro name

In reply to Bagas Sanjaya

Sphinx reports kernel-doc warning:

WARNING: ./mm/vmalloc.c:4284 expecting prototype for vrealloc_node_align_noprof(). Prototype was for vrealloc_node_align() instead

Fix the macro name in vrealloc_node_align_noprof() kernel-doc comment.

Fixes 4c5d3365882dbb ("mm/vmalloc: allow to set node and align in vrealloc")
---
 mm/vmalloc.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
mm/vmalloc.c +1 -1
index 41dd01e8430c54..628f96e83b1187 100644
@@ -4248,7 +4248,7 @@ void *vzalloc_node_noprof(unsigned long size, int node)
 EXPORT_SYMBOL(vzalloc_node_noprof);
 
 /**
- * vrealloc_node_align_noprof - reallocate virtually contiguous memory; contents
+ * vrealloc_node_align - reallocate virtually contiguous memory; contents
  * remain unchanged
  * @p: object to reallocate memory for
  * @size: the size to reallocate
Signature · 1 line
An old man doll... just what I always wanted! - Clara
#4 lore raw

PATCH 4/4 mm, kfence: Describe @slab parameter in __kfence_obj_info()

In reply to Bagas Sanjaya

Sphinx reports kernel-doc warning:

WARNING: ./include/linux/kfence.h:220 function parameter 'slab' not described in '__kfence_obj_info'

Fix it by describing @slab parameter.

Fixes 2dfe63e61cc31e ("mm, kfence: support kmem_dump_obj() for KFENCE objects")
---
 include/linux/kfence.h | 1 +
 1 file changed, 1 insertion(+)
include/linux/kfence.h +1 -0
index 0ad1ddbb8b996a..e5822f6e7f2794 100644
@@ -211,6 +211,7 @@ struct kmem_obj_info;
  * __kfence_obj_info() - fill kmem_obj_info struct
  * @kpp: kmem_obj_info to be filled
  * @object: the object
+ * @slab: the slab
  *
  * Return:
  * * false - not a KFENCE object
Signature · 1 line
An old man doll... just what I always wanted! - Clara