Re: [PATCH] signal.c: fix kernel-doc warning

[Randy Dunlap <randy.dunlap@oracle.com>]

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 ***