linux-kernel - Re: [PATCH v3 14/19] docs: add 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]

Message-ID: <87fspk1xoc.fsf@meer.lwn.net>
Date:   Tue, 18 Jan 2022 15:33:39 -0700
From:   Jonathan Corbet <corbet@....net>
To:     Miguel Ojeda <ojeda@...nel.org>,
        Linus Torvalds <torvalds@...ux-foundation.org>,
        Greg Kroah-Hartman <gregkh@...uxfoundation.org>
Cc:     rust-for-linux@...r.kernel.org, linux-kbuild@...r.kernel.org,
        linux-doc@...r.kernel.org, linux-kernel@...r.kernel.org,
        Miguel Ojeda <ojeda@...nel.org>,
        Alex Gaynor <alex.gaynor@...il.com>,
        Finn Behrens <me@...enk.de>,
        Adam Bratschi-Kaye <ark.email@...il.com>,
        Wedson Almeida Filho <wedsonaf@...gle.com>,
        Michael Ellerman <mpe@...erman.id.au>,
        Sven Van Asbroeck <thesven73@...il.com>,
        Wu XiangCheng <bobwxc@...il.cn>, Gary Guo <gary@...yguo.net>,
        Boris-Chengbiao Zhou <bobo1239@....de>,
        Yuki Okushi <jtitor@...6.org>, Wei Liu <wei.liu@...nel.org>,
        Daniel Xu <dxu@...uu.xyz>
Subject: Re: [PATCH v3 14/19] docs: add Rust documentation

Miguel Ojeda <ojeda@...nel.org> writes:

> Most of the documentation for Rust is written within the source code
> itself, as it is idiomatic for Rust projects. This applies to both
> the shared infrastructure at `rust/` as well as any other Rust module
> (e.g. drivers) written across the kernel.
>
> However, these documents contain general information that does not
> fit particularly well in the source code, like the Quick Start guide.
>
> It also contains a few binary assets used for the `rustdoc` target
> and a few other small changes elsewhere in the documentation folder.

Glad to see documentation!

That said, I have one little request...

>  Documentation/doc-guide/kernel-doc.rst      |   3 +
>  Documentation/index.rst                     |   1 +
>  Documentation/kbuild/kbuild.rst             |   4 +
>  Documentation/process/changes.rst           |  42 ++++
>  Documentation/rust/arch-support.rst         |  35 +++
>  Documentation/rust/assets/favicon-16x16.png | Bin 0 -> 798 bytes
>  Documentation/rust/assets/favicon-32x32.png | Bin 0 -> 2076 bytes
>  Documentation/rust/assets/rust-logo.png     | Bin 0 -> 53976 bytes

We have really tried to keep binary files (like PNG images) out of the
documentation tree.  If we really need these images, can they be
provided in SVG form?

Thanks,

jon