From 3d21258baf3dd89cb4e9d44d6da8c4c8190478a4 Mon Sep 17 00:00:00 2001
From: Zhang Junyang <junyang@stu.pku.edu.cn>
Date: Fri, 14 Mar 2025 18:11:33 +0800
Subject: [PATCH] Add descriptions and READMEs for crates published with OSDK

---
 osdk/deps/frame-allocator/Cargo.toml |  4 ++++
 osdk/deps/frame-allocator/README.md  | 10 ++++++++++
 osdk/deps/heap-allocator/Cargo.toml  |  4 ++++
 osdk/deps/heap-allocator/README.md   | 10 ++++++++++
 osdk/deps/test-kernel/Cargo.toml     |  1 +
 osdk/deps/test-kernel/README.md      |  9 +++++++++
 6 files changed, 38 insertions(+)
 create mode 100644 osdk/deps/frame-allocator/README.md
 create mode 100644 osdk/deps/heap-allocator/README.md
 create mode 100644 osdk/deps/test-kernel/README.md

diff --git a/osdk/deps/frame-allocator/Cargo.toml b/osdk/deps/frame-allocator/Cargo.toml
index 8f6bbea73..d4d28a0e0 100644
--- a/osdk/deps/frame-allocator/Cargo.toml
+++ b/osdk/deps/frame-allocator/Cargo.toml
@@ -2,6 +2,10 @@
 name = "osdk-frame-allocator"
 version = "0.12.0"
 edition = "2021"
+description = "The default buddy system frame allocator shipped with OSDK."
+license = "MPL-2.0"
+repository ="https://github.com/asterinas/asterinas"
+readme = "README.md"
 
 [dependencies]
 log = "0.4"
diff --git a/osdk/deps/frame-allocator/README.md b/osdk/deps/frame-allocator/README.md
new file mode 100644
index 000000000..a6b4dde4f
--- /dev/null
+++ b/osdk/deps/frame-allocator/README.md
@@ -0,0 +1,10 @@
+# osdk-frame-allocator
+
+This is the default buddy system frame allocator shipped with
+[OSDK](https://crates.io/crates/cargo-osdk). It relies on the physical frame
+metadata system in [OSTD](https://crates.io/crates/ostd) to provide a heap-free
+implementation of a buddy system allocator for OS kernels. It also features
+per-CPU caches and pools for scalable allocations.
+
+This crate is part of the [Asterinas](https://github.com/asterinas/asterinas)
+project.
diff --git a/osdk/deps/heap-allocator/Cargo.toml b/osdk/deps/heap-allocator/Cargo.toml
index 0dc4494e8..b8c6d1514 100644
--- a/osdk/deps/heap-allocator/Cargo.toml
+++ b/osdk/deps/heap-allocator/Cargo.toml
@@ -2,6 +2,10 @@
 name = "osdk-heap-allocator"
 version = "0.12.0"
 edition = "2021"
+description = "The default slab-based heap allocator shipped with OSDK."
+license = "MPL-2.0"
+repository ="https://github.com/asterinas/asterinas"
+readme = "README.md"
 
 [dependencies]
 log = "0.4"
diff --git a/osdk/deps/heap-allocator/README.md b/osdk/deps/heap-allocator/README.md
new file mode 100644
index 000000000..053aeec56
--- /dev/null
+++ b/osdk/deps/heap-allocator/README.md
@@ -0,0 +1,10 @@
+# osdk-heap-allocator
+
+This is the default slab-based global heap allocator shipped with
+[OSDK](https://crates.io/crates/cargo-osdk). It relies on the slab mechanism in
+[OSTD](https://crates.io/crates/ostd) to provide a fast, memory-efficient
+implementation of a global heap allocator for OS kernels. It also features
+per-CPU caches for scalable allocations.
+
+This crate is part of the [Asterinas](https://github.com/asterinas/asterinas)
+project.
diff --git a/osdk/deps/test-kernel/Cargo.toml b/osdk/deps/test-kernel/Cargo.toml
index 2d55574a1..3bafa18b5 100644
--- a/osdk/deps/test-kernel/Cargo.toml
+++ b/osdk/deps/test-kernel/Cargo.toml
@@ -5,6 +5,7 @@ edition = "2021"
 description = "The OSTD-based kernel for running unit tests with OSDK."
 license = "MPL-2.0"
 repository ="https://github.com/asterinas/asterinas"
+readme = "README.md"
 
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
 
diff --git a/osdk/deps/test-kernel/README.md b/osdk/deps/test-kernel/README.md
new file mode 100644
index 000000000..47acb4a5b
--- /dev/null
+++ b/osdk/deps/test-kernel/README.md
@@ -0,0 +1,9 @@
+# osdk-test-kernel
+
+This is an [OSDK](https://crates.io/crates/cargo-osdk)-based kernel that solely
+runs unit tests. It is shipped with [OSDK](https://crates.io/crates/cargo-osdk)
+to provide default unit-test infrastructure for kernel projects based on
+[OSTD](https://crates.io/crates/ostd).
+
+This is part of the [Asterinas](https://github.com/asterinas/asterinas)
+project.