Re: [PATCH v4 02/14] of: Do not expose of_alias_scan() and correct its comments

From: Zijun Hu
Date: Fri Jan 10 2025 - 17:41:20 EST


On 2025/1/11 01:43, Rob Herring wrote:
> On Thu, Jan 09, 2025 at 09:26:53PM +0800, Zijun Hu wrote:
>> From: Zijun Hu <quic_zijuhu@xxxxxxxxxxx>
>>
>> For of_alias_scan():
>> - Do not expose it since it has no external callers.
>> - Correct its comments shown below:
>> 1) Replace /* with /** to start comments since it is not a API.
> You've got that backwards. However, in other places we leave this. I
> prefer if the comment is in kerneldoc format, then it should have '/**'
> to indicate that and so that it is checked by the tools.
>

okay, let me cancel this change in v5.

>> 2) Delete return value descriptions since it is a void function.
>>
>> Signed-off-by: Zijun Hu <quic_zijuhu@xxxxxxxxxxx>
>> ---
>> drivers/of/base.c | 5 ++---
>> drivers/of/of_private.h | 2 ++
>> drivers/of/pdt.c | 2 ++
>> include/linux/of.h | 1 -
>> 4 files changed, 6 insertions(+), 4 deletions(-)