[Intel-gfx] [PATCH] lib/scatterlist: fix kerneldoc for sg_pcopy_{to, from}_buffer()
Jani Nikula
jani.nikula at linux.intel.com
Wed Apr 22 15:13:04 PDT 2015
On Wed, 22 Apr 2015, Dave Gordon <david.s.gordon at 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 at 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 at 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 at lists.freedesktop.org
> http://lists.freedesktop.org/mailman/listinfo/intel-gfx
--
Jani Nikula, Intel Open Source Technology Center
More information about the Intel-gfx
mailing list