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

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: <2025110115-nineteen-diner-186e@gregkh>
Date: Sat, 1 Nov 2025 15:24:51 +0100
From: Greg Kroah-Hartman <gregkh@...uxfoundation.org>
To: Bagas Sanjaya <bagasdotme@...il.com>
Cc: Linux Kernel Mailing List <linux-kernel@...r.kernel.org>,
	Linux Documentation <linux-doc@...r.kernel.org>,
	Linux Staging Drivers <linux-staging@...ts.linux.dev>,
	Jonathan Corbet <corbet@....net>, Akira Yokosawa <akiyks@...il.com>
Subject: Re: [PATCH] staging: Pull in staging drivers docs into documentation
 tree

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@...il.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