Re: [PATCH v4 1/2] Documentation: Update after split of <linux/mod_devicetable.h>

[sashiko-bot@kernel.org]

Thank you for your contribution! Sashiko AI review found 1 potential issue(s) to consider:
- [Low] Documentation: basics.rst omits kernel-doc for arm_smccc.h
--

commit 1e9cc1a9a128cf0749229f0053d8a9b4210d892b
Author: Uwe Kleine-König (The Capable Hub) <u.kleine-koenig@baylibre.com>

Documentation: Update after split of <linux/mod_devicetable.h>

This patch updates documentation references after struct definitions in
include/linux/mod_devicetable.h were split into bus-specific headers under
include/linux/device-id/.

> diff --git a/Documentation/driver-api/basics.rst b/Documentation/driver-api/basics.rst
> index 3b182cfdf1350..84f701b84e4fc 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:

[Severity: Low]
Should include/linux/device-id/arm_smccc.h also be included here in the
Driver device table section of Documentation/driver-api/basics.rst?

The commit message notes that basics.rst lists all headers that have
kernel-doc annotations and are not described elsewhere (with acpi.h left
out). However, include/linux/device-id/arm_smccc.h (which is included by
include/linux/mod_devicetable.h) defines struct arm_smccc_device_id with a
kernel-doc comment:

/**
 * struct arm_smccc_device_id - Arm SMCCC bus device identifier
 * @func_id: SMCCC function identifier
 */
struct arm_smccc_device_id {
	__u32 func_id;
};

Since arm_smccc.h is not referenced elsewhere under Documentation/ and is
skipped between amba.h and cdx.h, struct arm_smccc_device_id is omitted when
generating the documentation.

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