lkml.org 
[lkml]   [2012]   [Jul]   [19]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
 
Messages in this thread
/
Date
From
SubjectRe: [PATCH 2/2] cpumask: cpumask_scnprintf() comments correction
On 07/16/2012 04:29 PM, Alex Shi wrote:

> On 07/16/2012 03:40 PM, Rusty Russell wrote:
>
>> On Mon, 16 Jul 2012 10:35:54 +0800, Alex Shi <alex.shi@intel.com> wrote:
>>> The function has no parameter @len now, so need to remove it from
>>> comments to avoid kernel-doc warning:
>>
>> But it still does in my tree.
>>
>> Please push this patch via whoever changed it?
>>
>> Acked-by: Rusty Russell <rusty@rustcorp.com.au>
>>
>
> Sorry, my fault, the commit log used a wrong function name, it is cpulist_parse()
> not cpumask_scnprntf. and find a new error in the comments: used a incorrect
> function name: cpulist_parse_user(), the correct one is cpulist_parse().
> Fix it in updated patch.
>
> Both errors appear in Rusty's commit 29c0177e6a4.


Rusty. The error still exist on upstream tree. Would you like to pick
this fix?

>
> ===
>
> From db20433a0b321f7b4edfc57f66e816d7bec81b14 Mon Sep 17 00:00:00 2001
> From: Alex Shi <alex.shi@intel.com>
> Date: Mon, 16 Jul 2012 10:25:06 +0800
> Subject: [PATCH] cpumask: cpulist_parse() comments correction
>
> The function has no parameter @len, so need to remove it from
> comments to avoid kernel-doc warning:
>
> alexs@debian:~/linux-next$ scripts/kernel-doc -man
> include/linux/cpumask.h | split-man.pl /tmp/man
> ....
> Warning(include/linux/cpumask.h:602): Excess function parameter 'len'
> description in 'cpulist_parse'
>
> and correct the function name in comments to cpulist_parse.
>
> Signed-off-by: Alex Shi <alex.shi@intel.com>
> ---
> include/linux/cpumask.h | 3 +--
> 1 files changed, 1 insertions(+), 2 deletions(-)
>
> diff --git a/include/linux/cpumask.h b/include/linux/cpumask.h
> index 8bf1c27..0325602 100644
> --- a/include/linux/cpumask.h
> +++ b/include/linux/cpumask.h
> @@ -591,9 +591,8 @@ static inline int cpulist_scnprintf(char *buf, int len,
> }
>
> /**
> - * cpulist_parse_user - extract a cpumask from a user string of ranges
> + * cpulist_parse - extract a cpumask from a user string of ranges
> * @buf: the buffer to extract from
> - * @len: the length of the buffer
> * @dstp: the cpumask to set.
> *
> * Returns -errno, or 0 for success.




\
 
 \ /
  Last update: 2012-07-20 04:41    [W:0.057 / U:0.324 seconds]
©2003-2020 Jasper Spaans|hosted at Digital Ocean and TransIP|Read the blog|Advertise on this site