Re: [PATCH 14/19] docs: add Rust documentation
From: Miguel Ojeda <hidden>
Date: 2021-12-08 23:07:38
Also in:
linux-kbuild, lkml, rust-for-linux
From: Miguel Ojeda <hidden>
Date: 2021-12-08 23:07:38
Also in:
linux-kbuild, lkml, rust-for-linux
On Wed, Dec 8, 2021 at 2:30 AM Nick Desaulniers [off-list ref] wrote:
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
Indeed -- the comment is only trying to emphasize (or explain) that this might be a difference with respect to C, i.e. that we should try to put as much of the documentation as possible closer to the code, rather than create "far" files in `Documentation/rust`. I will try to clarify the comment.
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...
Thanks for reading through all of it!
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).
Yeah, I also run `make htmldocs` before submitting the patch series rounds. And indeed, there are quite a few warnings (20+?), but none coming from `Documentation/rust` that I could see.
How is rust-logo.png being included in the docs? Is there something with RST that isn't grep'able for rust-logo.png?
At the moment, the assets are simply copied to the output folder, in the `rust/Makefile`. (I should provide an SVG too or remove the reference to it, by the way). Cheers, Miguel