Re: [PATCH rdma-rc 1/2] RDMA/mlx5: Set correct kernel-doc identifier

[Leon Romanovsky]

On Tue, Mar 02, 2021 at 09:31:09AM +0000, Lee Jones wrote:
> On Tue, 02 Mar 2021, Leon Romanovsky wrote:
>
> > From: Leon Romanovsky <leonro@xxxxxxxxxx>
> >
> > The W=1 allmodconfig build produces the following warning:
> > drivers/infiniband/hw/mlx5/odp.c:1086: warning: wrong kernel-doc identifier on line:
> >   * Parse a series of data segments for page fault handling.
> >
> > Fix it by changing /** to be /* as it is written in kernel-doc documentation.
> >
> > Fixes: 5e769e444d26 ("RDMA/hw/mlx5/odp: Fix formatting and add missing descriptions in 'pagefault_data_segments()'")
> > Signed-off-by: Leon Romanovsky <leonro@xxxxxxxxxx>
> > ---
> >  drivers/infiniband/hw/mlx5/odp.c | 2 +-
> >  1 file changed, 1 insertion(+), 1 deletion(-)
> >
> > diff --git a/drivers/infiniband/hw/mlx5/odp.c b/drivers/infiniband/hw/mlx5/odp.c
> > index 374698186662..b103555b1f5d 100644
> > --- a/drivers/infiniband/hw/mlx5/odp.c
> > +++ b/drivers/infiniband/hw/mlx5/odp.c
> > @@ -1082,7 +1082,7 @@ static int pagefault_single_data_segment(struct mlx5_ib_dev *dev,
> >  	return ret ? ret : npages;
> >  }
> >
> > -/**
> > +/*
>
> This is not the correct fix.

I don't want kernel-doc comments on static function. It is local to this
file, so change from /** to /* was to mark that this is not kernel-doc.

>
> Kernel-doc is asking for the function name.

The thing is that I don't want it to be kernel-doc.

Thanks