Re: [PATCH V2 1/2] cpumask: Fix kernel-doc formatting errors in cpumask.h

[Akira Yokosawa]

Viresh Kumar wrote:
> On 07-03-25, 19:57, Akira Yokosawa wrote:
>> Didn't come up in your diff, but you need additional changes shown below:
>>
>> diff --git a/include/linux/cpumask.h b/include/linux/cpumask.h
>> index 656d2208467e..a6c1961cc535 100644
>> --- a/include/linux/cpumask.h
>> +++ b/include/linux/cpumask.h
>> @@ -285,10 +285,10 @@ unsigned int cpumask_next_and(int n, const struct cpumask *src1p,
>>  }
>>  
>>  /**
>> - * cpumask_next_and_wrap - get the next cpu in *src1p & *src2p, starting from
>> - *                        @n+1. If nothing found, wrap around and start from
>> + * cpumask_next_and_wrap - get the next cpu in *@src1p & *@src2p, starting from
>> + *                        @n+ 1. If nothing found, wrap around and start from
>>   *                        the beginning
>> - * @n: the cpu prior to the place to search (i.e. search starts from @n+1)
>> + * @n: the cpu prior to the place to search (i.e. search starts from @n +1)
>>   * @src1p: the first cpumask pointer
>>   * @src2p: the second cpumask pointer
>>   *
>> @@ -306,9 +306,9 @@ unsigned int cpumask_next_and_wrap(int n, const struct cpumask *src1p,
>>  }
>>  
>>  /**
>> - * cpumask_next_wrap - get the next cpu in *src, starting from @n+1. If nothing
>> + * cpumask_next_wrap - get the next cpu in *@src, starting from @n +1. If nothing
>>   *                    found, wrap around and start from the beginning
>> - * @n: the cpu prior to the place to search (i.e. search starts from @n+1)
>> + * @n: the cpu prior to the place to search (i.e. search starts from @n +1)
>>   * @src: cpumask pointer
>>   *
>>   * Return: next set bit, wrapped if needed, or >= nr_cpu_ids if @src is empty.
> 
> How did you find these ? I only looked for build warnings / errors earlier (with
> make htmldocs).   Anything else I should be doing to find these issues ?

Well, you need to see the rendered html pages in your browser. :-)

Or, look into the rst output from
   "scripts/kernel-doc -rst <file with kernel-doc comments>",
and see if it makes sense as reStructuredText.

It seems to me there are very few people actually do it ...

But I fat-fingered in the above diff.

>> @@ -285,10 +285,10 @@ unsigned int cpumask_next_and(int n, const struct cpumask *src1p,
>>  }
>>  
>>  /**
>> - * cpumask_next_and_wrap - get the next cpu in *src1p & *src2p, starting from
>> - *                        @n+1. If nothing found, wrap around and start from
>> + * cpumask_next_and_wrap - get the next cpu in *@src1p & *@src2p, starting from
>> + *                        @n+ 1. If nothing found, wrap around and start from
        Obviously, should be  @n +1.

>>   *                        the beginning

> 
> Thanks for your help Akira.
>

You are welcome.