Re: [PATCH v5 3/5] docs: staging: gpio-rpmsg: gpio over rpmsg bus

Shenwei Wang
2025-11-13T22:23:42Z

> -----Original Message-----
> From: Randy Dunlap <rdunlap@infradead.org>
> Sent: Wednesday, November 12, 2025 3:18 PM
> To: Daniel Baluta <daniel.baluta@gmail.com>; Rob Herring <robh@kernel.org>
> Cc: Shenwei Wang <shenwei.wang@nxp.com>; Bjorn Andersson
> <andersson@kernel.org>; Mathieu Poirier <mathieu.poirier@linaro.org>;
> Krzysztof Kozlowski <krzk+dt@kernel.org>; Conor Dooley
> <conor+dt@kernel.org>; Shawn Guo <shawnguo@kernel.org>; Sascha Hauer
> <s.hauer@pengutronix.de>; Jonathan Corbet <corbet@lwn.net>; Linus Walleij
> <linus.walleij@linaro.org>; Bartosz Golaszewski <brgl@bgdev.pl>; Pengutronix
> Kernel Team <kernel@pengutronix.de>; Fabio Estevam <festevam@gmail.com>;
> Peng Fan <peng.fan@nxp.com>; linux-remoteproc@vger.kernel.org;
> devicetree@vger.kernel.org; imx@lists.linux.dev; linux-arm-
> kernel@lists.infradead.org; linux-kernel@vger.kernel.org; linux-
> doc@vger.kernel.org; dl-linux-imx <linux-imx@nxp.com>
> Subject: [EXT] Re: [PATCH v5 3/5] docs: staging: gpio-rpmsg: gpio over rpmsg bus
> On 11/12/25 5:35 AM, Daniel Baluta wrote:
> > On Wed, Nov 12, 2025 at 2:59 PM Rob Herring <robh@kernel.org> wrote:
> >>
> >> On Tue, Nov 04, 2025 at 02:33:13PM -0600, Shenwei Wang wrote:
> >>> Describes the gpio rpmsg transport protocol over the rpmsg bus
> >>> between the cores.
> >>>
> >>> Signed-off-by: Shenwei Wang <shenwei.wang@nxp.com>
> >>> ---
> >>> Documentation/staging/gpio-rpmsg.rst | 202
> +++++++++++++++++++++++++++
> >>> Documentation/staging/index.rst | 1 +
> >>
> >> Why is this in staging when none of the drivers are?
> >
> > I guess that's because remoteproc.rst and rpmsg.rst are in
> > Documentation/staging and that's because when converting them from
> > .txt to .rst the author didn't know a good place where to move them.
> >
> > Would Documentation/driver-api be a good place for these doc files? I
> > can move them and then Shenwei place the gpio-rpmsg.rst in the
> > Documentation/driver-api also
>
> Documentation/driver-api/gpio/ if its driver documentation.
> Documentation/userspace-api/gpio/ if it user API docs There is also gpio
> documentation in Documentation/admin-guide/gpio/ which could also be
> appropriate depending on the nature of the document.
>

Thanks Randy!

Do we have a final decision on where to place this document?
My thought is that Documentation/driver-api/gpio/ seems more appropriate.
However, it’s worth noting that while this is a driver-related document, it doesn’t describe the driver API itself.

Thanks,
Shenwei

> --
> ~Randy