Re: [PATCH] docs: process: discourage pointless boilerplate kdoc

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



On Sat, Jun 14, 2025 at 01:42:57PM -0700, Jakub Kicinski wrote:
> It appears that folks "less versed in kernel coding" think that its
> good style to document every function, even if they have no useful
> information to pass to the future readers of the code. This used
> to be just a waste of space, but with increased kdoc format linting
> it's also a burden when refactoring the code.
> 
> Signed-off-by: Jakub Kicinski <kuba@xxxxxxxxxx>
> ---
> CC: corbet@xxxxxxx
> CC: workflows@xxxxxxxxxxxxxxx
> CC: linux-doc@xxxxxxxxxxxxxxx
> ---
>  Documentation/process/coding-style.rst | 5 ++++-
>  1 file changed, 4 insertions(+), 1 deletion(-)
> 

I suppose I am guilty of this ;)

Reviewed-by: Joe Damato <joe@xxxxxxx>




[Index of Archives]     [Kernel Newbies]     [Security]     [Netfilter]     [Bugtraq]     [Linux FS]     [Yosemite Forum]     [MIPS Linux]     [ARM Linux]     [Linux Security]     [Linux RAID]     [Samba]     [Video 4 Linux]     [Device Mapper]     [Linux Resources]

  Powered by Linux