[PATCH] PCI/P2PDMA: Add missing struct p2pdma_provider documentation

[PATCH] PCI/P2PDMA: Add missing struct p2pdma_provider documentation

[Leon Romanovsky]

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>
---
 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>

Re: [PATCH] PCI/P2PDMA: Add missing struct p2pdma_provider documentation

[Logan Gunthorpe]

On 2026-01-04 05:51, 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>

LGTM

Reviewed-by: Logan Gunthorpe <logang@deltatee.com>

Re: [PATCH] PCI/P2PDMA: Add missing struct p2pdma_provider documentation

[Bjorn Helgaas]

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>
> 

Re: [PATCH] PCI/P2PDMA: Add missing struct p2pdma_provider documentation

[Alex Williamson]

On Tue, 6 Jan 2026 16:18:52 -0600
Bjorn Helgaas <helgaas@kernel.org> wrote:

> 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).

Nope, makes sense to follow get_maintainer.pl for the standalone
follow-ups.  Sorry we didn't spot it on the way in.  Thanks,

Alex

> 
> > ---
> >  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>
> >