Temporarily hide SiFive platform features

rustsbi · Dec 4, 2021 · e32be8e · e32be8e
1 parent f0273a9
commit e32be8e
Show file tree

Hide file tree

Showing 3 changed files with 3 additions and 0 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -15,6 +15,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Modified
 - Set CEASE to be unsafe function
 - Rearrange documents
+- Temporarily hide SiFive platform features
 
 ### Removed
 - PAUSE instruction, it will be in `core::hint::spin_loop`

diff --git a/src/lib.rs b/src/lib.rs
@@ -10,5 +10,6 @@
 #![no_std]
 
 pub mod asm;
+#[doc(hidden)] // hide by now, API has not been decided yet
 pub mod feature;
 pub mod register;
diff --git a/src/register.rs b/src/register.rs
@@ -48,6 +48,7 @@ pub mod mbpm {
     }
 }
 
+#[doc(hidden)] // hide by now, API has not been decided yet
 /// Feature disable register
 ///
 /// The SiFive custom M-mode Feature Disable CSR is provided to enable or disable certain
-Original file line number
+Diff line change
@@ Expand Up / @@ -48,6 +48,7 @@ pub mod mbpm { @@
         }
     }
+    #[doc(hidden)] // hide by now, API has not been decided yet
     /// Feature disable register
     ///
     /// The SiFive custom M-mode Feature Disable CSR is provided to enable or disable certain
@@ Expand Down @@