linux-kernel - Re: [RESEND PATCH V6 3/3] Documentation: remoteproc: add a note to rproc

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-ID: <87msi4qkn0.fsf@trenco.lwn.net>
Date: Tue, 12 Nov 2024 13:09:39 -0700
From: Jonathan Corbet <corbet@....net>
To: anish kumar <yesanishhere@...il.com>, andersson@...nel.org,
 mathieu.poirier@...aro.org
Cc: linux-kernel@...r.kernel.org, linux-doc@...r.kernel.org,
 linux-remoteproc@...r.kernel.org, anish kumar <yesanishhere@...il.com>
Subject: Re: [RESEND PATCH V6 3/3] Documentation: remoteproc: add a note to
 rproc_add

anish kumar <yesanishhere@...il.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@...il.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