mm kernel-doc fixes
Subsystems (5)
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
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.
--- include/linux/sched/mm.h | 1 + 1 file changed, 1 insertion(+)
include/linux/sched/mm.h +1 -0
@@ -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
PATCH 2/4 textsearch: Describe @list member in ts_ops search
In reply to Bagas SanjayaSphinx reports kernel-doc warning:
WARNING: ./include/linux/textsearch.h:49 struct member 'list' not described in 'ts_ops'
Describe @list member to fix it.
--- include/linux/textsearch.h | 1 + 1 file changed, 1 insertion(+)
include/linux/textsearch.h +1 -0
@@ -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
PATCH 3/4 mm: vmalloc: Fix up vrealloc_node_align() kernel-doc macro name
In reply to Bagas SanjayaSphinx 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.
--- mm/vmalloc.c | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)
mm/vmalloc.c +1 -1
@@ -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
PATCH 4/4 mm, kfence: Describe @slab parameter in __kfence_obj_info()
In reply to Bagas SanjayaSphinx 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.
--- include/linux/kfence.h | 1 + 1 file changed, 1 insertion(+)
include/linux/kfence.h +1 -0
@@ -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