Messages in this thread Patch in this message | | | Date | Tue, 11 Jan 2011 15:55:11 -0800 | From | Andrew Morton <> | Subject | Re: [PATCH 1/4] scatterlist: new helper functions |
| |
On Tue, 11 Jan 2011 15:51:24 -0800 Randy Dunlap <rdunlap@xenotime.net> wrote:
> > /** > > + * sg_advance - advance scatterlist by 'consumed' bytes > > + * @sg - the current sg entry > > + * @consumed - how much bytes to advance > > kernel-doc notation for parameters is like so:
I think I fixed most of this. Probably missed some though.
Teach checkpatch to check kerneldoc ;)
From: Andrew Morton <akpm@linux-foundation.org>
fix general disaster in code comments
Cc: Alex Dubov <oakad@yahoo.com> Cc: James Bottomley <James.Bottomley@HansenPartnership.com> Cc: Jens Axboe <axboe@kernel.dk> Cc: Maxim Levitsky <maximlevitsky@gmail.com> Cc: Tejun Heo <tj@kernel.org> Signed-off-by: Andrew Morton <akpm@linux-foundation.org> ---
lib/scatterlist.c | 31 ++++++++++++++++++------------- 1 file changed, 18 insertions(+), 13 deletions(-)
diff -puN lib/scatterlist.c~scatterlist-new-helper-functions-fix lib/scatterlist.c --- a/lib/scatterlist.c~scatterlist-new-helper-functions-fix +++ a/lib/scatterlist.c @@ -41,7 +41,7 @@ EXPORT_SYMBOL(sg_next); /** * sg_advance - advance scatterlist by 'consumed' bytes * @sg - the current sg entry - * @consumed - how much bytes to advance + * @consumed - how many bytes to advance * */ struct scatterlist *sg_advance(struct scatterlist *sg, int consumed) @@ -76,8 +76,8 @@ EXPORT_SYMBOL(sg_advance); * sg_nents - calculate number of sg entries in sg list * @sg - the current sg entry * - * Allows to calculate dynamicly the lenght of the sg table, based on - * assumption that last entry is NULL + * Allows to calculate aldynamicly the length of the sg table, based on an + * assumption that the last entry is NULL */ int sg_nents(struct scatterlist *sg) { @@ -92,11 +92,11 @@ int sg_nents(struct scatterlist *sg) EXPORT_SYMBOL(sg_nents); /** - * sg_total_len - calculate total lenght of scatterlist + * sg_total_len - calculate total length of scatterlist * @sg - the current sg entry * - * Dynamicly calculate total number of bytes in a sg list - * based on assumption that list ends with a NULL entry + * Dynamically calculate total number of bytes in a sg list + * based on an assumption that the list ends with a NULL entry */ int sg_total_len(struct scatterlist *sg) { @@ -182,8 +182,14 @@ void sg_init_one(struct scatterlist *sg, EXPORT_SYMBOL(sg_init_one); /** - * sg_copy - copies sg entries from sg_from to sg_to, such - * as sg_to covers first 'len' bytes from sg_from. + * sg_copy - copy sg entries + * @sg_from: source + * @sg_to: destination + * + * Copies from @sg_from to @sg_to. @sg_to covers first 'len' bytes from + * @sg_from. + * + * Returns zero on success, else a -ve errno. */ int sg_copy(struct scatterlist *sg_from, struct scatterlist *sg_to, int len) { @@ -616,13 +622,12 @@ size_t sg_copy_to_buffer(struct scatterl } EXPORT_SYMBOL(sg_copy_to_buffer); - /** - * sg_compare_to_buffer - compare contents of the data pointeted by sg table + * sg_compare_to_buffer - compare contents of the data covered by an sg table * to a kernel ram buffer - * @sg - the current sg entry - * @buffer - linear buffer to compare with - * @len - lenght of that buffer + * @sg: the current sg entry + * @buffer: linear buffer to compare with + * @len: length of that buffer */ bool sg_compare_to_buffer(struct scatterlist *sg, u8 *buffer, size_t len) { _
| |