Skip to content

uefi: Minor cleanups in the fs module doc #753

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 3, 2023
Merged

uefi: Minor cleanups in the fs module doc #753

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 8 additions & 12 deletions uefi/src/fs/mod.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,35 +1,31 @@
//! A high-level file system API for UEFI applications close to the `fs` module
//! from Rust's standard library.
//!
//! ## Difference to typical File System Abstractions
//! # Difference to typical File System Abstractions
//! Users perform actions on dedicated volumes: For example, the boot volume,
//! such as a CD-rom, USB-stick, or any other storage device.
//!
//! ### UNIX
//! Unlike in the API of typical UNIX file system abstractions, there is no
//! virtual file system.
//! Unlike in the API of typical UNIX file system abstractions, there is
//! no virtual file system.
//!
//! ### Windows
//! Unlike in Windows, there is no way to access volumes by a dedicated name.
//! Unlike Windows, there is no way to access volumes by a dedicated name.
//!
//! ## Paths
//! # Paths
//! All paths are absolute and follow the FAT-like file system conventions for
//! paths. Thus, there is no current working directory and path components
//! like `.` and `.."`are not supported. In other words, the current working
//! directory is always `/`, i.e., the root, of the opened volume. This may
//! change in the future but is currently sufficient.
//! like `.` and `..` are not supported. In other words, the current working
//! directory is always `/`, i.e., the root, of the opened volume.
//!
//! Symlinks or hard-links are not supported but only directories and regular
//! files with plain linear paths to them.
//!
//! ## API Hints
//! # 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`.
//!
//! ### Synchronization
//! There is no automatic synchronization of the file system for concurrent
//! accesses. This is in the responsibility of the user.

Expand Down