summaryrefslogtreecommitdiff
path: root/lib
diff options
context:
space:
mode:
authorDave Gordon <david.s.gordon@intel.com>2015-07-01 00:58:52 +0300
committerLinus Torvalds <torvalds@linux-foundation.org>2015-07-01 05:44:59 +0300
commit4dc7daf843f3914c9c0c7efb71b8f251c9c4636f (patch)
tree6ab6ea607b24bbeab8beb8e4ef562f991b418a12 /lib
parent6157dbbfbf9d8e4a2b6d4e5ee35e864ab9ee8414 (diff)
downloadlinux-4dc7daf843f3914c9c0c7efb71b8f251c9c4636f.tar.xz
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> Signed-off-by: Linus Torvalds <torvalds@linux-foundation.org>
Diffstat (limited to 'lib')
-rw-r--r--lib/scatterlist.c4
1 files changed, 2 insertions, 2 deletions
diff --git a/lib/scatterlist.c b/lib/scatterlist.c
index 99fbc2f238c4..965c36e7a5a4 100644
--- a/lib/scatterlist.c
+++ b/lib/scatterlist.c
@@ -729,8 +729,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.
*
@@ -747,8 +747,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.
*