Re: [PATCH] docs: driver-model: generate kernel-doc for driver model using script

[Jonathan Corbet <corbet@lwn.net>]

anish kumar <yesanishhere@gmail.com> writes:

> In commit 63dc355 ("remove the driver-model structures from the
> documentation"), the kernel-doc text was removed, and users were
> instructed to read the documentation directly from the source code.
> However, using the kernel-doc script to extract and generate the
> documentation is a better approach, as it ensures the documentation
> remains in sync with the code. Additionally, it provides users with
> a more convenient way to access the documentation without needing to
> refer directly to the source code.
>
> This patch adds kernel-doc annotations for the driver model to
> facilitate the use of the kernel-doc script.
>
> Signed-off-by: anish kumar <yesanishhere@gmail.com>
> ---
>  Documentation/driver-api/driver-model/bus.rst    | 4 +++-
>  Documentation/driver-api/driver-model/device.rst | 4 ++--
>  Documentation/driver-api/driver-model/driver.rst | 3 ++-
>  3 files changed, 7 insertions(+), 4 deletions(-)

This does not work very well...

Documentation/driver-api/driver-model/bus:8: ./include/linux/device/bus.h:3: WARNING: Duplicate C declaration, also defined at driver-api/infrastructure:3.
Declaration is '.. c:struct:: bus_type'.
WARNING: kernel-doc './scripts/kernel-doc -rst -enable-lineno -sphinx-version 7.2.6 -function struct -function device ./include/linux/device/device.h' failed with return code 1
Documentation/driver-api/driver-model/driver:5: ./include/linux/device/driver.h:3: WARNING: Duplicate C declaration, also defined at driver-api/infrastructure:48.
Declaration is '.. c:struct:: device_driver'.

Please actually perform a documentation build and look at the results
before sending patches.

Thanks,

jon