Re: [PATCH 2/3] i2c: s3c2410: Minor function-level comment cleanup
From: Krzysztof Kozlowski
Date: Thu Apr 21 2016 - 03:01:30 EST
On 04/20/2016 03:59 PM, Javier Martinez Canillas wrote:
> Hello Krzysztof,
>
> On 04/20/2016 05:24 AM, Krzysztof Kozlowski wrote:
>> Cleanup the weird function-level comments and remove obvious
>> documentatoin for probe/remove.
>>
>
> s/documentatoin/documentation
>
>> Signed-off-by: Krzysztof Kozlowski <k.kozlowski@xxxxxxxxxxx>
>> ---
>
> I wonder if instead we should change to kernel-doc formatted documentation.
>
> All the functions are static so kernel-doc is not really required but still
> Documentation/kernel-doc-nano-HOWTO.txt says that is suggested for source
> code layout consistency.
>
> But I agree that's either kernel-doc format or minimal as your patch does:
>
> Reviewed-by: Javier Martinez Canillas <javier@xxxxxxxxxxxxxxx>
Thanks for review. Indeed switching to kernel-doc would be the best...
but that would require a little bit more rewritting than now. I just
wanted to fix some weird looking comments.
Best regards,
Krzysztof