docs

hbvm/src/lib.rs

@@ -1,4 +1,6 @@
+#![doc = include_str!("../README.md")]
 #![no_std]
+
 extern crate alloc;
 
 pub mod validate;

hbvm/src/validate.rs

@@ -1,3 +1,5 @@
+//! Validate if program is sound to execute
+
 /// Program validation error kind
 #[derive(Clone, Copy, Debug, PartialEq, Eq)]
 pub enum ErrorKind {

hbvm/src/vm/mem/mod.rs

@@ -1,10 +1,11 @@
-mod paging;
+//! Program memory implementation
 
-use core::mem::MaybeUninit;
+pub mod paging;
 
 use self::paging::{PageTable, Permission, PtEntry};
 use super::{trap::HandleTrap, VmRunError};
 use alloc::boxed::Box;
+use core::mem::MaybeUninit;
 use derive_more::Display;
 
 /// HoleyBytes virtual memory

hbvm/src/vm/mem/paging.rs

@@ -1,3 +1,5 @@
+//! Page table and associated structures implementation
+
 use core::{
     fmt::Debug,
     mem::MaybeUninit,

hbvm/src/vm/trap.rs

@@ -1,3 +1,5 @@
+//! Program trap handling interfaces
+
 use super::{
     mem::{Memory, MemoryAccessReason, PageSize},
     value::Value,

hbvm/src/vm/value.rs

@@ -1,3 +1,5 @@
+//! HoleyBytes register value definition
+
 use core::fmt::Debug;
 
 /// Define [`Value`] union