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

anish kumar posted 3 patches 2 weeks, 4 days ago
[RESEND PATCH V6 3/3] Documentation: remoteproc: add a note to rproc_add
Posted by anish kumar 2 weeks, 4 days ago
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@gmail.com>
---
 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.
+  Most of the times, you should use that unless you need to explicitly
+  control the rproc registration with the core. If you are using devm
+  variant of this api, then rproc_del will automatically get called when
+  driver is unloaded.
+
 ::
 
   int rproc_del(struct rproc *rproc)
-- 
2.39.3 (Apple Git-146)
Re: [RESEND PATCH V6 3/3] Documentation: remoteproc: add a note to rproc_add
Posted by Jonathan Corbet 1 week, 4 days ago
anish kumar <yesanishhere@gmail.com> 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@gmail.com>
> ---
>  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