linux-kernel - Re: [RFC] Integrate Rust code documentation into Documentation/

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] [day] [month] [year] [list]

Message-ID: <CANiq72kRB=g_G4cJUZKreKc+qP2npLf6ze8HJMzpBrA6YfDW9g@mail.gmail.com>
Date:   Tue, 22 Nov 2022 00:52:03 +0100
From:   Miguel Ojeda <miguel.ojeda.sandonis@...il.com>
To:     Jonathan Corbet <corbet@....net>
Cc:     Carlos Bilbao <bilbao@...edu>, ojeda@...nel.org,
        alex.gaynor@...il.com, wedsonaf@...il.com, boqun.feng@...il.com,
        linux-kernel@...r.kernel.org, linux-doc@...r.kernel.org,
        Konstantin Ryabitsev <konstantin@...uxfoundation.org>
Subject: Re: [RFC] Integrate Rust code documentation into Documentation/

On Mon, Nov 21, 2022 at 10:39 PM Jonathan Corbet <corbet@....net> wrote:
>
> Carlos Bilbao <bilbao@...edu> writes:
>
> > I propose we include in 'make htmldocs' the option to integrate
> > rustdoc-generated information. We could create and use
> > Documentation/rust/rustdoc.rst as linking point for that HTML. This
> > wouldn't be costly for the kernel itself. More importantly, the kernel
> > website could host this information by default.
>
> I'm all in favor of including that output, just haven't had the time to
> try to figure out how to make it actually work.  Got a patch that
> implements this behavior? :)

Agreed, generating them in `make htmldocs` is also what Konstantin
(Cc'd) proposed a long time ago. In which case, I assume he will need
to add the toolchain to some infrastructure so that we actually get
them.

There are a couple bits to handle: they should only be generated if
the Rust toolchain is available (and if the Rust support is enabled,
really; and probably that suggested `rustdoc.rst` should reflect the
result too). Also, the existing target depends on a kernel config --
we may use x86_64 allyesconfig for the moment.

Cheers,
Miguel