Commit 331843c8 authored by Randy Dunlap's avatar Randy Dunlap Committed by Andrew Morton
Browse files

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: 0db9299f ("SG: Move functions to lib/scatterlist.c and add sg chaining allocator helpers")
Fixes: 8d1d4b53 ("scatterlist: inline sg_next()")
Fixes: 18dabf47 ("Change table chaining layout")
Signed-off-by: default avatarRandy Dunlap <rdunlap@infradead.org>
Reviewed-by: default avatarMatthew Wilcox (Oracle) <willy@infradead.org>
Signed-off-by: default avatarAndrew Morton <akpm@linux-foundation.org>
parent b1a529bd

include/linux/scatterlist.h

+2 −2
Original line number Diff line number Diff line
@@ -99,7 +99,7 @@ static inline bool sg_is_last(struct scatterlist *sg) 
 * @sg:		The current sg entry

 *

 * Description:

 *   Usually the next entry will be @sg@ + 1, but if this sg element is part

 *   Usually the next entry will be @sg + 1, but if this sg element is part

 *   of a chained scatterlist, it could jump to the start of a new

 *   scatterlist array.

 *
@@ -254,7 +254,7 @@ static inline void __sg_chain(struct scatterlist *chain_sg, 
 * @sgl:	Second scatterlist

 *

 * Description:

 *   Links @prv@ and @sgl@ together, to form a longer scatterlist.

 *   Links @prv and @sgl together, to form a longer scatterlist.

 *

 **/

static inline void sg_chain(struct scatterlist *prv, unsigned int prv_nents,

lib/scatterlist.c

+4 −4
Original line number Diff line number Diff line
@@ -73,9 +73,9 @@ EXPORT_SYMBOL(sg_nents_for_len); 
 *   Should only be used casually, it (currently) scans the entire list

 *   to get the last entry.

 *

 *   Note that the @sgl@ pointer passed in need not be the first one,

 *   the important bit is that @nents@ denotes the number of entries that

 *   exist from @sgl@.

 *   Note that the @sgl pointer passed in need not be the first one,

 *   the important bit is that @nents denotes the number of entries that

 *   exist from @sgl.

 *

 **/

struct scatterlist *sg_last(struct scatterlist *sgl, unsigned int nents)
@@ -345,7 +345,7 @@ EXPORT_SYMBOL(__sg_alloc_table); 
 * @gfp_mask:	GFP allocation mask

 *

 *  Description:

 *    Allocate and initialize an sg table. If @nents@ is larger than

 *    Allocate and initialize an sg table. If @nents is larger than

 *    SG_MAX_SINGLE_ALLOC a chained sg table will be setup.

 *

 **/