All of lore.kernel.org
 help / color / mirror / Atom feed
From: Karl Mehltretter <kmehltretter@gmail.com>
To: Bjorn Helgaas <bhelgaas@google.com>
Cc: "Karl Mehltretter" <kmehltretter@gmail.com>,
	linux-pci@vger.kernel.org, "Jonathan Corbet" <corbet@lwn.net>,
	linux-doc@vger.kernel.org,
	"Shuah Khan" <skhan@linuxfoundation.org>,
	"Randy Dunlap" <rdunlap@infradead.org>,
	"Uwe Kleine-König" <u.kleine-koenig@baylibre.com>
Subject: [PATCH] Documentation: PCI: Point the pci_device_id kernel-doc at device-id/pci.h
Date: Sat,  5 Sep 2026 10:49:16 +0200	[thread overview]
Message-ID: <20260905084916.40196-1-kmehltretter@gmail.com> (raw)

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


             reply	other threads:[~2026-09-05  8:49 UTC|newest]

Thread overview: 4+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2026-09-05  8:49 Karl Mehltretter [this message]
2026-09-05  8:57 ` [PATCH] Documentation: PCI: Point the pci_device_id kernel-doc at device-id/pci.h sashiko-bot
2026-09-05 11:21 ` Uwe Kleine-König
2026-09-05 13:52   ` Karl Mehltretter

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=20260905084916.40196-1-kmehltretter@gmail.com \
    --to=kmehltretter@gmail.com \
    --cc=bhelgaas@google.com \
    --cc=corbet@lwn.net \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-pci@vger.kernel.org \
    --cc=rdunlap@infradead.org \
    --cc=skhan@linuxfoundation.org \
    --cc=u.kleine-koenig@baylibre.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 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.