All of lore.kernel.org
 help / color / mirror / Atom feed
From: Lee Jones <lee.jones@linaro.org>
To: Leon Romanovsky <leon@kernel.org>
Cc: Doug Ledford <dledford@redhat.com>,
	Jason Gunthorpe <jgg@nvidia.com>,
	Leon Romanovsky <leonro@nvidia.com>,
	linux-kernel@vger.kernel.org, linux-rdma@vger.kernel.org
Subject: Re: [PATCH rdma-rc 1/2] RDMA/mlx5: Set correct kernel-doc identifier
Date: Tue, 2 Mar 2021 09:31:09 +0000	[thread overview]
Message-ID: <20210302093109.GA2690909@dell> (raw)
In-Reply-To: <20210302074214.1054299-2-leon@kernel.org>

On Tue, 02 Mar 2021, Leon Romanovsky wrote:

> From: Leon Romanovsky <leonro@nvidia.com>
> 
> 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@nvidia.com>
> ---
>  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.

Kernel-doc is asking for the function name.

>   * Parse a series of data segments for page fault handling.
>   *
>   * @dev:  Pointer to mlx5 IB device

-- 
Lee Jones [李琼斯]
Senior Technical Lead - Developer Services
Linaro.org │ Open source software for Arm SoCs
Follow Linaro: Facebook | Twitter | Blog

  reply	other threads:[~2021-03-02 17:12 UTC|newest]

Thread overview: 10+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-03-02  7:42 [PATCH rdma-rc 0/2] W=1 compilation fixes leftovers Leon Romanovsky
2021-03-02  7:42 ` [PATCH rdma-rc 1/2] RDMA/mlx5: Set correct kernel-doc identifier Leon Romanovsky
2021-03-02  9:31   ` Lee Jones [this message]
2021-03-02 10:26     ` Leon Romanovsky
2021-03-02 10:44       ` Lee Jones
2021-03-02 11:35         ` Leon Romanovsky
2021-03-02  7:42 ` [PATCH rdma-rc 2/2] RDMA/uverbs: Fix kernel-doc warning of _uverbs_alloc Leon Romanovsky
2021-03-02  9:32   ` Lee Jones
2021-03-02 10:26     ` Leon Romanovsky
2021-03-03 17:22 ` [PATCH rdma-rc 0/2] W=1 compilation fixes leftovers Jason Gunthorpe

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20210302093109.GA2690909@dell \
    --to=lee.jones@linaro.org \
    --cc=dledford@redhat.com \
    --cc=jgg@nvidia.com \
    --cc=leon@kernel.org \
    --cc=leonro@nvidia.com \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux-rdma@vger.kernel.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.