]> git.proxmox.com Git - mirror_ubuntu-artful-kernel.git/commitdiff
lib/scatterlist.c: fix kerneldoc for sg_pcopy_{to,from}_buffer()
authorDave Gordon <david.s.gordon@intel.com>
Tue, 30 Jun 2015 21:58:52 +0000 (14:58 -0700)
committerLinus Torvalds <torvalds@linux-foundation.org>
Wed, 1 Jul 2015 02:44:59 +0000 (19:44 -0700)
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>
lib/scatterlist.c

index 99fbc2f238c4976a1b95df715d22d35f739b4cc7..965c36e7a5a46ae85cc3638c82d5d8fcd0c983ae 100644 (file)
@@ -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.
  *