[PATCH] lib/win_minmax: use /* notation for regular comments

[PATCH] lib/win_minmax: use /* notation for regular comments

[Randy Dunlap]

Don't use kernel-doc "/**" notation for non-kernel-doc comments.
Prevents a kernel-doc warning:

lib/win_minmax.c:31: warning: expecting prototype for lib/minmax.c(). Prototype was for minmax_subwin_update() instead

Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Cc: Neal Cardwell <ncardwell@google.com>
Cc: Eric Dumazet <edumazet@google.com>
Cc: David S. Miller <davem@davemloft.net>
Cc: Andrew Morton <akpm@linux-foundation.org>
---
 lib/win_minmax.c |    2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff -- a/lib/win_minmax.c b/lib/win_minmax.c
--- a/lib/win_minmax.c
+++ b/lib/win_minmax.c
@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: GPL-2.0
-/**
+/*
  * lib/minmax.c: windowed min/max tracker
  *
  * Kathleen Nichols' algorithm for tracking the minimum (or maximum)

Re: [PATCH] lib/win_minmax: use /* notation for regular comments

[Andy Shevchenko]

On Mon, Jan 02, 2023 at 01:16:14PM -0800, Randy Dunlap wrote:
> Don't use kernel-doc "/**" notation for non-kernel-doc comments.
> Prevents a kernel-doc warning:
> 
> lib/win_minmax.c:31: warning: expecting prototype for lib/minmax.c(). Prototype was for minmax_subwin_update() instead

...

> -/**
> +/*
>   * lib/minmax.c: windowed min/max tracker

Side note (just stumbled over it today), if you fixing like this it also makes
sense to drop rather problematic filename in the file. Here is exactly a good
example why (it's not the same as on the filesystem and in general easy to go
south with time).

>   *
>   * Kathleen Nichols' algorithm for tracking the minimum (or maximum)

-- 
With Best Regards,
Andy Shevchenko

Re: [PATCH] lib/win_minmax: use /* notation for regular comments

[Randy Dunlap]

On 9/1/26 12:32 AM, Andy Shevchenko wrote:
> On Mon, Jan 02, 2023 at 01:16:14PM -0800, Randy Dunlap wrote:
>> Don't use kernel-doc "/**" notation for non-kernel-doc comments.
>> Prevents a kernel-doc warning:
>>
>> lib/win_minmax.c:31: warning: expecting prototype for lib/minmax.c(). Prototype was for minmax_subwin_update() instead
> 
> ...
> 
>> -/**
>> +/*
>>   * lib/minmax.c: windowed min/max tracker
> 
> Side note (just stumbled over it today), if you fixing like this it also makes
> sense to drop rather problematic filename in the file. Here is exactly a good
> example why (it's not the same as on the filesystem and in general easy to go
> south with time).

Ack. I'll try to do that in the future.

>>   *
>>   * Kathleen Nichols' algorithm for tracking the minimum (or maximum)
> 

-- 
~Randy