Browse Source

Small fixes on library documents

luojia65 4 years ago
parent
commit
d4ef5a87c3
3 changed files with 4 additions and 3 deletions
  1. 1 0
      CHANGELOG.md
  2. 2 2
      rustsbi/src/legacy_stdio.rs
  3. 1 1
      rustsbi/src/lib.rs

+ 1 - 0
CHANGELOG.md

@@ -9,6 +9,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Abstract support for HSM and SRST extensions
 - Support SRST extension using test device on QEMU
 - Count harts from device tree binary on QEMU platform
+- Small fixes on library documents
 
 ### Modified
 - Use '#[naked]' instead of global assembly in newer Rust version for RustSBI platforms

+ 2 - 2
rustsbi/src/legacy_stdio.rs

@@ -118,7 +118,7 @@ pub fn _print(args: fmt::Arguments) {
     Stdout.write_fmt(args).unwrap();
 }
 
-/// Prints to the debug console.
+/// Prints to the legacy debug console.
 #[macro_export(local_inner_macros)]
 macro_rules! print {
     ($($arg:tt)*) => ({
@@ -126,7 +126,7 @@ macro_rules! print {
     });
 }
 
-/// Prints to the debug console, with a newline.
+/// Prints to the legacy debug console, with a newline.
 #[macro_export(local_inner_macros)]
 macro_rules! println {
     ($fmt: literal $(, $($arg: tt)+)?) => {

+ 1 - 1
rustsbi/src/lib.rs

@@ -45,7 +45,7 @@ const RUSTSBI_VERSION_PATCH: usize = (env!("CARGO_PKG_VERSION_PATCH").as_bytes()
 const RUSTSBI_VERSION: usize = {
    (RUSTSBI_VERSION_MAJOR << 16) + (RUSTSBI_VERSION_MINOR << 8) + RUSTSBI_VERSION_PATCH
 };
-/// RustSBI version as string
+/// RustSBI version as a string.
 pub const VERSION: &'static str = env!("CARGO_PKG_VERSION");
 
 pub use ecall::handle_ecall as ecall;