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

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: default avatarRandy Dunlap <rdunlap@infradead.org>
Signed-off-by: default avatarAndrew Morton <akpm@linux-foundation.org>
parent 9d1be94d

lib/scatterlist.c

+3 −1
Original line number Diff line number Diff line
@@ -265,7 +265,8 @@ EXPORT_SYMBOL(sg_free_table); 
 * @table:	The sg table header to use

 * @nents:	Number of entries in sg list

 * @max_ents:	The maximum number of entries the allocator returns per call

 * @nents_first_chunk: Number of entries int the (preallocated) first

 * @first_chunk: first SGL if preallocated (may be %NULL)

 * @nents_first_chunk: Number of entries in the (preallocated) first

 * 	scatterlist chunk, 0 means no such preallocated chunk provided by user

 * @gfp_mask:	GFP allocation mask

 * @alloc_fn:	Allocator to use
@@ -788,6 +789,7 @@ EXPORT_SYMBOL(__sg_page_iter_dma_next); 
 * @miter: sg mapping iter to be started

 * @sgl: sg list to iterate over

 * @nents: number of sg entries

 * @flags: sg iterator flags

 *

 * Description:

 *   Starts mapping iterator @miter.