[PATCH 0/2] Documentation: Move rpmsg.rst and remoteproc.rst out of staging

[PATCH 0/2] Documentation: Move rpmsg.rst and remoteproc.rst out of staging

[Daniel Baluta]

Try to find a better place for rpmsg.rst and remoteproc.rst files.
Having them in staging suggest that rpmsg / remoteproc are not mature
enough which is not true.

Daniel Baluta (2):
  Documentation: Move rpmsg.rst and remoteproc.rst out of staging
  Documentation: Fix filenames for remoteproc/rpmsg

 Documentation/driver-api/index.rst                   | 2 ++
 Documentation/{staging => driver-api}/remoteproc.rst | 2 +-
 Documentation/{staging => driver-api}/rpmsg.rst      | 4 ++--
 Documentation/staging/index.rst                      | 2 --
 MAINTAINERS                                          | 4 ++--
 5 files changed, 7 insertions(+), 7 deletions(-)
 rename Documentation/{staging => driver-api}/remoteproc.rst (99%)
 rename Documentation/{staging => driver-api}/rpmsg.rst (99%)

-- 
2.45.2

[PATCH 1/2] Documentation: Move rpmsg.rst and remoteproc.rst out of staging

[Daniel Baluta]

rpmsg.rst and remoteproc.rst are documentation files for
mature remoteproc and rpmsg systems in the Linux kernel
so their place is not under staging.

Move them to Documentation/driver-api to better reflect that.

Signed-off-by: Daniel Baluta <daniel.baluta@nxp.com>
---
 Documentation/driver-api/index.rst                   | 2 ++
 Documentation/{staging => driver-api}/remoteproc.rst | 0
 Documentation/{staging => driver-api}/rpmsg.rst      | 0
 Documentation/staging/index.rst                      | 2 --
 MAINTAINERS                                          | 4 ++--
 5 files changed, 4 insertions(+), 4 deletions(-)
 rename Documentation/{staging => driver-api}/remoteproc.rst (100%)
 rename Documentation/{staging => driver-api}/rpmsg.rst (100%)

diff --git a/Documentation/driver-api/index.rst b/Documentation/driver-api/index.rst
index baff96b5cf0b..5321a9459440 100644
--- a/Documentation/driver-api/index.rst
+++ b/Documentation/driver-api/index.rst
@@ -129,8 +129,10 @@ Subsystem-specific APIs
    pwm
    pwrseq
    regulator
+   remoteproc
    reset
    rfkill
+   rpmsg
    s390-drivers
    scsi
    serial/index
diff --git a/Documentation/staging/remoteproc.rst b/Documentation/driver-api/remoteproc.rst
similarity index 100%
rename from Documentation/staging/remoteproc.rst
rename to Documentation/driver-api/remoteproc.rst
diff --git a/Documentation/staging/rpmsg.rst b/Documentation/driver-api/rpmsg.rst
similarity index 100%
rename from Documentation/staging/rpmsg.rst
rename to Documentation/driver-api/rpmsg.rst
diff --git a/Documentation/staging/index.rst b/Documentation/staging/index.rst
index 77bae5e5328b..de6dff862a0c 100644
--- a/Documentation/staging/index.rst
+++ b/Documentation/staging/index.rst
@@ -9,8 +9,6 @@ Unsorted Documentation
    crc32
    lzo
    magic-number
-   remoteproc
-   rpmsg
    speculation
    static-keys
    xz
diff --git a/MAINTAINERS b/MAINTAINERS
index 41ded579750c..490100765611 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -21898,7 +21898,7 @@ S:	Maintained
 T:	git https://git.kernel.org/pub/scm/linux/kernel/git/remoteproc/linux.git rproc-next
 F:	Documentation/ABI/testing/sysfs-class-remoteproc
 F:	Documentation/devicetree/bindings/remoteproc/
-F:	Documentation/staging/remoteproc.rst
+F:	Documentation/driver-api/remoteproc.rst
 F:	drivers/remoteproc/
 F:	include/linux/remoteproc.h
 F:	include/linux/remoteproc/
@@ -21910,7 +21910,7 @@ L:	linux-remoteproc@vger.kernel.org
 S:	Maintained
 T:	git https://git.kernel.org/pub/scm/linux/kernel/git/remoteproc/linux.git rpmsg-next
 F:	Documentation/ABI/testing/sysfs-bus-rpmsg
-F:	Documentation/staging/rpmsg.rst
+F:	Documentation/driver-api/rpmsg.rst
 F:	drivers/rpmsg/
 F:	include/linux/rpmsg.h
 F:	include/linux/rpmsg/
-- 
2.45.2

Re: [PATCH 1/2] Documentation: Move rpmsg.rst and remoteproc.rst out of staging

[Randy Dunlap]

On 11/13/25 10:57 PM, Daniel Baluta wrote:
> rpmsg.rst and remoteproc.rst are documentation files for
> mature remoteproc and rpmsg systems in the Linux kernel
> so their place is not under staging.
> 
> Move them to Documentation/driver-api to better reflect that.
> 
> Signed-off-by: Daniel Baluta <daniel.baluta@nxp.com>

LGTM. Thanks.

Reviewed-by: Randy Dunlap <rdunlap@infradead.org>

> ---
>  Documentation/driver-api/index.rst                   | 2 ++
>  Documentation/{staging => driver-api}/remoteproc.rst | 0
>  Documentation/{staging => driver-api}/rpmsg.rst      | 0
>  Documentation/staging/index.rst                      | 2 --
>  MAINTAINERS                                          | 4 ++--
>  5 files changed, 4 insertions(+), 4 deletions(-)
>  rename Documentation/{staging => driver-api}/remoteproc.rst (100%)
>  rename Documentation/{staging => driver-api}/rpmsg.rst (100%)
> 
> diff --git a/Documentation/driver-api/index.rst b/Documentation/driver-api/index.rst
> index baff96b5cf0b..5321a9459440 100644
> --- a/Documentation/driver-api/index.rst
> +++ b/Documentation/driver-api/index.rst
> @@ -129,8 +129,10 @@ Subsystem-specific APIs
>     pwm
>     pwrseq
>     regulator
> +   remoteproc
>     reset
>     rfkill
> +   rpmsg
>     s390-drivers
>     scsi
>     serial/index
> diff --git a/Documentation/staging/remoteproc.rst b/Documentation/driver-api/remoteproc.rst
> similarity index 100%
> rename from Documentation/staging/remoteproc.rst
> rename to Documentation/driver-api/remoteproc.rst
> diff --git a/Documentation/staging/rpmsg.rst b/Documentation/driver-api/rpmsg.rst
> similarity index 100%
> rename from Documentation/staging/rpmsg.rst
> rename to Documentation/driver-api/rpmsg.rst
> diff --git a/Documentation/staging/index.rst b/Documentation/staging/index.rst
> index 77bae5e5328b..de6dff862a0c 100644
> --- a/Documentation/staging/index.rst
> +++ b/Documentation/staging/index.rst
> @@ -9,8 +9,6 @@ Unsorted Documentation
>     crc32
>     lzo
>     magic-number
> -   remoteproc
> -   rpmsg
>     speculation
>     static-keys
>     xz
> diff --git a/MAINTAINERS b/MAINTAINERS
> index 41ded579750c..490100765611 100644
> --- a/MAINTAINERS
> +++ b/MAINTAINERS
> @@ -21898,7 +21898,7 @@ S:	Maintained
>  T:	git https://git.kernel.org/pub/scm/linux/kernel/git/remoteproc/linux.git rproc-next
>  F:	Documentation/ABI/testing/sysfs-class-remoteproc
>  F:	Documentation/devicetree/bindings/remoteproc/
> -F:	Documentation/staging/remoteproc.rst
> +F:	Documentation/driver-api/remoteproc.rst
>  F:	drivers/remoteproc/
>  F:	include/linux/remoteproc.h
>  F:	include/linux/remoteproc/
> @@ -21910,7 +21910,7 @@ L:	linux-remoteproc@vger.kernel.org
>  S:	Maintained
>  T:	git https://git.kernel.org/pub/scm/linux/kernel/git/remoteproc/linux.git rpmsg-next
>  F:	Documentation/ABI/testing/sysfs-bus-rpmsg
> -F:	Documentation/staging/rpmsg.rst
> +F:	Documentation/driver-api/rpmsg.rst
>  F:	drivers/rpmsg/
>  F:	include/linux/rpmsg.h
>  F:	include/linux/rpmsg/

-- 
~Randy

[PATCH 2/2] Documentation: Fix filenames for remoteproc/rpmsg

[Daniel Baluta]

Fix rpmsg and remoteproc filenames references after moving
them out of staging.

Signed-off-by: Daniel Baluta <daniel.baluta@nxp.com>
---
 Documentation/driver-api/remoteproc.rst | 2 +-
 Documentation/driver-api/rpmsg.rst      | 4 ++--
 2 files changed, 3 insertions(+), 3 deletions(-)

diff --git a/Documentation/driver-api/remoteproc.rst b/Documentation/driver-api/remoteproc.rst
index 5c226fa076d6..d7ff4694aba6 100644
--- a/Documentation/driver-api/remoteproc.rst
+++ b/Documentation/driver-api/remoteproc.rst
@@ -357,4 +357,4 @@ rpmsg virtio devices this way, if desired).
 Of course, RSC_VDEV resource entries are only good enough for static
 allocation of virtio devices. Dynamic allocations will also be made possible
 using the rpmsg bus (similar to how we already do dynamic allocations of
-rpmsg channels; read more about it in rpmsg.txt).
+rpmsg channels; read more about it in rpmsg.rst).
diff --git a/Documentation/driver-api/rpmsg.rst b/Documentation/driver-api/rpmsg.rst
index 40282cca86ca..a50c4db6679f 100644
--- a/Documentation/driver-api/rpmsg.rst
+++ b/Documentation/driver-api/rpmsg.rst
@@ -5,8 +5,8 @@ Remote Processor Messaging (rpmsg) Framework
 .. note::
 
   This document describes the rpmsg bus and how to write rpmsg drivers.
-  To learn how to add rpmsg support for new platforms, check out remoteproc.txt
-  (also a resident of Documentation/).
+  To learn how to add rpmsg support for new platforms, check out remoteproc.rst
+  (also a resident of Documentation/driver-api).
 
 Introduction
 ============
-- 
2.45.2

Re: [PATCH 2/2] Documentation: Fix filenames for remoteproc/rpmsg

[Bagas Sanjaya]

[-- Attachment #1: Type: text/plain, Size: 665 bytes --]

On Fri, Nov 14, 2025 at 08:57:45AM +0200, Daniel Baluta wrote:
>    This document describes the rpmsg bus and how to write rpmsg drivers.
> -  To learn how to add rpmsg support for new platforms, check out remoteproc.txt
> -  (also a resident of Documentation/).
> +  To learn how to add rpmsg support for new platforms, check out remoteproc.rst
> +  (also a resident of Documentation/driver-api).

I think "also a resident of ..." can be dropped, since it's redundant (it's
already covered in remoteproc.rst cross-reference which transforms into
the link when you build the docs).

Thanks.

-- 
An old man doll... just what I always wanted! - Clara

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 228 bytes --]

Re: [PATCH 2/2] Documentation: Fix filenames for remoteproc/rpmsg

[Daniel Baluta]

On Fri, Nov 14, 2025 at 12:29 PM Bagas Sanjaya <bagasdotme@gmail.com> wrote:
>
> On Fri, Nov 14, 2025 at 08:57:45AM +0200, Daniel Baluta wrote:
> >    This document describes the rpmsg bus and how to write rpmsg drivers.
> > -  To learn how to add rpmsg support for new platforms, check out remoteproc.txt
> > -  (also a resident of Documentation/).
> > +  To learn how to add rpmsg support for new platforms, check out remoteproc.rst
> > +  (also a resident of Documentation/driver-api).
>
> I think "also a resident of ..." can be dropped, since it's redundant (it's
> already covered in remoteproc.rst cross-reference which transforms into
> the link when you build the docs).

My point here is just to move the patches to a better location without
any crucial modification.
I can send a follow up patch if this is fine with everyone.

Re: [PATCH 2/2] Documentation: Fix filenames for remoteproc/rpmsg

[Bagas Sanjaya]

On 11/14/25 18:33, Daniel Baluta wrote:
> On Fri, Nov 14, 2025 at 12:29 PM Bagas Sanjaya <bagasdotme@gmail.com> wrote:
>>
>> On Fri, Nov 14, 2025 at 08:57:45AM +0200, Daniel Baluta wrote:
>>>     This document describes the rpmsg bus and how to write rpmsg drivers.
>>> -  To learn how to add rpmsg support for new platforms, check out remoteproc.txt
>>> -  (also a resident of Documentation/).
>>> +  To learn how to add rpmsg support for new platforms, check out remoteproc.rst
>>> +  (also a resident of Documentation/driver-api).
>>
>> I think "also a resident of ..." can be dropped, since it's redundant (it's
>> already covered in remoteproc.rst cross-reference which transforms into
>> the link when you build the docs).
> 
> My point here is just to move the patches to a better location without
> any crucial modification.
> I can send a follow up patch if this is fine with everyone.

OK, thanks!

-- 
An old man doll... just what I always wanted! - Clara

Re: [PATCH 2/2] Documentation: Fix filenames for remoteproc/rpmsg

[Mathieu Poirier]

On Fri, Nov 14, 2025 at 01:33:57PM +0200, Daniel Baluta wrote:
> On Fri, Nov 14, 2025 at 12:29 PM Bagas Sanjaya <bagasdotme@gmail.com> wrote:
> >
> > On Fri, Nov 14, 2025 at 08:57:45AM +0200, Daniel Baluta wrote:
> > >    This document describes the rpmsg bus and how to write rpmsg drivers.
> > > -  To learn how to add rpmsg support for new platforms, check out remoteproc.txt
> > > -  (also a resident of Documentation/).
> > > +  To learn how to add rpmsg support for new platforms, check out remoteproc.rst
> > > +  (also a resident of Documentation/driver-api).
> >
> > I think "also a resident of ..." can be dropped, since it's redundant (it's
> > already covered in remoteproc.rst cross-reference which transforms into
> > the link when you build the docs).
> 
> My point here is just to move the patches to a better location without
> any crucial modification.

I agree.

> I can send a follow up patch if this is fine with everyone.

Re: [PATCH 2/2] Documentation: Fix filenames for remoteproc/rpmsg

[Randy Dunlap]

On 11/13/25 10:57 PM, Daniel Baluta wrote:
> Fix rpmsg and remoteproc filenames references after moving
> them out of staging.
> 
> Signed-off-by: Daniel Baluta <daniel.baluta@nxp.com>

LGTM. Thanks.

Reviewed-by: Randy Dunlap <rdunlap@infradead.org>

> ---
>  Documentation/driver-api/remoteproc.rst | 2 +-
>  Documentation/driver-api/rpmsg.rst      | 4 ++--
>  2 files changed, 3 insertions(+), 3 deletions(-)
> 
> diff --git a/Documentation/driver-api/remoteproc.rst b/Documentation/driver-api/remoteproc.rst
> index 5c226fa076d6..d7ff4694aba6 100644
> --- a/Documentation/driver-api/remoteproc.rst
> +++ b/Documentation/driver-api/remoteproc.rst
> @@ -357,4 +357,4 @@ rpmsg virtio devices this way, if desired).
>  Of course, RSC_VDEV resource entries are only good enough for static
>  allocation of virtio devices. Dynamic allocations will also be made possible
>  using the rpmsg bus (similar to how we already do dynamic allocations of
> -rpmsg channels; read more about it in rpmsg.txt).
> +rpmsg channels; read more about it in rpmsg.rst).
> diff --git a/Documentation/driver-api/rpmsg.rst b/Documentation/driver-api/rpmsg.rst
> index 40282cca86ca..a50c4db6679f 100644
> --- a/Documentation/driver-api/rpmsg.rst
> +++ b/Documentation/driver-api/rpmsg.rst
> @@ -5,8 +5,8 @@ Remote Processor Messaging (rpmsg) Framework
>  .. note::
>  
>    This document describes the rpmsg bus and how to write rpmsg drivers.
> -  To learn how to add rpmsg support for new platforms, check out remoteproc.txt
> -  (also a resident of Documentation/).
> +  To learn how to add rpmsg support for new platforms, check out remoteproc.rst
> +  (also a resident of Documentation/driver-api).
>  
>  Introduction
>  ============

-- 
~Randy

Re: [PATCH 0/2] Documentation: Move rpmsg.rst and remoteproc.rst out of staging

[Mathieu Poirier]

On Fri, Nov 14, 2025 at 08:57:43AM +0200, Daniel Baluta wrote:
> Try to find a better place for rpmsg.rst and remoteproc.rst files.
> Having them in staging suggest that rpmsg / remoteproc are not mature
> enough which is not true.
> 
> Daniel Baluta (2):
>   Documentation: Move rpmsg.rst and remoteproc.rst out of staging
>   Documentation: Fix filenames for remoteproc/rpmsg
> 
>  Documentation/driver-api/index.rst                   | 2 ++
>  Documentation/{staging => driver-api}/remoteproc.rst | 2 +-
>  Documentation/{staging => driver-api}/rpmsg.rst      | 4 ++--
>  Documentation/staging/index.rst                      | 2 --
>  MAINTAINERS                                          | 4 ++--
>  5 files changed, 7 insertions(+), 7 deletions(-)
>  rename Documentation/{staging => driver-api}/remoteproc.rst (99%)
>  rename Documentation/{staging => driver-api}/rpmsg.rst (99%)

Reviewed-by: Mathieu Poirier <mathieu.poirier@linaro.org>

> 
> -- 
> 2.45.2
>