Skip to content
This repository has been archived by the owner on Jul 17, 2023. It is now read-only.

Commit

Permalink
doc: add crate links in README and fix crate-release.md
Browse files Browse the repository at this point in the history
1. add crate links to crates.io in project README
2. fix wrong steps in crate-release.md

Signed-off-by: Chao Wu <chaowu@linux.alibaba.com>
  • Loading branch information
studychao committed Mar 2, 2023
1 parent 75e7fa4 commit 804bd6e
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 5 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,11 +15,11 @@ This repository contains the following crates:
| [dbs-boot](crates/dbs-boot) | collections of constants, structs and utilities used during VM boot stage | [![Crates.io](https://img.shields.io/crates/v/dbs-boot)](https://crates.io/crates/dbs-boot) |
| [dbs-device](crates/dbs-device) | virtual machine's device model | [![Crates.io](https://img.shields.io/crates/v/dbs-device)](https://crates.io/crates/dbs-device) |
| [dbs-interrupt](crates/dbs-interrupt) | virtual machine's interrupt model | [![Crates.io](https://img.shields.io/crates/v/dbs-interrupt)](https://crates.io/crates/dbs-interrupt) |
| [dbs-legacy-devices](crates/dbs-legacy-devices) | emulation for legacy devices | TBD |
| [dbs-legacy-devices](crates/dbs-legacy-devices) | emulation for legacy devices | [![Crates.io](https://img.shields.io/crates/v/dbs-legacy-devices)](https://crates.io/crates/dbs-legacy-devices) |
| [dbs-utils](crates/dbs-utils) | helpers and utilities used by multiple `dragonball-sandbox` components | [![Crates.io](https://img.shields.io/crates/v/dbs-utils)](https://crates.io/crates/dbs-utils) |
| [dbs-virtio-devices](crates/dbs-virtio-devices) | emulation for virtio devices | TBD |
| [dbs-upcall](crates/dbs-upcall) | dbs-upcall is a direct communication tool between VMM and guest developed upon vsock. | TBD |
| [dbs-miniball](crates/dbs-miniball) | dbs-miniball is a minimal virtual machine manager using components from dragonball-sandbox and rust-vmm. | TBD |
| [dbs-virtio-devices](crates/dbs-virtio-devices) | emulation for virtio devices | [![Crates.io](https://img.shields.io/crates/v/dbs-virtio-devices)](https://crates.io/crates/dbs-virtio-devices) |
| [dbs-upcall](crates/dbs-upcall) | dbs-upcall is a direct communication tool between VMM and guest developed upon vsock. | [![Crates.io](https://img.shields.io/crates/v/dbs-upcall)](https://crates.io/crates/dbs-upcall) |
| [dbs-miniball](crates/dbs-miniball) | dbs-miniball is a minimal virtual machine manager using components from dragonball-sandbox and rust-vmm. | / |

(Dragonball is a virtual machine monitor developed by Alibaba and dbs is the abbreviation for Dragonball.)

Expand Down
2 changes: 1 addition & 1 deletion docs/crate-release.md
Original file line number Diff line number Diff line change
Expand Up @@ -149,7 +149,7 @@ cargo owner --add codeowner-github-handle
2. Update the `CHANGELOG.md` file in the subdirectory of the crate.
3. Update the version field in Cargo.toml in the root of the crate's repository.
4. Add a commit with the changelog and toml updates in the release pull request.
5. Follow the steps 7-10 of [Initial Release](#initial-release)
5. Follow the steps 7-11 of [Initial Release](#initial-release)

## Patch Release

Expand Down

0 comments on commit 804bd6e

Please # to comment.