diff mbox

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

Message ID 1429702249-4065-1-git-send-email-david.s.gordon@intel.com (mailing list archive)
State New, archived
Headers show

Commit Message

Dave Gordon April 22, 2015, 11:30 a.m. UTC
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>
---
 lib/scatterlist.c |    4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

Comments

Shuang He April 22, 2015, 3:01 p.m. UTC | #1
Tested-By: Intel Graphics QA PRTS (Patch Regression Test System Contact: shuang.he@intel.com)
Task id: 6247
-------------------------------------Summary-------------------------------------
Platform          Delta          drm-intel-nightly          Series Applied
PNV                                  276/276              276/276
ILK                                  302/302              302/302
SNB                                  318/318              318/318
IVB                                  341/341              341/341
BYT                                  287/287              287/287
BDW                                  318/318              318/318
-------------------------------------Detailed-------------------------------------
Platform  Test                                drm-intel-nightly          Series Applied
Note: You need to pay more attention to line start with '*'
Jani Nikula April 22, 2015, 10:13 p.m. UTC | #2
On Wed, 22 Apr 2015, Dave Gordon <david.s.gordon@intel.com> wrote:
> 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.

Please run 'scripts/get_maintainer.pl -f lib/scatterlist.c' to get a
list of people/lists to send your patch to. Not much we can do on
intel-gfx.

BR,
Jani.


>
> Signed-off-by: Dave Gordon <david.s.gordon@intel.com>
> ---
>  lib/scatterlist.c |    4 ++--
>  1 file changed, 2 insertions(+), 2 deletions(-)
>
> diff --git a/lib/scatterlist.c b/lib/scatterlist.c
> index c9f2e8c..233ebe7 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.
>   *
> -- 
> 1.7.9.5
>
> _______________________________________________
> Intel-gfx mailing list
> Intel-gfx@lists.freedesktop.org
> http://lists.freedesktop.org/mailman/listinfo/intel-gfx
diff mbox

Patch

diff --git a/lib/scatterlist.c b/lib/scatterlist.c
index c9f2e8c..233ebe7 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.
  *