prepare for publish vm-superio(-ser)

Added separate CHANGELOG for each crate and updated the vm-superio version. Signed-off-by: Laura Loghin <[email protected]>
rust-vmm · Oct 26, 2021 · d138e0e · d138e0e
1 parent 0969e63
commit d138e0e
Show file tree

Hide file tree

Showing 3 changed files with 27 additions and 3 deletions.
diff --git a/crates/vm-superio-ser/CHANGELOG.md b/crates/vm-superio-ser/CHANGELOG.md
@@ -0,0 +1,10 @@
+# Changelog
+
+# v0.1.0
+
+This is the first `vm-superio-ser` release.
+The `vm-superio-ser` crate provides support for persisting the states from
+`vm-superio`. For now, it provides this support only for the `Rtc` device.
+`RtcStateSer` can be used by customers who need an `RtcState` that is also
+`(De)Serialize` and/or `Versionize`.
+This version of `RtcStateSer` is compatible with v0.5.0 version of `RtcState`.
diff --git a/CHANGELOG.md → crates/vm-superio/CHANGELOG.md b/CHANGELOG.md → crates/vm-superio/CHANGELOG.md
@@ -1,11 +1,25 @@
 # Changelog
 
+# v0.5.0
+
+## Added
+
+- Added `RtcState`, and support for saving and restoring the state of the `Rtc`
+  device. This support is useful for snapshot use cases, such as live
+  migration ([#65](https://github.com/rust-vmm/vm-superio/pull/65)).
+
+## Fixed
+
+- Fixed potential overflow in the `Rtc` implementation caused by an invalid
+  offset ([#65](https://github.com/rust-vmm/vm-superio/pull/65)).
+
 # v0.4.0
 
 ## Added
 
 - Added `in_buffer_empty` to SerialEvents trait. This helps with handling
-  the registration of I/O events related to the serial input.
+  the registration of I/O events related to the serial input
+  ([#63](https://github.com/rust-vmm/vm-superio/pull/63)).
 
 ## Changed
 
@@ -58,6 +72,6 @@
 
 # v0.1.0
 
-This is the first vm-superio release.
+This is the first `vm-superio` release.
 The `vm-superio` crate provides emulation for legacy devices. For now, it offers
 this support only for the Linux serial console.
diff --git a/crates/vm-superio/Cargo.toml b/crates/vm-superio/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "vm-superio"
-version = "0.4.0"
+version = "0.5.0"
 description = "Emulation for legacy devices"
 keywords = ["superio", "emulation"]
 repository = "https://github.com/rust-vmm/vm-superio"