linux-staging.lists.linux.dev archive mirror
 help / color / mirror / Atom feed
From: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
To: Bagas Sanjaya <bagasdotme@gmail.com>
Cc: Linux Kernel Mailing List <linux-kernel@vger.kernel.org>,
	Linux Documentation <linux-doc@vger.kernel.org>,
	Linux Staging Drivers <linux-staging@lists.linux.dev>,
	Jonathan Corbet <corbet@lwn.net>,
	Akira Yokosawa <akiyks@gmail.com>
Subject: Re: [PATCH] staging: Pull in staging drivers docs into documentation tree
Date: Sat, 1 Nov 2025 15:24:51 +0100	[thread overview]
Message-ID: <2025110115-nineteen-diner-186e@gregkh> (raw)
In-Reply-To: <20251101124053.62544-1-bagasdotme@gmail.com>

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

  reply	other threads:[~2025-11-01 14:24 UTC|newest]

Thread overview: 3+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2025-11-01 12:40 [PATCH] staging: Pull in staging drivers docs into documentation tree Bagas Sanjaya
2025-11-01 14:24 ` Greg Kroah-Hartman [this message]
2025-11-01 23:55   ` Bagas Sanjaya

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=2025110115-nineteen-diner-186e@gregkh \
    --to=gregkh@linuxfoundation.org \
    --cc=akiyks@gmail.com \
    --cc=bagasdotme@gmail.com \
    --cc=corbet@lwn.net \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux-staging@lists.linux.dev \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).