public inbox for linux-pci@vger.kernel.org
 help / color / mirror / Atom feed
From: Bjorn Helgaas <helgaas@kernel.org>
To: Leon Romanovsky <leon@kernel.org>
Cc: Bjorn Helgaas <bhelgaas@google.com>,
	Logan Gunthorpe <logang@deltatee.com>,
	Jason Gunthorpe <jgg@ziepe.ca>,
	Alex Williamson <alex@shazbot.org>,
	Ankit Agrawal <ankita@nvidia.com>,
	linux-pci@vger.kernel.org, linux-kernel@vger.kernel.org
Subject: Re: [PATCH] PCI/P2PDMA: Add missing struct p2pdma_provider documentation
Date: Tue, 6 Jan 2026 16:18:52 -0600	[thread overview]
Message-ID: <20260106221852.GA381083@bhelgaas> (raw)
In-Reply-To: <20260104-fix-p2p-kdoc-v1-1-6d181233f8bc@nvidia.com>

On Sun, Jan 04, 2026 at 02:51:28PM +0200, Leon Romanovsky wrote:
> From: Leon Romanovsky <leonro@nvidia.com>
> 
> Two fields in struct p2pdma_provider were not documented, which resulted
> in the following kernel-doc warning:
> 
>   Warning: include/linux/pci-p2pdma.h:26 struct member 'owner' not described in 'p2pdma_provider'
>   Warning: include/linux/pci-p2pdma.h:26 struct member 'bus_offset' not described in 'p2pdma_provider'
> 
> Repro:
> 
>   $ scripts/kernel-doc -none include/linux/pci-p2pdma.h
> 
> Fixes: f58ef9d1d135 ("PCI/P2PDMA: Separate the mmap() support from the core logic")
> Reported-by: Bjorn Helgaas <helgaas@kernel.org>
> Closes: https://lore.kernel.org/all/20260102234033.GA246107@bhelgaas
> Signed-off-by: Leon Romanovsky <leonro@nvidia.com>

Applied to pci/misc for v6.20, thanks!

Alex, let me know if you'd rather take this (you merged f58ef9d1d135).

> ---
>  include/linux/pci-p2pdma.h | 2 ++
>  1 file changed, 2 insertions(+)
> 
> diff --git a/include/linux/pci-p2pdma.h b/include/linux/pci-p2pdma.h
> index 517e121d2598..873de20a2247 100644
> --- a/include/linux/pci-p2pdma.h
> +++ b/include/linux/pci-p2pdma.h
> @@ -20,6 +20,8 @@ struct scatterlist;
>   * struct p2pdma_provider
>   *
>   * A p2pdma provider is a range of MMIO address space available to the CPU.
> + * @owner: Device to which this provider belongs.
> + * @bus_offset: Bus offset for p2p communication.
>   */
>  struct p2pdma_provider {
>  	struct device *owner;
> 
> ---
> base-commit: f8f9c1f4d0c7a64600e2ca312dec824a0bc2f1da
> change-id: 20260104-fix-p2p-kdoc-3f503e6d6a55
> 
> Best regards,
> --  
> Leon Romanovsky <leonro@nvidia.com>
> 

  parent reply	other threads:[~2026-01-06 22:18 UTC|newest]

Thread overview: 4+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2026-01-04 12:51 [PATCH] PCI/P2PDMA: Add missing struct p2pdma_provider documentation Leon Romanovsky
2026-01-05 16:39 ` Logan Gunthorpe
2026-01-06 22:18 ` Bjorn Helgaas [this message]
2026-01-06 22:57   ` Alex Williamson

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=20260106221852.GA381083@bhelgaas \
    --to=helgaas@kernel.org \
    --cc=alex@shazbot.org \
    --cc=ankita@nvidia.com \
    --cc=bhelgaas@google.com \
    --cc=jgg@ziepe.ca \
    --cc=leon@kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux-pci@vger.kernel.org \
    --cc=logang@deltatee.com \
    /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 a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox