Skip to content

Commit 4a20782

Browse files
committed
fs: doc fixes
1 parent 6d948e8 commit 4a20782

File tree

3 files changed

+5
-8
lines changed

3 files changed

+5
-8
lines changed

uefi/src/fs/file_system/error.rs

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,8 +28,7 @@ pub struct IoError {
2828
pub uefi_error: crate::Error,
2929
}
3030

31-
/// Enum that further specifies the context in that a [`Error`]
32-
/// occurred.
31+
/// Enum that further specifies the context in that an [`Error`] occurred.
3332
#[derive(Debug, Clone, Display, PartialEq, Eq)]
3433
pub enum FileSystemIOErrorContext {
3534
/// Can't delete the directory.

uefi/src/fs/mod.rs

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -21,11 +21,9 @@
2121
//! [`Path`] and [`PathBuf`].
2222
//!
2323
//! # API Hints
24-
//! There are no `File` and `Path` abstractions similar to those from `std` that
25-
//! are publicly exported. Instead, paths to files are provided as `&str`, and
26-
//! will be validated and transformed internally to the correct type.
27-
//! Furthermore, there are no `File` objects that are exposed to users. Instead,
28-
//! it is intended to work with the file system as in `std::fs`.
24+
//! There is no `File` abstraction as in the Rust `std` library. Instead, it is
25+
//! intended to work with the file system via dedicated functions, similar to
26+
//! the public functions of the `std::fs` module.
2927
//!
3028
//! There is no automatic synchronization of the file system for concurrent
3129
//! accesses. This is in the responsibility of the user.

uefi/src/fs/path/mod.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ pub const SEPARATOR_STR: &CStr16 = uefi_macros::cstr16!("\\");
3333

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

0 commit comments

Comments
 (0)