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

scatterlist: add missing function params to kernel-doc

Describe missing function parameters to prevent kernel-doc warnings:

lib/scatterlist.c:288: warning: Function parameter or member 'first_chunk' not described in '__sg_alloc_table'
lib/scatterlist.c:800: warning: Function parameter or member 'flags' not described in 'sg_miter_start'

Link: https://lkml.kernel.org/r/20230912060848.4673-1-rdunlap@infradead.org
Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Signed-off-by: Andrew Morton <akpm@linux-foundation.org>

authored by

Randy Dunlap and committed by
Andrew Morton
c80da1fb 9d1be94d

+3 -1
+3 -1
lib/scatterlist.c
··· 265 265 * @table: The sg table header to use 266 266 * @nents: Number of entries in sg list 267 267 * @max_ents: The maximum number of entries the allocator returns per call 268 - * @nents_first_chunk: Number of entries int the (preallocated) first 268 + * @first_chunk: first SGL if preallocated (may be %NULL) 269 + * @nents_first_chunk: Number of entries in the (preallocated) first 269 270 * scatterlist chunk, 0 means no such preallocated chunk provided by user 270 271 * @gfp_mask: GFP allocation mask 271 272 * @alloc_fn: Allocator to use ··· 789 788 * @miter: sg mapping iter to be started 790 789 * @sgl: sg list to iterate over 791 790 * @nents: number of sg entries 791 + * @flags: sg iterator flags 792 792 * 793 793 * Description: 794 794 * Starts mapping iterator @miter.