Skip to content

Commit

Permalink
fs: doc fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
phip1611 committed May 12, 2023
1 parent 1aab1f0 commit bc8d8db
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 8 deletions.
3 changes: 1 addition & 2 deletions uefi/src/fs/file_system/error.rs
Original file line number Diff line number Diff line change
Expand Up @@ -28,8 +28,7 @@ pub struct IoError {
pub uefi_error: crate::Error,
}

/// Enum that further specifies the context in that a [`Error`]
/// occurred.
/// Enum that further specifies the context in that an [`Error`] occurred.
#[derive(Debug, Clone, Display, PartialEq, Eq)]
pub enum FileSystemIOErrorContext {
/// Can't delete the directory.
Expand Down
8 changes: 3 additions & 5 deletions uefi/src/fs/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -21,11 +21,9 @@
//! [`Path`] and [`PathBuf`].
//!
//! # API Hints
//! There are no `File` and `Path` abstractions similar to those from `std` that
//! are publicly exported. Instead, paths to files are provided as `&str`, and
//! will be validated and transformed internally to the correct type.
//! Furthermore, there are no `File` objects that are exposed to users. Instead,
//! it is intended to work with the file system as in `std::fs`.
//! There is no `File` abstraction as in the Rust `std` library. Instead, it is
//! intended to work with the file system via dedicated functions, similar to
//! the public functions of the `std::fs` module.
//!
//! There is no automatic synchronization of the file system for concurrent
//! accesses. This is in the responsibility of the user.
Expand Down
2 changes: 1 addition & 1 deletion uefi/src/fs/path/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ pub const SEPARATOR_STR: &CStr16 = uefi_macros::cstr16!("\\");

/// Deny list of characters for path components. UEFI supports FAT-like file
/// systems. According to <https://en.wikipedia.org/wiki/Comparison_of_file_systems>,
/// paths should not contain the following symbols.
/// paths should not contain these symbols.
pub const CHARACTER_DENY_LIST: [Char16; 10] = unsafe {
[
NUL_16,
Expand Down

0 comments on commit bc8d8db

Please sign in to comment.