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

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:
 <PAXPR04MB9185B7827B1CCD1CD8D0E9B389CDA@PAXPR04MB9185.eurprd04.prod.outlook.com>
Date: Thu, 13 Nov 2025 22:23:38 +0000
From: Shenwei Wang <shenwei.wang@....com>
To: Randy Dunlap <rdunlap@...radead.org>, Daniel Baluta
	<daniel.baluta@...il.com>, Rob Herring <robh@...nel.org>
CC: Bjorn Andersson <andersson@...nel.org>, Mathieu Poirier
	<mathieu.poirier@...aro.org>, Krzysztof Kozlowski <krzk+dt@...nel.org>, Conor
 Dooley <conor+dt@...nel.org>, Shawn Guo <shawnguo@...nel.org>, Sascha Hauer
	<s.hauer@...gutronix.de>, Jonathan Corbet <corbet@....net>, Linus Walleij
	<linus.walleij@...aro.org>, Bartosz Golaszewski <brgl@...ev.pl>, Pengutronix
 Kernel Team <kernel@...gutronix.de>, Fabio Estevam <festevam@...il.com>, Peng
 Fan <peng.fan@....com>, "linux-remoteproc@...r.kernel.org"
	<linux-remoteproc@...r.kernel.org>, "devicetree@...r.kernel.org"
	<devicetree@...r.kernel.org>, "imx@...ts.linux.dev" <imx@...ts.linux.dev>,
	"linux-arm-kernel@...ts.infradead.org"
	<linux-arm-kernel@...ts.infradead.org>, "linux-kernel@...r.kernel.org"
	<linux-kernel@...r.kernel.org>, "linux-doc@...r.kernel.org"
	<linux-doc@...r.kernel.org>, dl-linux-imx <linux-imx@....com>
Subject: Re: [PATCH v5 3/5] docs: staging: gpio-rpmsg: gpio over rpmsg bus



> -----Original Message-----
> From: Randy Dunlap <rdunlap@...radead.org>
> Sent: Wednesday, November 12, 2025 3:18 PM
> To: Daniel Baluta <daniel.baluta@...il.com>; Rob Herring <robh@...nel.org>
> Cc: Shenwei Wang <shenwei.wang@....com>; Bjorn Andersson
> <andersson@...nel.org>; Mathieu Poirier <mathieu.poirier@...aro.org>;
> Krzysztof Kozlowski <krzk+dt@...nel.org>; Conor Dooley
> <conor+dt@...nel.org>; Shawn Guo <shawnguo@...nel.org>; Sascha Hauer
> <s.hauer@...gutronix.de>; Jonathan Corbet <corbet@....net>; Linus Walleij
> <linus.walleij@...aro.org>; Bartosz Golaszewski <brgl@...ev.pl>; Pengutronix
> Kernel Team <kernel@...gutronix.de>; Fabio Estevam <festevam@...il.com>;
> Peng Fan <peng.fan@....com>; linux-remoteproc@...r.kernel.org;
> devicetree@...r.kernel.org; imx@...ts.linux.dev; linux-arm-
> kernel@...ts.infradead.org; linux-kernel@...r.kernel.org; linux-
> doc@...r.kernel.org; dl-linux-imx <linux-imx@....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@...nel.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@....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