Re: [PATCH 14/19] docs: add Rust documentation
From: Nick Desaulniers <hidden>
Date: 2021-12-08 01:30:10
Also in:
linux-kbuild, lkml, rust-for-linux
From: Nick Desaulniers <hidden>
Date: 2021-12-08 01:30:10
Also in:
linux-kbuild, lkml, rust-for-linux
On Mon, Dec 6, 2021 at 6:07 AM Miguel Ojeda [off-list ref] wrote:
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.
I'm sure Documentation/rust/ will grow over time; there's certainly more that can be added and core kernel devs will have more questions over time. I'm still running into a SNAFU actually building; see https://lore.kernel.org/lkml/CAKwvOdk9VNenJJN5HnPpGgsHT+OsRsgPGSesQgqMP2aLPWy0NQ@mail.gmail.com/ (local). But I read through all that was added here and didn't find anything problematic IMO. I didn't verify the png's are actually the logo... I don't think `make htmldocs` produced any new warnings, though it's not exactly warning free at the moment (pre-existing before this series).
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.
How is rust-logo.png being included in the docs? Is there something with RST that isn't grep'able for rust-logo.png?
-- 2.34.0
-- Thanks, ~Nick Desaulniers