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

Showing the changes to include/linux (1 of 2 files). Show all

Unified · Split

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,