[PATCH] Documentation: PCI: Point the pci_device_id kernel-doc at device-id/pci.h

[PATCH] Documentation: PCI: Point the pci_device_id kernel-doc at device-id/pci.h

[Karl Mehltretter]

pci.rst pulls the description of struct pci_device_id from
include/linux/mod_devicetable.h. Commit ad428f5811bd
("mod_devicetable.h: Split into per subsystem headers") moved the
structure and its kernel-doc comment to include/linux/device-id/pci.h.
Since then the directive finds nothing and the rendered page no longer
shows the structure.

Point the directive at the new header.

Fixes: ad428f5811bd ("mod_devicetable.h: Split into per subsystem headers")
Assisted-by: LLM
Signed-off-by: Karl Mehltretter <kmehltretter@gmail.com>
---
 Documentation/PCI/pci.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/Documentation/PCI/pci.rst b/Documentation/PCI/pci.rst
index be35e9a1ee75..71c42b0bfa8b 100644
--- a/Documentation/PCI/pci.rst
+++ b/Documentation/PCI/pci.rst
@@ -84,7 +84,7 @@ initialization with a pointer to a structure describing the driver
 The ID table is an array of ``struct pci_device_id`` entries ending with an
 all-zero entry.  Definitions with static const are generally preferred.
 
-.. kernel-doc:: include/linux/mod_devicetable.h
+.. kernel-doc:: include/linux/device-id/pci.h
    :functions: pci_device_id
 
 Most drivers only need ``PCI_DEVICE()`` or ``PCI_DEVICE_CLASS()`` to set up
-- 
2.53.0

Re: [PATCH] Documentation: PCI: Point the pci_device_id kernel-doc at device-id/pci.h

[sashiko-bot]

> pci.rst pulls the description of struct pci_device_id from
> include/linux/mod_devicetable.h. Commit ad428f5811bd
> ("mod_devicetable.h: Split into per subsystem headers") moved the
> structure and its kernel-doc comment to include/linux/device-id/pci.h.
> Since then the directive finds nothing and the rendered page no longer
> shows the structure.
> 
> Point the directive at the new header.
> 
> Fixes: ad428f5811bd ("mod_devicetable.h: Split into per subsystem headers")
> Assisted-by: LLM
> Signed-off-by: Karl Mehltretter <kmehltretter@gmail.com>

Sashiko has reviewed this patch and found no issues. It looks great!

-- 
Sashiko AI review · https://sashiko.dev/#/patchset/20260905084916.40196-1-kmehltretter@gmail.com?part=1

Re: [PATCH] Documentation: PCI: Point the pci_device_id kernel-doc at device-id/pci.h

[Uwe Kleine-König]

[-- Attachment #1: Type: text/plain, Size: 1854 bytes --]

Hello Karl,

On Sat, Sep 05, 2026 at 10:49:16AM +0200, Karl Mehltretter wrote:
> pci.rst pulls the description of struct pci_device_id from
> include/linux/mod_devicetable.h. Commit ad428f5811bd
> ("mod_devicetable.h: Split into per subsystem headers") moved the
> structure and its kernel-doc comment to include/linux/device-id/pci.h.
> Since then the directive finds nothing and the rendered page no longer
> shows the structure.
> 
> Point the directive at the new header.
> 
> Fixes: ad428f5811bd ("mod_devicetable.h: Split into per subsystem headers")
> Assisted-by: LLM
> Signed-off-by: Karl Mehltretter <kmehltretter@gmail.com>
> ---
>  Documentation/PCI/pci.rst | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/Documentation/PCI/pci.rst b/Documentation/PCI/pci.rst
> index be35e9a1ee75..71c42b0bfa8b 100644
> --- a/Documentation/PCI/pci.rst
> +++ b/Documentation/PCI/pci.rst
> @@ -84,7 +84,7 @@ initialization with a pointer to a structure describing the driver
>  The ID table is an array of ``struct pci_device_id`` entries ending with an
>  all-zero entry.  Definitions with static const are generally preferred.
>  
> -.. kernel-doc:: include/linux/mod_devicetable.h
> +.. kernel-doc:: include/linux/device-id/pci.h
>     :functions: pci_device_id
>  
>  Most drivers only need ``PCI_DEVICE()`` or ``PCI_DEVICE_CLASS()`` to set up

there is prior art that can be found at
https://lore.kernel.org/all/ede7ce64f20e10660ebf6bc1b41836dad750ae3b.1783349758.git.ukleinek@kernel.org/.
My patch is more complete, but I didn't respin yet to address Randy's
feedback and so it wasn't picked up yet.

If you want to take over caring for this patch that would be very
welcome, there are too many open threads in my mailbox and I'm happy to
be able to close that one.

Best regards
Uwe

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 488 bytes --]

Re: [PATCH] Documentation: PCI: Point the pci_device_id kernel-doc at device-id/pci.h

[Karl Mehltretter]

On Sat, Sep 05, 2026 at 01:21:32PM +0100, Uwe Kleine-König wrote:
> there is prior art that can be found at
> https://lore.kernel.org/all/ede7ce64f20e10660ebf6bc1b41836dad750ae3b.1783349758.git.ukleinek@kernel.org/.
> My patch is more complete, but I didn't respin yet to address Randy's
> feedback and so it wasn't picked up yet.
> 
> If you want to take over caring for this patch that would be very
> welcome, there are too many open threads in my mailbox and I'm happy to
> be able to close that one.
> 

Thanks, I did not find yours when I looked. I will take it over and send
it as v3 with Randy's file nit applied and your authorship kept.

This patch is then superseded, please consider it withdrawn.

Karl