linux-kernel - Re: [PATCH rdma-next v1] RDMA: Fix kernel-doc warnings about wrong comment

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] [day] [month] [year] [list]

Message-ID: <YMRVhi0+a/ZX3Vho@unreal>
Date:   Sat, 12 Jun 2021 09:34:46 +0300
From:   Leon Romanovsky <leonro@...dia.com>
To:     Doug Ledford <dledford@...hat.com>,
        Jason Gunthorpe <jgg@...dia.com>
CC:     Dennis Dalessandro <dennis.dalessandro@...nelisnetworks.com>,
        Jack Wang <jinpu.wang@...os.com>,
        <linux-kernel@...r.kernel.org>, <linux-rdma@...r.kernel.org>,
        Max Gurtovoy <mgurtovoy@...dia.com>,
        "Md. Haris Iqbal" <haris.iqbal@...os.com>,
        Mike Marciniszyn <mike.marciniszyn@...nelisnetworks.com>,
        Sagi Grimberg <sagi@...mberg.me>,
        <target-devel@...r.kernel.org>
Subject: Re: [PATCH rdma-next v1] RDMA: Fix kernel-doc warnings about wrong
 comment

On Thu, Jun 03, 2021 at 04:16:36PM +0300, Leon Romanovsky wrote:
> From: Leon Romanovsky <leonro@...dia.com>
> 
> Compilation with W=1 produces warnings similar to the below.
> 
>   drivers/infiniband/ulp/ipoib/ipoib_main.c:320: warning: This comment
> 	starts with '/**', but isn't a kernel-doc comment. Refer
> 	Documentation/doc-guide/kernel-doc.rst
> 
> All such occurrences were found with the following one line
>  git grep -A 1 "\/\*\*" drivers/infiniband/
> 
> Reviewed-by: Jack Wang <jinpu.wang@...os.com> #rtrs
> Signed-off-by: Leon Romanovsky <leonro@...dia.com>
> ---
>  Changelog:
>  v0 https://lore.kernel.org/lkml/635def71048cbffe76e2dd324cf420d8a465ee9d.1622460676.git.leonro@nvidia.com:
>  * Rebased to drop i40iw
>  * Added Jack's ROB
> ---
>  drivers/infiniband/core/iwpm_util.h       | 2 +-
>  drivers/infiniband/core/roce_gid_mgmt.c   | 5 +++--
>  drivers/infiniband/hw/hfi1/chip.c         | 4 ++--
>  drivers/infiniband/hw/hfi1/file_ops.c     | 6 +++---
>  drivers/infiniband/hw/hfi1/hfi.h          | 2 +-
>  drivers/infiniband/hw/hfi1/init.c         | 4 ++--
>  drivers/infiniband/hw/hfi1/pio.c          | 2 +-
>  drivers/infiniband/sw/rdmavt/mr.c         | 4 ++--
>  drivers/infiniband/sw/rdmavt/qp.c         | 3 ++-
>  drivers/infiniband/sw/rdmavt/vt.c         | 4 ++--
>  drivers/infiniband/ulp/ipoib/ipoib_main.c | 7 ++++---
>  drivers/infiniband/ulp/iser/iser_verbs.c  | 2 +-
>  drivers/infiniband/ulp/isert/ib_isert.c   | 4 ++--
>  drivers/infiniband/ulp/rtrs/rtrs-clt.c    | 4 ++--
>  drivers/infiniband/ulp/rtrs/rtrs-srv.c    | 2 +-
>  15 files changed, 29 insertions(+), 26 deletions(-)

Jason, reminder.

Thanks