linux-kernel - Re: [PATCH 0/1] fix rustdoc build detection

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: <CANiq72m3deG_QsH8-AskTR9LcNL=G6E9o2fu+oi9RVXn1PK_+Q@mail.gmail.com>
Date: Mon, 17 Nov 2025 12:22:48 +0100
From: Miguel Ojeda <miguel.ojeda.sandonis@...il.com>
To: Mauro Carvalho Chehab <mchehab+huawei@...nel.org>, Carlos Bilbao <carlos.bilbao@...nel.org>
Cc: Linux Doc Mailing List <linux-doc@...r.kernel.org>, Jonathan Corbet <corbet@....net>, 
	Mauro Carvalho Chehab <mchehab@...nel.org>, linux-kernel@...r.kernel.org, 
	Miguel Ojeda <ojeda@...nel.org>
Subject: Re: [PATCH 0/1] fix rustdoc build detection

On Mon, Nov 17, 2025 at 11:48 AM Mauro Carvalho Chehab
<mchehab+huawei@...nel.org> wrote:
>
> Sure, Sphinx (including kernel-doc) build and rust doca build are
> independent. Yet, Makefile "htmldocs" target currently does both.
>
> It could make sense to have a separate target if one want to build
> them both, e.g. something like:

My understanding (Cc'ing Carlos) is that the idea was that `htmldocs`
built the Rust docs if possible.

I don't mind if that is changed etc., but I think it is important to
keep the `rustdoc` target simple and focused: it is a "basic"
operation (which is also used to lint docs too), and way faster than
building the HTML docs, and it doesn't depend on them.

Apologies if I put it perhaps a bit too tersely in my previous message
-- everyone contributing to Rust code is supposed to rely on that
target to test their commits, and needing the whole Sphinx setup would
make the target way worse in practice.

Now, in the future, if we start relying on generating references for
the Rust docs from the C side and things like that (which is my plan,
but it is long term: first item in
https://github.com/Rust-for-Linux/linux/issues/350), we may need to
rethink things a bit (i.e. we may need to run a subset of the kernel
normal docs to build the Rust docs), but even then ideally we should
only introduce the minimal dependency needed.

I hope that clarifies -- thanks!

Cheers,
Miguel