linux-kernel - Re: [PATCH v2] docs: Integrate rustdoc into Rust 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] [thread-next>] [day] [month] [year] [list]

Date:   Tue, 6 Dec 2022 16:39:57 +0100
From:   Miguel Ojeda <miguel.ojeda.sandonis@...il.com>
To:     Akira Yokosawa <akiyks@...il.com>
Cc:     Carlos Bilbao <carlos.bilbao@....com>, ojeda@...nel.org,
        linux-kernel@...r.kernel.org, linux-doc@...r.kernel.org,
        bilbao@...edu, corbet@....net, konstantin@...uxfoundation.org
Subject: Re: [PATCH v2] docs: Integrate rustdoc into Rust documentation

On Tue, Dec 6, 2022 at 2:32 PM Akira Yokosawa <akiyks@...il.com> wrote:
>
> Why is RUSTDOC invoked when there is no change in rustdoc?

I think we can give proper dependencies to `rustdoc`, so if that is
the main concern, then it should be OK.

But note that `htmldocs` also calls Sphinx every run. It does a subset
of the work, but perhaps we can save some time there if we could
detect whether anything changed.

> I think you can add a new target in the top-devel Makefile which
> runs both rustdoc and htmldocs for CIs. Something like 'htmldocsboth'
> or 'htmldocsall'???
>
> htmldocs and other *docs targets are the most primitive ones for
> running Sphinx, so my gut feeling tells me _not_ to contaminate
> htmldocs with rustdoc or vice versa.

That is reasonable, but others wanted it in `htmldocs` (and the goal
is to eventually do so, so if we can do it already, even better).

Cheers,
Miguel