linux-kernel - Re: [PATCH v3 1/8] bitmap: align __reg_op() wrappers with modern coding style

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-ID: <ZN5BBovuzGmlfufh@smile.fi.intel.com>
Date:   Thu, 17 Aug 2023 18:47:18 +0300
From:   Andy Shevchenko <andriy.shevchenko@...ux.intel.com>
To:     Yury Norov <yury.norov@...il.com>
Cc:     linux-kernel@...r.kernel.org,
        Rasmus Villemoes <linux@...musvillemoes.dk>
Subject: Re: [PATCH v3 1/8] bitmap: align __reg_op() wrappers with modern
 coding style

On Thu, Aug 17, 2023 at 07:22:25AM -0700, Yury Norov wrote:
> On Thu, Aug 17, 2023 at 12:39:49PM +0300, Andy Shevchenko wrote:
> > On Tue, Aug 15, 2023 at 04:36:21PM -0700, Yury Norov wrote:
> > > Fix comments so that scripts/kernel-doc doesn't warn, and fix for-loop
> > > style in bitmap_find_free_region().
> > 
> > Suggested-by?
> 
> Can you send a full tag?

I thought it's easy to get... Nevertheless it's here.

Suggested-by: Andy Shevchenko <andriy.shevchenko@...ux.intel.com>

> > Reviewed-by: Andy Shevchenko <andriy.shevchenko@...ux.intel.com>

Btw, there are things needs to be fixed/improved as well:
1) bitmap_pos_to_ord(): reference to @nbits instead of @bits;
2) bitmap_parse(): wrong/confusing reference to a list, while
   should be better example for under 32-bit input and over it with spaces
   and/or commas;
3) style of the descriptions of the parameters:
     *   @param :
   vs.
     * @param:  /// preferable
4) bitmap_cut(): make nbits a reference as @nbits in some cases;
5) empty line after the function summary (should be dropped),
   e.g. in bitmap_parse_user();
6) true and false can be referred )in bitmap_print_to_buf(), for example)
   as constants %true. %false (up to you).

Maybe something else... That said, the documentation should be revisited
carefully.

-- 
With Best Regards,
Andy Shevchenko