rust: pin-init: synchronize README.md
authorBenno Lossin <benno.lossin@proton.me>
Wed, 16 Apr 2025 22:50:15 +0000 (22:50 +0000)
committerBenno Lossin <benno.lossin@proton.me>
Mon, 21 Apr 2025 21:07:27 +0000 (23:07 +0200)
The upstream version of the `README.md` differs by this change, so
synchronize it.

The reason that this wasn't in the original sync patch is that this was
a late change that I didn't port back to the kernel repo, since it was
generated by `cargo rdme`.

Link: https://lore.kernel.org/all/20250416225002.25253-1-benno.lossin@proton.me
Signed-off-by: Benno Lossin <benno.lossin@proton.me>
rust/pin-init/README.md

index 3d04796b212b97a7107d66e1026be3a1f8e0c0ec..24d0f0a3f8fb86ad042146699b421d16fd04b917 100644 (file)
@@ -218,11 +218,13 @@ the `kernel` crate. The [`sync`] module is a good starting point.
 [pinning]: https://doc.rust-lang.org/std/pin/index.html
 [structurally pinned fields]: https://doc.rust-lang.org/std/pin/index.html#pinning-is-structural-for-field
 [stack]: https://docs.rs/pin-init/latest/pin_init/macro.stack_pin_init.html
-[`Arc<T>`]: https://doc.rust-lang.org/stable/alloc/sync/struct.Arc.html
-[`Box<T>`]: https://doc.rust-lang.org/stable/alloc/boxed/struct.Box.html
 [`impl PinInit<Foo>`]: https://docs.rs/pin-init/latest/pin_init/trait.PinInit.html
 [`impl PinInit<T, E>`]: https://docs.rs/pin-init/latest/pin_init/trait.PinInit.html
 [`impl Init<T, E>`]: https://docs.rs/pin-init/latest/pin_init/trait.Init.html
 [Rust-for-Linux]: https://rust-for-linux.com/
 
 <!-- cargo-rdme end -->
+
+<!-- These links are not picked up by cargo-rdme, since they are behind cfgs... -->
+[`Arc<T>`]: https://doc.rust-lang.org/stable/alloc/sync/struct.Arc.html
+[`Box<T>`]: https://doc.rust-lang.org/stable/alloc/boxed/struct.Box.html