[PATCH v3] Documentation: Update after split of <linux/mod_devicetable.h>

Patch content 6 changed files

From: Uwe Kleine-König (The Capable Hub) <u.kleine-koenig@baylibre.com> Most structs that were defined in <linux/mod_devicetable.h> before weremoved to a bus specific header. Follow the movement to get the struct'sdocumentation back. For the list of device ids in basics.rst use an explicit list of all theheaders that have kernel-doc annotations and that are not describedelsewhere (i.e. pci and mei_cl). <linux/device-id/acpi.h> is left out onpurpose, ACPI_DEVICE_CLASS() is not a device id struct. Also repair the referencing in the zh_CN translation of pci.rst anddon't duplicate `struct mei_cl_device_id`. Fixes: ad428f5811bd ("mod_devicetable.h: Split into per subsystem headers")Signed-off-by: Uwe Kleine-König (The Capable Hub) <u.kleine-koenig@baylibre.com>Reviewed-by: Randy Dunlap <rdunlap@infradead.org>Tested-by: Randy Dunlap <rdunlap@infradead.org>[Karl Mehltretter: use the :file: role in pcmcia/driver.rst, say why acpi.h is left out]Assisted-by: LLMSigned-off-by: Karl Mehltretter <kmehltretter@gmail.com>---Changes since v2  https://lore.kernel.org/r/ede7ce64f20e10660ebf6bc1b41836dad750ae3b.1783349758.git.ukleinek@kernel.org/- use the :file: role for the header path in pcmcia/driver.rst (Randy)- say in the commit message that <linux/device-id/acpi.h> is left out on  purpose (question raised by the Sashiko review)- carried Randy's Reviewed-by and Tested-by from v2, the diff changed in  one line of markup only- Uwe asked me to take over the patch:  https://lore.kernel.org/r/apv6yQ1U-HhNglyV@monoceros/  It supersedes my PCI-only patch  https://lore.kernel.org/r/20260905084916.40196-1-kmehltretter@gmail.com/ Randy's suggestion to add kernel-doc comments to <linux/mei_cl_bus.h> forstruct mei_cl_driver and include those instead of the duplicated struct isleft for a separate patch, it touches a header outside Documentation/.  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  |  8 ++--- 6 files changed, 39 insertions(+), 18 deletions(-) diff --git a/Documentation/PCI/pci.rst b/Documentation/PCI/pci.rstindex 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 updiff --git a/Documentation/driver-api/basics.rst b/Documentation/driver-api/basics.rstindex 3b182cfdf135..84f701b84e4f 100644--- a/Documentation/driver-api/basics.rst+++ b/Documentation/driver-api/basics.rst@@ -10,9 +10,36 @@ Driver Entry and Exit points Driver device table ------------------- -.. kernel-doc:: include/linux/mod_devicetable.h+.. kernel-doc:: include/linux/device-id/amba.h+   :internal:+.. kernel-doc:: include/linux/device-id/cdx.h+   :internal:+.. kernel-doc:: include/linux/device-id/coreboot.h+   :internal:+.. kernel-doc:: include/linux/device-id/dfl.h+   :internal:+.. kernel-doc:: include/linux/device-id/fsl_mc.h+   :internal:+.. kernel-doc:: include/linux/device-id/ishtp.h+   :internal:+.. kernel-doc:: include/linux/device-id/mdio.h+   :internal:+.. kernel-doc:: include/linux/device-id/mhi.h+   :internal:+.. kernel-doc:: include/linux/device-id/mips_cdmm.h+   :internal:+.. kernel-doc:: include/linux/device-id/rio.h+   :internal:+.. kernel-doc:: include/linux/device-id/tb.h+   :internal:+.. kernel-doc:: include/linux/device-id/tee_client.h+   :internal:+.. kernel-doc:: include/linux/device-id/typec.h+   :internal:+.. kernel-doc:: include/linux/device-id/usb.h+   :internal:+.. kernel-doc:: include/linux/device-id/wmi.h    :internal:-   :no-identifiers: pci_device_id   Delaying and scheduling routinesdiff --git a/Documentation/driver-api/mei/mei-client-bus.rst b/Documentation/driver-api/mei/mei-client-bus.rstindex f242b3f8d6aa..d46c0d0b3540 100644--- a/Documentation/driver-api/mei/mei-client-bus.rst+++ b/Documentation/driver-api/mei/mei-client-bus.rst@@ -41,17 +41,11 @@ the ``struct mei_cl_driver`` structure defined in :file:`include/linux/mei_cl_bu   -The mei_cl_device_id structure defined in :file:`include/linux/mod_devicetable.h` allows a+The mei_cl_device_id structure defined in :file:`include/linux/device-id/mei_cl.h` allows a driver to bind itself against a device name. -.. code-block:: C--        struct mei_cl_device_id {-                char name[MEI_CL_NAME_SIZE];-                uuid_le uuid;-                __u8    version;-                kernel_ulong_t driver_info;-        };+.. kernel-doc:: include/linux/device-id/mei_cl.h+   :functions: mei_cl_device_id  To actually register a driver on the ME Client bus one must call the :c:func:`mei_cl_add_driver` API. This is typically called at module initialization time.diff --git a/Documentation/pcmcia/driver.rst b/Documentation/pcmcia/driver.rstindex 5c4fe84d51c1..0b6370c1d525 100644--- a/Documentation/pcmcia/driver.rst+++ b/Documentation/pcmcia/driver.rst@@ -15,7 +15,7 @@ runtime as shown below:: All fields are passed in as hexadecimal values (no leading 0x). The meaning is described in the PCMCIA specification, the match_flags is a bitwise or-ed combination from PCMCIA_DEV_ID_MATCH_* constants-defined in include/linux/mod_devicetable.h.+defined in :file:`include/linux/device-id/pcmcia.h`.  Once added, the driver probe routine will be invoked for any unclaimed PCMCIA device listed in its (newly updated) pcmcia_device_id list.diff --git a/Documentation/staging/rpmsg.rst b/Documentation/staging/rpmsg.rstindex 63612b7ee120..ea0eb1981124 100644--- a/Documentation/staging/rpmsg.rst+++ b/Documentation/staging/rpmsg.rst@@ -224,7 +224,7 @@ content to the console. ::    #include <linux/dev_printk.h>-  #include <linux/mod_devicetable.h>+  #include <linux/device-id/rpmsg.h>   #include <linux/module.h>   #include <linux/printk.h>   #include <linux/rpmsg.h>diff --git a/Documentation/translations/zh_CN/PCI/pci.rst b/Documentation/translations/zh_CN/PCI/pci.rstindex 347f5c3f5ce9..64372a16caf6 100644--- a/Documentation/translations/zh_CN/PCI/pci.rst+++ b/Documentation/translations/zh_CN/PCI/pci.rst@@ -84,16 +84,16 @@ PCI设备驱动程序在初始化过程中调用 ``pci_register_driver()`` ，  该API在以下内核代码中: -include/linux/pci.h-pci_driver+.. kernel-doc:: include/linux/pci.h+   :functions: pci_driver  ID表是一个由 ``struct pci_device_id`` 结构体成员组成的数组，以一个全零的成员 结束。一般来说，带有静态常数的定义是首选。  该API在以下内核代码中: -include/linux/mod_devicetable.h-pci_device_id+.. kernel-doc:: include/linux/device-id/pci.h+   :functions: pci_device_id  大多数驱动程序只需要 ``PCI_DEVICE()`` 或 ``PCI_DEVICE_CLASS()`` 来设置一个 pci_device_id表。 base-commit: 986c24e0fe44f844b44d365b71ce831947f50298-- 2.53.0