* [PATCH 2/2] cpumask: cpumask_scnprintf() comments correction
@ 2012-07-16 2:35 Alex Shi
2012-07-16 7:40 ` Rusty Russell
0 siblings, 1 reply; 5+ messages in thread
From: Alex Shi @ 2012-07-16 2:35 UTC (permalink / raw)
To: rusty, kosaki.motohiro; +Cc: alex.shi, akpm, paul.gortmaker, linux-kernel
The function has no parameter @len now, 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
....
Creating /tmp/man/cpumask_scnprintf.9
Warning(include/linux/cpumask.h:602): Excess function parameter 'len'
description in 'cpulist_parse'
Signed-off-by: Alex Shi <alex.shi@intel.com>
---
include/linux/cpumask.h | 1 -
1 files changed, 0 insertions(+), 1 deletions(-)
diff --git a/include/linux/cpumask.h b/include/linux/cpumask.h
index 8bf1c27..5bad959 100644
--- a/include/linux/cpumask.h
+++ b/include/linux/cpumask.h
@@ -593,7 +593,6 @@ static inline int cpulist_scnprintf(char *buf, int len,
/**
* cpulist_parse_user - 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.
--
1.7.5.4
^ permalink raw reply related [flat|nested] 5+ messages in thread
* Re: [PATCH 2/2] cpumask: cpumask_scnprintf() comments correction
2012-07-16 2:35 [PATCH 2/2] cpumask: cpumask_scnprintf() comments correction Alex Shi
@ 2012-07-16 7:40 ` Rusty Russell
2012-07-16 8:29 ` Alex Shi
0 siblings, 1 reply; 5+ messages in thread
From: Rusty Russell @ 2012-07-16 7:40 UTC (permalink / raw)
To: Alex Shi, kosaki.motohiro; +Cc: alex.shi, akpm, paul.gortmaker, linux-kernel
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>
Thanks,
Rusty.
^ permalink raw reply [flat|nested] 5+ messages in thread
* Re: [PATCH 2/2] cpumask: cpumask_scnprintf() comments correction
2012-07-16 7:40 ` Rusty Russell
@ 2012-07-16 8:29 ` Alex Shi
2012-07-20 1:54 ` Alex Shi
2012-07-20 6:16 ` Rusty Russell
0 siblings, 2 replies; 5+ messages in thread
From: Alex Shi @ 2012-07-16 8:29 UTC (permalink / raw)
To: Rusty Russell; +Cc: kosaki.motohiro, akpm, paul.gortmaker, linux-kernel
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.
===
>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.
--
1.7.5.4
^ permalink raw reply related [flat|nested] 5+ messages in thread
* Re: [PATCH 2/2] cpumask: cpumask_scnprintf() comments correction
2012-07-16 8:29 ` Alex Shi
@ 2012-07-20 1:54 ` Alex Shi
2012-07-20 6:16 ` Rusty Russell
1 sibling, 0 replies; 5+ messages in thread
From: Alex Shi @ 2012-07-20 1:54 UTC (permalink / raw)
To: Rusty Russell; +Cc: kosaki.motohiro, akpm, paul.gortmaker, linux-kernel
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.
^ permalink raw reply [flat|nested] 5+ messages in thread
* Re: [PATCH 2/2] cpumask: cpumask_scnprintf() comments correction
2012-07-16 8:29 ` Alex Shi
2012-07-20 1:54 ` Alex Shi
@ 2012-07-20 6:16 ` Rusty Russell
1 sibling, 0 replies; 5+ messages in thread
From: Rusty Russell @ 2012-07-20 6:16 UTC (permalink / raw)
To: Alex Shi; +Cc: kosaki.motohiro, akpm, paul.gortmaker, linux-kernel
On Mon, 16 Jul 2012 16:29:24 +0800, Alex Shi <alex.shi@intel.com> 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.
OK, I put this last line in the commit message, see below.
Thanks!
Rusty.
From: Alex Shi <alex.shi@intel.com>
Date: Mon, 16 Jul 2012 10:25:06 +0800
Subject: [PATCH] cpumask: cpulist_parse() comments correction
As introduced in Rusty's commit 29c0177e6a4, 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>
Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
---
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.
^ permalink raw reply related [flat|nested] 5+ messages in thread
end of thread, other threads:[~2012-07-22 22:37 UTC | newest]
Thread overview: 5+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2012-07-16 2:35 [PATCH 2/2] cpumask: cpumask_scnprintf() comments correction Alex Shi
2012-07-16 7:40 ` Rusty Russell
2012-07-16 8:29 ` Alex Shi
2012-07-20 1:54 ` Alex Shi
2012-07-20 6:16 ` Rusty Russell
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).