diff options
| author | Dave Gordon <david.s.gordon@intel.com> | 2015-06-05 15:03:53 +1000 |
|---|---|---|
| committer | Michael Ellerman <mpe@ellerman.id.au> | 2015-06-05 15:03:53 +1000 |
| commit | b4ef9923c8ab532480e660bde8b8e48abd43c43f (patch) | |
| tree | 69b6242e1c72229b19199041025f0175e70760e2 | |
| parent | d34aed8bb2c4e293158831919190deccb3491ca8 (diff) | |
| download | linux-next-b4ef9923c8ab532480e660bde8b8e48abd43c43f.tar.gz | |
lib/scatterlist.c: fix kerneldoc for sg_pcopy_{to,from}_buffer()
The kerneldoc for the functions doesn't match the code; the last two
parameters (buflen, skip) have been transposed, which is confusing,
especially as they're both integral types and the compiler won't warn
about swapping them.
These functions and the kerneldoc were introduced in commit:
df642cea lib/scatterlist: introduce sg_pcopy_from_buffer() ...
Author: Akinobu Mita <akinobu.mita@gmail.com>
Date: Mon Jul 8 16:01:54 2013 -0700
The only difference between sg_pcopy_{from,to}_buffer() and
sg_copy_{from,to}_buffer() is an additional argument that
specifies the number of bytes to skip the SG list before
copying.
The functions have the extra argument at the end, but the kerneldoc
lists it in penultimate position.
Signed-off-by: Dave Gordon <david.s.gordon@intel.com>
Reviewed-by: Akinobu Mita <akinobu.mita@gmail.com>
Cc: "Martin K. Petersen" <martin.petersen@oracle.com>
Signed-off-by: Andrew Morton <akpm@linux-foundation.org>
| -rw-r--r-- | lib/scatterlist.c | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/lib/scatterlist.c b/lib/scatterlist.c index c9f2e8c6ccc996..233ebe70e6bee6 100644 --- a/lib/scatterlist.c +++ b/lib/scatterlist.c @@ -697,8 +697,8 @@ EXPORT_SYMBOL(sg_copy_to_buffer); * @sgl: The SG list * @nents: Number of SG entries * @buf: Where to copy from - * @skip: Number of bytes to skip before copying * @buflen: The number of bytes to copy + * @skip: Number of bytes to skip before copying * * Returns the number of copied bytes. * @@ -715,8 +715,8 @@ EXPORT_SYMBOL(sg_pcopy_from_buffer); * @sgl: The SG list * @nents: Number of SG entries * @buf: Where to copy to - * @skip: Number of bytes to skip before copying * @buflen: The number of bytes to copy + * @skip: Number of bytes to skip before copying * * Returns the number of copied bytes. * |