Add descriptions and READMEs for crates published with OSDK

This commit is contained in:
Zhang Junyang 2025-03-14 18:11:33 +08:00 committed by Tate, Hongliang Tian
parent a708a0c046
commit 3d21258baf
6 changed files with 38 additions and 0 deletions

View File

@ -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"

View File

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

View File

@ -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"

View File

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

View File

@ -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

View File

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