Re: [PATCH v6 18/23] docs: add Rust documentation

Miguel Ojeda
2022-05-07T08:45:57Z

On Sat, May 7, 2022 at 10:15 AM Kees Cook <keescook@chromium.org> wrote:
>
> I like the docs! :) It'll be interesting to see how we can grow
> cross-linking between rustdoc and kerndoc.

Thanks!

For cross-referencing, my plan is to start on the Rust side by
allowing to link C files and items (either their generated docs or the
source file), since we do that often in the Rust docs. The goal is
that one can just write an "intra-doc link" in Rust docs just like any
other one, e.g.:

/// Wraps the kernel's [`struct sk_buff`].
#[repr(transparent)]
pub struct SkBuff(UnsafeCell<bindings::sk_buff>);

so that it is as easy as possible to add them.

Cheers,
Miguel