docs: add Rust documentation
authorMiguel Ojeda <ojeda@kernel.org>
Sat, 3 Jul 2021 15:23:16 +0000 (17:23 +0200)
committerMiguel Ojeda <ojeda@kernel.org>
Mon, 17 Jan 2022 02:23:45 +0000 (03:23 +0100)
commit78b471443e278281048081e39e8d6d3097920812
tree61622dac65dc9e5c1b50fa3b0e5e1e36386bd29b
parentf3714fe26fb9cf6328882f967a00389fbe5e4098
docs: add Rust documentation

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.

Co-developed-by: Alex Gaynor <alex.gaynor@gmail.com>
Signed-off-by: Alex Gaynor <alex.gaynor@gmail.com>
Co-developed-by: Finn Behrens <me@kloenk.de>
Signed-off-by: Finn Behrens <me@kloenk.de>
Co-developed-by: Adam Bratschi-Kaye <ark.email@gmail.com>
Signed-off-by: Adam Bratschi-Kaye <ark.email@gmail.com>
Co-developed-by: Wedson Almeida Filho <wedsonaf@google.com>
Signed-off-by: Wedson Almeida Filho <wedsonaf@google.com>
Co-developed-by: Michael Ellerman <mpe@ellerman.id.au>
Signed-off-by: Michael Ellerman <mpe@ellerman.id.au>
Co-developed-by: Sven Van Asbroeck <thesven73@gmail.com>
Signed-off-by: Sven Van Asbroeck <thesven73@gmail.com>
Co-developed-by: Wu XiangCheng <bobwxc@email.cn>
Signed-off-by: Wu XiangCheng <bobwxc@email.cn>
Co-developed-by: Gary Guo <gary@garyguo.net>
Signed-off-by: Gary Guo <gary@garyguo.net>
Co-developed-by: Boris-Chengbiao Zhou <bobo1239@web.de>
Signed-off-by: Boris-Chengbiao Zhou <bobo1239@web.de>
Co-developed-by: Yuki Okushi <jtitor@2k36.org>
Signed-off-by: Yuki Okushi <jtitor@2k36.org>
Co-developed-by: Wei Liu <wei.liu@kernel.org>
Signed-off-by: Wei Liu <wei.liu@kernel.org>
Co-developed-by: Daniel Xu <dxu@dxuuu.xyz>
Signed-off-by: Daniel Xu <dxu@dxuuu.xyz>
Signed-off-by: Miguel Ojeda <ojeda@kernel.org>
12 files changed:
Documentation/doc-guide/kernel-doc.rst
Documentation/index.rst
Documentation/kbuild/kbuild.rst
Documentation/process/changes.rst
Documentation/rust/arch-support.rst [new file with mode: 0644]
Documentation/rust/assets/favicon-16x16.png [new file with mode: 0644]
Documentation/rust/assets/favicon-32x32.png [new file with mode: 0644]
Documentation/rust/assets/rust-logo.png [new file with mode: 0644]
Documentation/rust/coding-guidelines.rst [new file with mode: 0644]
Documentation/rust/general-information.rst [new file with mode: 0644]
Documentation/rust/index.rst [new file with mode: 0644]
Documentation/rust/quick-start.rst [new file with mode: 0644]