linux-doc.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: anish kumar <yesanishhere@gmail.com>
To: andersson@kernel.org, mathieu.poirier@linaro.org, corbet@lwn.net
Cc: linux-kernel@vger.kernel.org, linux-doc@vger.kernel.org,
	linux-remoteproc@vger.kernel.org,
	anish kumar <yesanishhere@gmail.com>
Subject: [RESEND PATCH V6 3/3] Documentation: remoteproc: add a note to rproc_add
Date: Tue,  5 Nov 2024 21:10:16 -0800	[thread overview]
Message-ID: <20241106051016.89113-4-yesanishhere@gmail.com> (raw)
In-Reply-To: <20241106051016.89113-1-yesanishhere@gmail.com>

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)


  parent reply	other threads:[~2024-11-06  5:10 UTC|newest]

Thread overview: 7+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2024-11-06  5:10 [RESEND PATCH V6 0/3] remoteproc documentation update anish kumar
2024-11-06  5:10 ` [RESEND PATCH V6 1/3] Documentation: remoteproc: update introduction section anish kumar
2024-11-13 16:49   ` Mathieu Poirier
2024-11-06  5:10 ` [RESEND PATCH V6 2/3] Documentation: remoteproc: add overview section anish kumar
2024-11-13 17:13   ` Mathieu Poirier
2024-11-06  5:10 ` anish kumar [this message]
2024-11-12 20:09   ` [RESEND PATCH V6 3/3] Documentation: remoteproc: add a note to rproc_add Jonathan Corbet

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20241106051016.89113-4-yesanishhere@gmail.com \
    --to=yesanishhere@gmail.com \
    --cc=andersson@kernel.org \
    --cc=corbet@lwn.net \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux-remoteproc@vger.kernel.org \
    --cc=mathieu.poirier@linaro.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).