Skip to content

Commit 331843c

Browse files
rddunlapakpm00
authored andcommitted
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/[email protected] Link: https://lore.kernel.org/linux-doc/[email protected]/T/#m5d2bd9d21fb34f297aa4e7db069f09bc27b89007 [1] Fixes: 0db9299 ("SG: Move functions to lib/scatterlist.c and add sg chaining allocator helpers") Fixes: 8d1d4b5 ("scatterlist: inline sg_next()") Fixes: 18dabf4 ("Change table chaining layout") Signed-off-by: Randy Dunlap <[email protected]> Reviewed-by: Matthew Wilcox (Oracle) <[email protected]> Signed-off-by: Andrew Morton <[email protected]>
1 parent b1a529b commit 331843c

File tree

2 files changed

+6
-6
lines changed

2 files changed

+6
-6
lines changed

include/linux/scatterlist.h

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -99,7 +99,7 @@ static inline bool sg_is_last(struct scatterlist *sg)
9999
* @sg: The current sg entry
100100
*
101101
* 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
103103
* of a chained scatterlist, it could jump to the start of a new
104104
* scatterlist array.
105105
*
@@ -254,7 +254,7 @@ static inline void __sg_chain(struct scatterlist *chain_sg,
254254
* @sgl: Second scatterlist
255255
*
256256
* Description:
257-
* Links @prv@ and @sgl@ together, to form a longer scatterlist.
257+
* Links @prv and @sgl together, to form a longer scatterlist.
258258
*
259259
**/
260260
static inline void sg_chain(struct scatterlist *prv, unsigned int prv_nents,

lib/scatterlist.c

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -73,9 +73,9 @@ EXPORT_SYMBOL(sg_nents_for_len);
7373
* Should only be used casually, it (currently) scans the entire list
7474
* to get the last entry.
7575
*
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.
7979
*
8080
**/
8181
struct scatterlist *sg_last(struct scatterlist *sgl, unsigned int nents)
@@ -345,7 +345,7 @@ EXPORT_SYMBOL(__sg_alloc_table);
345345
* @gfp_mask: GFP allocation mask
346346
*
347347
* 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
349349
* SG_MAX_SINGLE_ALLOC a chained sg table will be setup.
350350
*
351351
**/

0 commit comments

Comments
 (0)