* [PATCH] signal.c: fix kernel-doc warning
@ 2011-05-26 2:28 Randy Dunlap
2011-05-26 2:58 ` Harry Wei
2011-05-26 14:45 ` Oleg Nesterov
0 siblings, 2 replies; 5+ messages in thread
From: Randy Dunlap @ 2011-05-26 2:28 UTC (permalink / raw)
To: lkml; +Cc: Oleg Nesterov, Ingo Molnar, akpm
From: Randy Dunlap <randy.dunlap@oracle.com>
Fix kernel-doc warnings in signal.c:
Warning(kernel/signal.c:2374): No description found for parameter 'nset'
Warning(kernel/signal.c:2374): Excess function parameter 'set' description in 'sys_rt_sigprocmask'
Signed-off-by: Randy Dunlap <randy.dunlap@oracle.com>
---
kernel/signal.c | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
--- linux-2.6.39-git10.orig/kernel/signal.c
+++ linux-2.6.39-git10/kernel/signal.c
@@ -2365,7 +2365,7 @@ int sigprocmask(int how, sigset_t *set,
/**
* sys_rt_sigprocmask - change the list of currently blocked signals
* @how: whether to add, remove, or set signals
- * @set: stores pending signals
+ * @nset: stores pending signals
* @oset: previous value of signal mask if non-null
* @sigsetsize: size of sigset_t type
*/
^ permalink raw reply [flat|nested] 5+ messages in thread
* Re: [PATCH] signal.c: fix kernel-doc warning
2011-05-26 2:28 [PATCH] signal.c: fix kernel-doc warning Randy Dunlap
@ 2011-05-26 2:58 ` Harry Wei
2011-05-26 3:01 ` Randy Dunlap
2011-05-26 14:45 ` Oleg Nesterov
1 sibling, 1 reply; 5+ messages in thread
From: Harry Wei @ 2011-05-26 2:58 UTC (permalink / raw)
To: Randy Dunlap; +Cc: oleg, mingo, akpm, linux-kernel
On Wed, May 25, 2011 at 07:28:15PM -0700, Randy Dunlap wrote:
> From: Randy Dunlap <randy.dunlap@oracle.com>
>
> Fix kernel-doc warnings in signal.c:
>
> Warning(kernel/signal.c:2374): No description found for parameter 'nset'
> Warning(kernel/signal.c:2374): Excess function parameter 'set' description in 'sys_rt_sigprocmask'
Hi Randy,
I wonder how you can get the warning of the comments.
IMO, gcc can not get the comments' errors or warnings. Maybe
you just use scripts for this. Would you mind telling me ;)
Thanks
Harry Wei
>
> Signed-off-by: Randy Dunlap <randy.dunlap@oracle.com>
Acked-by: Harry Wei <harryxiyou@gmail.com>
> ---
> kernel/signal.c | 2 +-
> 1 file changed, 1 insertion(+), 1 deletion(-)
>
> --- linux-2.6.39-git10.orig/kernel/signal.c
> +++ linux-2.6.39-git10/kernel/signal.c
> @@ -2365,7 +2365,7 @@ int sigprocmask(int how, sigset_t *set,
> /**
> * sys_rt_sigprocmask - change the list of currently blocked signals
> * @how: whether to add, remove, or set signals
> - * @set: stores pending signals
> + * @nset: stores pending signals
> * @oset: previous value of signal mask if non-null
> * @sigsetsize: size of sigset_t type
> */
> --
^ permalink raw reply [flat|nested] 5+ messages in thread
* Re: [PATCH] signal.c: fix kernel-doc warning
2011-05-26 2:58 ` Harry Wei
@ 2011-05-26 3:01 ` Randy Dunlap
2011-05-26 3:17 ` Harry Wei
0 siblings, 1 reply; 5+ messages in thread
From: Randy Dunlap @ 2011-05-26 3:01 UTC (permalink / raw)
To: oleg, mingo, akpm, linux-kernel
On 05/25/11 19:58, Harry Wei wrote:
> On Wed, May 25, 2011 at 07:28:15PM -0700, Randy Dunlap wrote:
>> From: Randy Dunlap <randy.dunlap@oracle.com>
>>
>> Fix kernel-doc warnings in signal.c:
>>
>> Warning(kernel/signal.c:2374): No description found for parameter 'nset'
>> Warning(kernel/signal.c:2374): Excess function parameter 'set' description in 'sys_rt_sigprocmask'
> Hi Randy,
> I wonder how you can get the warning of the comments.
> IMO, gcc can not get the comments' errors or warnings. Maybe
> you just use scripts for this. Would you mind telling me ;)
Harry,
I just run "make htmldocs" and watch the messages.
> Thanks
> Harry Wei
>>
>> Signed-off-by: Randy Dunlap <randy.dunlap@oracle.com>
> Acked-by: Harry Wei <harryxiyou@gmail.com>
>> ---
>> kernel/signal.c | 2 +-
>> 1 file changed, 1 insertion(+), 1 deletion(-)
>>
>> --- linux-2.6.39-git10.orig/kernel/signal.c
>> +++ linux-2.6.39-git10/kernel/signal.c
>> @@ -2365,7 +2365,7 @@ int sigprocmask(int how, sigset_t *set,
>> /**
>> * sys_rt_sigprocmask - change the list of currently blocked signals
>> * @how: whether to add, remove, or set signals
>> - * @set: stores pending signals
>> + * @nset: stores pending signals
>> * @oset: previous value of signal mask if non-null
>> * @sigsetsize: size of sigset_t type
>> */
>> --
--
~Randy
*** Remember to use Documentation/SubmitChecklist when testing your code ***
^ permalink raw reply [flat|nested] 5+ messages in thread
* Re: [PATCH] signal.c: fix kernel-doc warning
2011-05-26 3:01 ` Randy Dunlap
@ 2011-05-26 3:17 ` Harry Wei
0 siblings, 0 replies; 5+ messages in thread
From: Harry Wei @ 2011-05-26 3:17 UTC (permalink / raw)
To: Randy Dunlap; +Cc: linux-kernel
On Wed, May 25, 2011 at 08:01:57PM -0700, Randy Dunlap wrote:
> On 05/25/11 19:58, Harry Wei wrote:
> > On Wed, May 25, 2011 at 07:28:15PM -0700, Randy Dunlap wrote:
> >> From: Randy Dunlap <randy.dunlap@oracle.com>
> >>
> >> Fix kernel-doc warnings in signal.c:
> >>
> >> Warning(kernel/signal.c:2374): No description found for parameter 'nset'
> >> Warning(kernel/signal.c:2374): Excess function parameter 'set' description in 'sys_rt_sigprocmask'
> > Hi Randy,
> > I wonder how you can get the warning of the comments.
> > IMO, gcc can not get the comments' errors or warnings. Maybe
> > you just use scripts for this. Would you mind telling me ;)
>
> Harry,
>
> I just run "make htmldocs" and watch the messages.
Oh, i see, thanks.
Harry Wei
^ permalink raw reply [flat|nested] 5+ messages in thread
* Re: [PATCH] signal.c: fix kernel-doc warning
2011-05-26 2:28 [PATCH] signal.c: fix kernel-doc warning Randy Dunlap
2011-05-26 2:58 ` Harry Wei
@ 2011-05-26 14:45 ` Oleg Nesterov
1 sibling, 0 replies; 5+ messages in thread
From: Oleg Nesterov @ 2011-05-26 14:45 UTC (permalink / raw)
To: Randy Dunlap; +Cc: lkml, Ingo Molnar, akpm
On 05/25, Randy Dunlap wrote:
>
> From: Randy Dunlap <randy.dunlap@oracle.com>
>
> Fix kernel-doc warnings in signal.c
>
> Warning(kernel/signal.c:2374): No description found for parameter 'nset'
> Warning(kernel/signal.c:2374): Excess function parameter 'set' description in 'sys_rt_sigprocmask'
>
> Signed-off-by: Randy Dunlap <randy.dunlap@oracle.com>
> ---
> kernel/signal.c | 2 +-
> 1 file changed, 1 insertion(+), 1 deletion(-)
>
> --- linux-2.6.39-git10.orig/kernel/signal.c
> +++ linux-2.6.39-git10/kernel/signal.c
> @@ -2365,7 +2365,7 @@ int sigprocmask(int how, sigset_t *set,
> /**
> * sys_rt_sigprocmask - change the list of currently blocked signals
> * @how: whether to add, remove, or set signals
> - * @set: stores pending signals
> + * @nset: stores pending signals
My fault. I changed the name of the argument, but forgot to update the doc.
I'll take this patch, thanks Randy.
Oleg.
^ permalink raw reply [flat|nested] 5+ messages in thread
end of thread, other threads:[~2011-05-26 14:47 UTC | newest]
Thread overview: 5+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2011-05-26 2:28 [PATCH] signal.c: fix kernel-doc warning Randy Dunlap
2011-05-26 2:58 ` Harry Wei
2011-05-26 3:01 ` Randy Dunlap
2011-05-26 3:17 ` Harry Wei
2011-05-26 14:45 ` Oleg Nesterov
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox