Re: [RESEND PATCH V6 3/3] Documentation: remoteproc: add a note to rproc_add

From: Jonathan Corbet
Date: Tue Nov 12 2024 - 15:10:23 EST


anish kumar <yesanishhere@xxxxxxxxx> writes:

> Added a note to the rproc_add description regarding
> the availability of the resource-managed variant of the API.
>
> Signed-off-by: anish kumar <yesanishhere@xxxxxxxxx>
> ---
> Documentation/staging/remoteproc.rst | 8 ++++++++
> 1 file changed, 8 insertions(+)
>
> diff --git a/Documentation/staging/remoteproc.rst b/Documentation/staging/remoteproc.rst
> index e0bf68ceade8..658ef7a28dd2 100644
> --- a/Documentation/staging/remoteproc.rst
> +++ b/Documentation/staging/remoteproc.rst
> @@ -223,6 +223,14 @@ If found, those virtio devices will be created and added, so as a result
> of registering this remote processor, additional virtio drivers might get
> probed.
>
> +.. note::
> +
> + there is a resource managed version of this api called devm_rproc_add.

Please always use the function() notation. Also, starting the sentence
with a capital letter would be a nice touch.

Thanks,

jon