Re: [PATCH V4 1/7] Remoteproc: Documentation: add the main index

[Mathieu Poirier <mathieu.poirier@linaro.org>]

On Tue, Oct 22, 2024 at 10:33:51PM -0700, anish kumar wrote:
> In prepration of moving the remoteproc documentation
> from staging to mainline and also for enhancing
> the documentation.
> 
> Signed-off-by: anish kumar <yesanishhere@gmail.com>
> ---
>  Documentation/driver-api/index.rst            |  1 +
>  Documentation/driver-api/remoteproc/index.rst | 20 +++++++++++++++++++
>  2 files changed, 21 insertions(+)
>  create mode 100644 Documentation/driver-api/remoteproc/index.rst
> 
> diff --git a/Documentation/driver-api/index.rst b/Documentation/driver-api/index.rst
> index c57c609ad2eb..ec9d669b92e5 100644
> --- a/Documentation/driver-api/index.rst
> +++ b/Documentation/driver-api/index.rst
> @@ -30,6 +30,7 @@ available subsections can be seen below.
>     frame-buffer
>     regulator
>     reset
> +   remoteproc/index

This patch doesn't apply to rproc-next and I'm pretty sure it is the same for
Jonathan's tree. 

>     iio/index
>     input
>     usb/index
> diff --git a/Documentation/driver-api/remoteproc/index.rst b/Documentation/driver-api/remoteproc/index.rst
> new file mode 100644
> index 000000000000..8b8c8f512e2b
> --- /dev/null
> +++ b/Documentation/driver-api/remoteproc/index.rst
> @@ -0,0 +1,20 @@
> +.. SPDX-License-Identifier: GPL-2.0
> +
> +========================================================================
> +remoteproc - remote processor subsystem in Linux(TM) kernel
> +========================================================================
> +
> +Authors:
> +	- anish kumar  <yesanishhere@gmail.com>
> +
> +   remote processor subsystem is a way to manage the lifecycle of
> +   a subsytem that is external to the Linux. The remoteproc framework

... external to the Linux kernel.

> +   allows different platforms/architectures to control (power on,
> +   load firmware, power off) those remote processors while abstracting
> +   the hardware differences, so the entire driver doesn't need to be
> +   duplicated.
> +
> +Mailing List
> +------------
> +To post a message, send an email to
> +linux-remoteproc@vger.kernel.org
> -- 
> 2.39.3 (Apple Git-146)
>