From: Karl Mehltretter <kmehltretter@gmail.com>
To: Jonathan Corbet <corbet@lwn.net>
Cc: "Karl Mehltretter" <kmehltretter@gmail.com>,
"Uwe Kleine-König" <u.kleine-koenig@baylibre.com>,
"Randy Dunlap" <rdunlap@infradead.org>,
"Shuah Khan" <skhan@linuxfoundation.org>,
"Bjorn Helgaas" <bhelgaas@google.com>,
"Alexander Usyskin" <alexander.usyskin@intel.com>,
"Dominik Brodowski" <linux@dominikbrodowski.net>,
"Bjorn Andersson" <andersson@kernel.org>,
"Mathieu Poirier" <mathieu.poirier@linaro.org>,
"Alex Shi" <alexs@kernel.org>,
"Yanteng Si" <si.yanteng@linux.dev>,
"Dongliang Mu" <dzm91@hust.edu.cn>,
"Andy Shevchenko" <andriy.shevchenko@linux.intel.com>,
"Danilo Krummrich" <dakr@kernel.org>,
"Takashi Sakamoto" <o-takashi@sakamocchi.jp>,
"Geert Uytterhoeven" <geert@linux-m68k.org>,
linux-pci@vger.kernel.org, linux-doc@vger.kernel.org,
linux-kernel@vger.kernel.org, linux-remoteproc@vger.kernel.org
Subject: [PATCH v4 0/2] Documentation: Restore device-ID documentation
Date: Thu, 29 Oct 2026 02:37:15 +0100 [thread overview]
Message-ID: <cover.1793221199.git.kmehltretter@gmail.com> (raw)
This v4 addresses the duplicate PCI declaration warnings Jonathan
reported on v3.
Patch 1 retains Uwe's device-ID documentation restoration. Patch 2
corrects the Chinese PCI header path and preserves its existing plain
references. The kernel-doc blocks added in v3 are dropped, with generated
API documentation deferred to a separate change.
A focused Sphinx 8.2.3 build with -W includes the complete English and
Chinese PCI pages together. It reproduces both warnings with v3 and
passes without warnings after each v4 patch.
Changes since v3:
https://lore.kernel.org/r/20260908070031.32833-1-kmehltretter@gmail.com/
- Move the Chinese PCI changes to patch 2. The five files in patch 1 are
unchanged from v3.
- Clarify the ACPI exclusion in patch 1's commit message using Uwe's
explanation to Andy. Only ACPI_DEVICE_CLASS() has kernel-doc in that
header.
- Retain Randy's review and test tags from v2 on patch 1.
Changes since v2:
https://lore.kernel.org/r/ede7ce64f20e10660ebf6bc1b41836dad750ae3b.1783349758.git.ukleinek@kernel.org/
- Use the :file: role in pcmcia/driver.rst (Randy) and explain why acpi.h
is excluded.
Documenting struct mei_cl_driver in include/linux/mei_cl_bus.h remains
a separate follow-up.
Report: https://lore.kernel.org/r/87h5jq8gia.fsf@trenco.lwn.net/
Karl Mehltretter (1):
docs/zh_CN: PCI: Update the pci_device_id header reference
Uwe Kleine-König (The Capable Hub) (1):
Documentation: Update after split of <linux/mod_devicetable.h>
Documentation/PCI/pci.rst | 2 +-
Documentation/driver-api/basics.rst | 31 +++++++++++++++++--
.../driver-api/mei/mei-client-bus.rst | 12 ++-----
Documentation/pcmcia/driver.rst | 2 +-
Documentation/staging/rpmsg.rst | 2 +-
Documentation/translations/zh_CN/PCI/pci.rst | 2 +-
6 files changed, 36 insertions(+), 15 deletions(-)
base-commit: 5b0764a53235d3c77e1ed674e836e1b3fe1a4b1f
next reply other threads:[~2026-10-29 1:38 UTC|newest]
Thread overview: 3+ messages / expand[flat|nested] mbox.gz Atom feed top
2026-10-29 1:37 Karl Mehltretter [this message]
2026-10-29 1:37 ` [PATCH v4 1/2] Documentation: Update after split of <linux/mod_devicetable.h> Karl Mehltretter
2026-10-29 1:37 ` [PATCH v4 2/2] docs/zh_CN: PCI: Update the pci_device_id header reference 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=cover.1793221199.git.kmehltretter@gmail.com \
--to=kmehltretter@gmail.com \
--cc=alexander.usyskin@intel.com \
--cc=alexs@kernel.org \
--cc=andersson@kernel.org \
--cc=andriy.shevchenko@linux.intel.com \
--cc=bhelgaas@google.com \
--cc=corbet@lwn.net \
--cc=dakr@kernel.org \
--cc=dzm91@hust.edu.cn \
--cc=geert@linux-m68k.org \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=linux-pci@vger.kernel.org \
--cc=linux-remoteproc@vger.kernel.org \
--cc=linux@dominikbrodowski.net \
--cc=mathieu.poirier@linaro.org \
--cc=o-takashi@sakamocchi.jp \
--cc=rdunlap@infradead.org \
--cc=si.yanteng@linux.dev \
--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 a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox