From: Benno Lossin <lossin@kernel.org>
Date: Tue, 19 Aug 2025 07:22:00 +0000 (+0200)
Subject: rust: pin-init: README: add information banner on the rename to `pin-init`
X-Git-Url: https://www.infradead.org/git/?a=commitdiff_plain;h=62a9c709612c1cf0d5684022499f34c56c99b662;p=users%2Fhch%2Fmisc.git

rust: pin-init: README: add information banner on the rename to `pin-init`

Signed-off-by: Benno Lossin <lossin@kernel.org>
---

diff --git a/rust/pin-init/README.md b/rust/pin-init/README.md
index a4c01a8d78b2..723e275445d4 100644
--- a/rust/pin-init/README.md
+++ b/rust/pin-init/README.md
@@ -6,6 +6,18 @@
 ![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/Rust-for-Linux/pin-init/test.yml)
 # `pin-init`
 
+> [!NOTE]
+> 
+> This crate was originally named [`pinned-init`], but the migration to
+> `pin-init` is not yet complete. The `legcay` branch contains the current
+> version of the `pinned-init` crate & the `main` branch already incorporates
+> the rename to `pin-init`.
+>
+> There are still some changes needed on the kernel side before the migration
+> can be completed.
+
+[`pinned-init`]: https://crates.io/crates/pinned-init
+
 <!-- cargo-rdme start -->
 
 Library to safely and fallibly initialize pinned `struct`s using in-place constructors.