Skip to contentSkip to conversation

lib/scatterlist: fix kerneldoc for sg_pcopy_{to,from}_buffer()

PATCH In review Dave Gordon 2 participants 2 messages Apr 23, 2015 Library code

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 lib/scatterlist: 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 <[email protected]>
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.

---
 lib/scatterlist.c |    4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)
lib/scatterlist.c +2 -2
index c9f2e8c..233ebe7 100644
@@ -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.
  *
Signature · 1 line
1.7.9.5
Reviewed-by on v1 1/1
#1 lore raw

2015-04-23 22:57 GMT+09:00 Dave Gordon <[email protected]>:

Quoted 10 lines

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 <[email protected]>
Date: Mon Jul 8 16:01:54 2013 -0700

Quoted 4 lines

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.

Thanks for fixing this.