docs: introduce CHANGELOG.md

vmi-rs · Nov 24, 2024 · 659ee98 · 659ee98
1 parent 848f5e2
commit 659ee98
Showing 1 changed file with 23 additions and 0 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -0,0 +1,23 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project ~~adheres to~~
+**_will adhere to [Semantic Versioning](https://semver.org/spec/v2.0.0.html) once it reaches 0.2.0_**.
+
+## [Unreleased]
+
+### Changed
+
+- Added Output type to the VmiHandler
+- VmiHandler::finished() is renamed to VmiHandler::check_completion(),
+  which now returns an Option&lt;Output&gt; instead of a bool
+
+### Added
+
+- Implemented handling of PFN changes in the PageTableMonitor
+
+### Fixed
+
+- Return PageIn event when connecting an intermediate PTE