linux-kernel - Re: [PATCH v7 2/2] docs: Integrate rustdoc generation into htmldocs

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: <88eefdcf-5398-97bc-161c-78f056c682a0@amd.com>
Date:   Tue, 18 Jul 2023 08:54:47 -0500
From:   Carlos Bilbao <carlos.bilbao@....com>
To:     Miguel Ojeda <miguel.ojeda.sandonis@...il.com>
Cc:     corbet@....net, ojeda@...nel.org, jani.nikula@...ux.intel.com,
        rdunlap@...radead.org, linux-doc@...r.kernel.org,
        linux-kernel@...r.kernel.org, konstantin@...uxfoundation.org,
        Akira Yokosawa <akiyks@...il.com>,
        rust-for-linux <rust-for-linux@...r.kernel.org>
Subject: Re: [PATCH v7 2/2] docs: Integrate rustdoc generation into htmldocs

On 7/17/23 11:39, Miguel Ojeda wrote:
> On Mon, Jul 17, 2023 at 5:17 PM Carlos Bilbao <carlos.bilbao@....com> wrote:
>>
>> +       # Let Sphinx know we will include rustdoc
>> +       ALLSPHINXOPTS   +=  -t rustdoc
> 
> This is needed in the previous patch, no? I don't know if it fails or
> just does not work, but either way, perhaps you can split that from
> the first commit to put it last.

The previous patch works without this, the generated HTML will show in the
Rust index:

  This documentation does not include rustdoc generated information.

> 
>> +else
>> +       @echo "   Skipping Rust documentation since CONFIG_RUST is not y."
>> +endif
> 
> Is this printed for everybody? If so, then I think it is a good idea
> for the future, but perhaps a bit annoying right for most users right
> now.

Fair point, will remove as part of v8.

> 
> Cheers,
> Miguel

(CC'ed rust-for-linux list)


Thanks,
Carlos