summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorBenno Lossin <lossin@kernel.org>2025-08-19 09:22:00 +0200
committerBenno Lossin <lossin@kernel.org>2025-09-11 23:26:03 +0200
commit62a9c709612c1cf0d5684022499f34c56c99b662 (patch)
treec29c91a231046e503cb4e4076bd75604d5caf61a
parent3d536277449e4de4609d4f0b8302ae7fd00b04b2 (diff)
rust: pin-init: README: add information banner on the rename to `pin-init`
Signed-off-by: Benno Lossin <lossin@kernel.org>
-rw-r--r--rust/pin-init/README.md12
1 files changed, 12 insertions, 0 deletions
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.