Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

scatterlist: fix extraneous '@'-sign kernel-doc notation

Using "@argname@" in kernel-doc produces "argname****" (with "argname" in
bold) in the generated html output, so use the expected kernel-doc
notation of just "@argname" instead.

"Fixes:" lines are added in case Matthew's patch [1] is backported.

Link: https://lkml.kernel.org/r/20250605002337.2842659-1-rdunlap@infradead.org
Link: https://lore.kernel.org/linux-doc/3bc4e779-7a79-42c1-8867-024f643a22fc@infradead.org/T/#m5d2bd9d21fb34f297aa4e7db069f09bc27b89007 [1]
Fixes: 0db9299f48eb ("SG: Move functions to lib/scatterlist.c and add sg chaining allocator helpers")
Fixes: 8d1d4b538bb1 ("scatterlist: inline sg_next()")
Fixes: 18dabf473e15 ("Change table chaining layout")
Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Reviewed-by: Matthew Wilcox (Oracle) <willy@infradead.org>
Signed-off-by: Andrew Morton <akpm@linux-foundation.org>

authored by

Randy Dunlap and committed by
Andrew Morton
331843c8 b1a529bd

+6 -6
+2 -2
include/linux/scatterlist.h
··· 99 99 * @sg: The current sg entry 100 100 * 101 101 * Description: 102 - * Usually the next entry will be @sg@ + 1, but if this sg element is part 102 + * Usually the next entry will be @sg + 1, but if this sg element is part 103 103 * of a chained scatterlist, it could jump to the start of a new 104 104 * scatterlist array. 105 105 * ··· 254 254 * @sgl: Second scatterlist 255 255 * 256 256 * Description: 257 - * Links @prv@ and @sgl@ together, to form a longer scatterlist. 257 + * Links @prv and @sgl together, to form a longer scatterlist. 258 258 * 259 259 **/ 260 260 static inline void sg_chain(struct scatterlist *prv, unsigned int prv_nents,
+4 -4
lib/scatterlist.c
··· 73 73 * Should only be used casually, it (currently) scans the entire list 74 74 * to get the last entry. 75 75 * 76 - * Note that the @sgl@ pointer passed in need not be the first one, 77 - * the important bit is that @nents@ denotes the number of entries that 78 - * exist from @sgl@. 76 + * Note that the @sgl pointer passed in need not be the first one, 77 + * the important bit is that @nents denotes the number of entries that 78 + * exist from @sgl. 79 79 * 80 80 **/ 81 81 struct scatterlist *sg_last(struct scatterlist *sgl, unsigned int nents) ··· 345 345 * @gfp_mask: GFP allocation mask 346 346 * 347 347 * Description: 348 - * Allocate and initialize an sg table. If @nents@ is larger than 348 + * Allocate and initialize an sg table. If @nents is larger than 349 349 * SG_MAX_SINGLE_ALLOC a chained sg table will be setup. 350 350 * 351 351 **/