lkml.org 
[lkml]   [2021]   [Aug]   [3]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
 
Messages in this thread
/
Date
From
SubjectRe: [PATCH] Restyle comments to better align with kernel-doc
Missing subsystem prefix in the subject.

On Tue, Aug 03, 2021 at 02:57:09PM +0300, Kari Argillander wrote:
> Capitalize comments and end with period for better reading.
>
> Also function comments are now little more kernel-doc style. This way we
> can easily convert them to kernel-doc style if we want. Note that these
> are not yet complete with this style. Example function comments start
> with /* and in kernel-doc style they start /**.
>
> Use imperative mood in function descriptions.
>
> Change words like ntfs -> NTFS, linux -> Linux.
>
> Use "we" not "I" when commenting code.

These are all nonsense style guidelines that you invented yourself. We
already have too much pointless bureaucracy. If you can't understand
the documentation or if there are typos then, sure, fix that. But let's
not invent new rules.

(Also it annoys me when people pretend to be stupid "I can't understand
what a NULL deference is. Ohhh... You mean a NULL *pointer*
dereference! You left out the word *pointer* so I didn't understand!")

regards,
dan carpenter

\
 
 \ /
  Last update: 2021-08-03 15:41    [W:0.371 / U:0.104 seconds]
©2003-2020 Jasper Spaans|hosted at Digital Ocean and TransIP|Read the blog|Advertise on this site