History

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.

Randy Dunlap committed 1 year ago

Commit 331843c1 parent b1a529b2 files · +6 −6Browse files

Unified · Split

2 files
  1. include/linux/scatterlist.h +2 −2
  2. lib/scatterlist.c +4 −4
include/linux/scatterlist.h+2−2
@@ -99,7 +99,7 @@ static inline bool sg_is_last(struct scatterlist *sg) · 98 unmodified lines
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, · 148 unmodified lines
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+4−4
@@ -73,9 +73,9 @@ EXPORT_SYMBOL(sg_nents_for_len); · 72 unmodified lines
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); · 263 unmodified lines
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 **/