[PATCH] staging: Pull in staging drivers docs into documentation tree

[PATCH] staging: Pull in staging drivers docs into documentation tree

[Bagas Sanjaya]

Some staging drivers have documentation that are spread out in
drivers/staging/*/Documentation/. Pull them into kernel docs tree by
using the same technique as in 1e9ddbb2cd346e ("docs: Pull LKMM
documentation into dev-tools book"): wrapping them with kernel-include::
directive as literal include.

Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
---
 .../staging-drivers/atomisp-notes.rst         | 10 ++++++++++
 .../staging-drivers/greybus-firmware.rst      | 12 ++++++++++++
 Documentation/staging-drivers/iio/index.rst   | 15 +++++++++++++++
 .../staging-drivers/iio/inkernel.rst          | 12 ++++++++++++
 Documentation/staging-drivers/iio/sysfs.rst   | 19 +++++++++++++++++++
 Documentation/staging-drivers/index.rst       | 13 +++++++++++++
 Documentation/staging-drivers/most/abi.rst    | 12 ++++++++++++
 .../staging-drivers/most/driver_usage.rst     | 12 ++++++++++++
 Documentation/staging-drivers/most/index.rst  | 10 ++++++++++
 Documentation/subsystem-apis.rst              |  1 +
 MAINTAINERS                                   |  1 +
 11 files changed, 117 insertions(+)
 create mode 100644 Documentation/staging-drivers/atomisp-notes.rst
 create mode 100644 Documentation/staging-drivers/greybus-firmware.rst
 create mode 100644 Documentation/staging-drivers/iio/index.rst
 create mode 100644 Documentation/staging-drivers/iio/inkernel.rst
 create mode 100644 Documentation/staging-drivers/iio/sysfs.rst
 create mode 100644 Documentation/staging-drivers/index.rst
 create mode 100644 Documentation/staging-drivers/most/abi.rst
 create mode 100644 Documentation/staging-drivers/most/driver_usage.rst
 create mode 100644 Documentation/staging-drivers/most/index.rst

diff --git a/Documentation/staging-drivers/atomisp-notes.rst b/Documentation/staging-drivers/atomisp-notes.rst
new file mode 100644
index 00000000000000..72ebb8970a067d
--- /dev/null
+++ b/Documentation/staging-drivers/atomisp-notes.rst
@@ -0,0 +1,10 @@
+.. SPDX-License-Identifier: GPL-2.0
+
+=====================================
+Notes on working with atomisp drivers
+=====================================
+
+Literal include of ``drivers/staging/media/atomisp/notes.txt``.
+
+.. kernel-include:: drivers/staging/media/atomisp/notes.txt
+   :literal:
diff --git a/Documentation/staging-drivers/greybus-firmware.rst b/Documentation/staging-drivers/greybus-firmware.rst
new file mode 100644
index 00000000000000..8e70942366f772
--- /dev/null
+++ b/Documentation/staging-drivers/greybus-firmware.rst
@@ -0,0 +1,12 @@
+.. SPDX-License-Identifier: GPL-2.0
+
+===========================
+Greybus firmware management
+===========================
+
+Literal include of ``drivers/staging/greybus/Documentation/firmware/firmware-management``.
+
+----
+
+.. kernel-include:: drivers/staging/greybus/Documentation/firmware/firmware-management
+   :literal:
diff --git a/Documentation/staging-drivers/iio/index.rst b/Documentation/staging-drivers/iio/index.rst
new file mode 100644
index 00000000000000..a6fccb8c8673d7
--- /dev/null
+++ b/Documentation/staging-drivers/iio/index.rst
@@ -0,0 +1,15 @@
+.. SPDX-License-Identifier: GPL-2.0
+
+=========================
+Industrial I/O in Staging
+=========================
+
+.. note::
+
+   Refer to Documentation/iio/index.rst for IIO subsystem documentation in
+   the kernel proper.
+
+.. toctree::
+
+   inkernel
+   sysfs
diff --git a/Documentation/staging-drivers/iio/inkernel.rst b/Documentation/staging-drivers/iio/inkernel.rst
new file mode 100644
index 00000000000000..0b7457bc4e4ad6
--- /dev/null
+++ b/Documentation/staging-drivers/iio/inkernel.rst
@@ -0,0 +1,12 @@
+.. SPDX-License-Identifier: GPL-2.0
+
+============================================
+Industrial I/O Subsystem in kernel consumers
+============================================
+
+Literal include of ``drivers/staging/iio/Documentation/inkernel.txt``.
+
+----
+
+.. kernel-include:: drivers/staging/iio/Documentation/inkernel.txt
+   :literal:
diff --git a/Documentation/staging-drivers/iio/sysfs.rst b/Documentation/staging-drivers/iio/sysfs.rst
new file mode 100644
index 00000000000000..9a069f1c5e669a
--- /dev/null
+++ b/Documentation/staging-drivers/iio/sysfs.rst
@@ -0,0 +1,19 @@
+.. SPDX-License-Identifer: GPL-2.0
+
+===============
+IIO ABI symbols
+===============
+
+Literal include of ``drivers/staging/iio/Documentation/sysfs-bus-iio-adc-ad7280a``.
+
+----
+
+.. kernel-include:: drivers/staging/iio/Documentation/sysfs-bus-iio-adc-ad7280a
+   :literal:
+
+----
+
+Literal include of ``drivers/staging/iio/Documentation/sysfs-bus-iio-dds``.
+
+.. kernel-include:: drivers/staging/iio/Documentation/sysfs-bus-iio-dds
+   :literal:
diff --git a/Documentation/staging-drivers/index.rst b/Documentation/staging-drivers/index.rst
new file mode 100644
index 00000000000000..7dfcf4ba32ec13
--- /dev/null
+++ b/Documentation/staging-drivers/index.rst
@@ -0,0 +1,13 @@
+.. SPDX-License-Identifier: GPL-2.0
+
+=============================
+Staging Drivers Documentation
+=============================
+
+.. toctree::
+   :maxdepth: 2
+
+   greybus-firmware
+   iio/index
+   atomisp-notes
+   most/index
diff --git a/Documentation/staging-drivers/most/abi.rst b/Documentation/staging-drivers/most/abi.rst
new file mode 100644
index 00000000000000..13f14bcd9a1b7d
--- /dev/null
+++ b/Documentation/staging-drivers/most/abi.rst
@@ -0,0 +1,12 @@
+.. SPDX-License-Identifier: GPL-2.0
+
+================
+MOST ABI Symbols
+================
+
+Literal include of ``drivers/staging/most/Documentation/ABI/sysfs-class-most.txt``.
+
+----
+
+.. kernel-include:: drivers/staging/most/Documentation/ABI/sysfs-class-most.txt
+   :literal:
diff --git a/Documentation/staging-drivers/most/driver_usage.rst b/Documentation/staging-drivers/most/driver_usage.rst
new file mode 100644
index 00000000000000..c22534b0e280a2
--- /dev/null
+++ b/Documentation/staging-drivers/most/driver_usage.rst
@@ -0,0 +1,12 @@
+.. SPDX-License-Identifier: GPL-2.0
+
+=================
+MOST Driver Usage
+=================
+
+Literal include of ``drivers/staging/most/Documentation/driver_usage.txt``.
+
+----
+
+.. kernel-include:: drivers/staging/most/Documentation/driver_usage.txt
+   :literal:
diff --git a/Documentation/staging-drivers/most/index.rst b/Documentation/staging-drivers/most/index.rst
new file mode 100644
index 00000000000000..29ffb1e6c06166
--- /dev/null
+++ b/Documentation/staging-drivers/most/index.rst
@@ -0,0 +1,10 @@
+.. SPDX-License-Identifier: GPL-2.0
+
+=======================================
+Media Oriented Systems Transport (MOST)
+=======================================
+
+.. toctree::
+
+   driver_usage
+   abi
diff --git a/Documentation/subsystem-apis.rst b/Documentation/subsystem-apis.rst
index ff4fe8c936c8ba..08fbf043f9f7e1 100644
--- a/Documentation/subsystem-apis.rst
+++ b/Documentation/subsystem-apis.rst
@@ -91,3 +91,4 @@ Other subsystems
    peci/index
    wmi/index
    tee/index
+   staging-drivers/index
diff --git a/MAINTAINERS b/MAINTAINERS
index 3da2c26a796b82..04dd4dd9ed9d22 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -24440,6 +24440,7 @@ L:	linux-staging@lists.linux.dev
 S:	Supported
 T:	git git://git.kernel.org/pub/scm/linux/kernel/git/gregkh/staging.git
 F:	drivers/staging/
+F:	Documentation/staging-drivers/
 
 STANDALONE CACHE CONTROLLER DRIVERS
 M:	Conor Dooley <conor@kernel.org>

base-commit: d68eb9096fb065cc0cb5218ae651f54b08de5831
-- 
An old man doll... just what I always wanted! - Clara

Re: [PATCH] staging: Pull in staging drivers docs into documentation tree

[Greg Kroah-Hartman]

On Sat, Nov 01, 2025 at 07:40:53PM +0700, Bagas Sanjaya wrote:
> Some staging drivers have documentation that are spread out in
> drivers/staging/*/Documentation/. Pull them into kernel docs tree by
> using the same technique as in 1e9ddbb2cd346e ("docs: Pull LKMM
> documentation into dev-tools book"): wrapping them with kernel-include::
> directive as literal include.
> 
> Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>

No, please do not do this.  staging drivers are "self contained" and do
not spread out into the rest of the kernel.  If/when the driver moves
out of staging, then it can be included in the normal kernel
documentation builds and the rest of the stuff (i.e. include/ locations
and the like.)

So leave them alone.  Documentation does not need to be built for
staging drivers, there are much bigger things that need to be done for
them instead.

thanks,

greg k-h

Re: [PATCH] staging: Pull in staging drivers docs into documentation tree

[Bagas Sanjaya]

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

On Sat, Nov 01, 2025 at 03:24:51PM +0100, Greg Kroah-Hartman wrote:
> On Sat, Nov 01, 2025 at 07:40:53PM +0700, Bagas Sanjaya wrote:
> > Some staging drivers have documentation that are spread out in
> > drivers/staging/*/Documentation/. Pull them into kernel docs tree by
> > using the same technique as in 1e9ddbb2cd346e ("docs: Pull LKMM
> > documentation into dev-tools book"): wrapping them with kernel-include::
> > directive as literal include.
> > 
> > Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
> 
> No, please do not do this.  staging drivers are "self contained" and do
> not spread out into the rest of the kernel.  If/when the driver moves
> out of staging, then it can be included in the normal kernel
> documentation builds and the rest of the stuff (i.e. include/ locations
> and the like.)
> 
> So leave them alone.  Documentation does not need to be built for
> staging drivers, there are much bigger things that need to be done for
> them instead.

OK, thanks!

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

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