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

Daniel Baluta posted 2 patches 2 months, 3 weeks ago
[PATCH 2/2] Documentation: Fix filenames for remoteproc/rpmsg
Posted by Daniel Baluta 2 months, 3 weeks ago
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
Posted by Randy Dunlap 2 months, 3 weeks ago

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 2/2] Documentation: Fix filenames for remoteproc/rpmsg
Posted by Bagas Sanjaya 2 months, 3 weeks ago
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
Re: [PATCH 2/2] Documentation: Fix filenames for remoteproc/rpmsg
Posted by Daniel Baluta 2 months, 3 weeks ago
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
Posted by Mathieu Poirier 2 months, 3 weeks ago
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
Posted by Bagas Sanjaya 2 months, 3 weeks ago
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