[PATCH] rust: pin-init: synchronize README.md

[PATCH] rust: pin-init: synchronize README.md

[Benno Lossin]

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`.

Signed-off-by: Benno Lossin <benno.lossin@proton.me>
---
 rust/pin-init/README.md | 6 ++++--
 1 file changed, 4 insertions(+), 2 deletions(-)

diff --git a/rust/pin-init/README.md b/rust/pin-init/README.md
index 3d04796b212b..24d0f0a3f8fb 100644
--- a/rust/pin-init/README.md
+++ b/rust/pin-init/README.md
@@ -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

base-commit: 0af2f6be1b4281385b618cb86ad946eded089ac8
-- 
2.48.1

Re: [PATCH] rust: pin-init: synchronize README.md

[Benno Lossin]

On Thu Apr 17, 2025 at 12:50 AM CEST, Benno Lossin wrote:
> 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`.
>
> Signed-off-by: Benno Lossin <benno.lossin@proton.me>

Applied to pin-init-next -- thanks!

---
Cheers,
Benno