Re: [PATCH 0/1] remoteproc documentation changes

From: Jonathan Corbet
Date: Wed Oct 23 2024 - 09:54:52 EST


anish kumar <yesanishhere@xxxxxxxxx> writes:

> This patch series transitions the documentation
> for remoteproc from the staging directory to the
> mainline kernel. It introduces both kernel and
> user-space APIs, enhancing the overall documentation
> quality.
>
> V4:
> Fixed compilation errors and moved documentation to
> driver-api directory.
>
> V3:
> Seperated out the patches further to make the intention
> clear for each patch.
>
> V2:
> Reported-by: kernel test robot <lkp@xxxxxxxxx>
> Closes: https://lore.kernel.org/oe-kbuild-all/202410161444.jOKMsoGS-lkp@xxxxxxxxx/

So I think you could make better use of kerneldoc comments for a number
of your APIs and structures - a project for the future. I can't judge
the remoteproc aspects of this, but from a documentation mechanics point
of view, this looks about ready to me. In the absence of objections
I'll apply it in the near future.

Thanks,

jon