linux-kernel - Re: [PATCH] docs: Integrate rustdoc-generated output to Rust docs

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: <CANiq72md-b75NQ2o7mDuGwK4JaPunrN36GZ2vUDm_yK+yocFtQ@mail.gmail.com>
Date:   Mon, 28 Nov 2022 22:06:32 +0100
From:   Miguel Ojeda <miguel.ojeda.sandonis@...il.com>
To:     Carlos Bilbao <carlos.bilbao@....com>
Cc:     corbet@....net, ojeda@...nel.org, linux-doc@...r.kernel.org,
        linux-kernel@...r.kernel.org, bilbao@...edu,
        Konstantin Ryabitsev <konstantin@...uxfoundation.org>
Subject: Re: [PATCH] docs: Integrate rustdoc-generated output to Rust docs

On Mon, Nov 28, 2022 at 9:19 PM Carlos Bilbao <carlos.bilbao@....com> wrote:
>
> Include HTML output generated from rustdoc into the Linux kernel
> documentation on Rust. Add Makefile target `make htmlrust` to combine
> make htmldocs and the generation of Rust documentation.

I think Konstantin (Cc'ing him) wanted us to integrate this into
`htmldocs`, rather than having a new target. That is, if `CONFIG_RUST`
is enabled, call the `rustdoc` target there.

In any case, I will also comment on this approach below. Thanks for this!

> +ifdef CONFIG_RUST
> +htmlrust:
> +       @make rustavailable

Why was this needed?

> +       @make LLVM=1 rustdoc
> +       @cp -r rust/doc/* Documentation/output/

We should change `rustdoc` to generate the docs directly in the right
place now that we have one.

Cheers,
Miguel