linux-kernel - Re: [PATCH 04/22] rust: pin-init: move proc-macro documentation into pin-init crate

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] [day] [month] [year] [list]

Message-ID: <D88A875SAHW1.GMXBFL84SI6D@proton.me>
Date: Wed, 05 Mar 2025 11:05:55 +0000
From: Benno Lossin <benno.lossin@...ton.me>
To: Andreas Hindborg <a.hindborg@...nel.org>
Cc: Miguel Ojeda <ojeda@...nel.org>, Alex Gaynor <alex.gaynor@...il.com>, Boqun Feng <boqun.feng@...il.com>, Gary Guo <gary@...yguo.net>, Björn Roy Baron <bjorn3_gh@...tonmail.com>, Alice Ryhl <aliceryhl@...gle.com>, Trevor Gross <tmgross@...ch.edu>, Danilo Krummrich <dakr@...nel.org>, rust-for-linux@...r.kernel.org, linux-kernel@...r.kernel.org
Subject: Re: [PATCH 04/22] rust: pin-init: move proc-macro documentation into pin-init crate

On Wed Mar 5, 2025 at 10:34 AM CET, Andreas Hindborg wrote:
> "Benno Lossin" <benno.lossin@...ton.me> writes:
>
>> Move the documentation of proc-macros from pin-init-internal into
>> pin-init. This is because documentation can only reference types from
>> dependencies and pin-init-internal cannot have pin-init as a dependency,
>> as that would be cyclic.
>
> `pin_data` et. al. is now re-exported both in `kernel::prelude` and
> `kernel::init`, but I guess that is fine?

Yes, that is fine, later the imports will be resolved such that the
prelude re-exports the macros from the pin-init crate (so the docs
should also be rendered there).

> When you say "can only reference types", do you mean via links in the text?

Yes, I mean the doc-links, e.g. [`Zeroable`].

---
Cheers,
Benno