Skip to content

Commit 7b099d5

Browse files
raccognicholasbishop
authored andcommitted
Fix error documentation for File::open
1 parent 31ed902 commit 7b099d5

File tree

1 file changed

+3
-6
lines changed
  • uefi/src/proto/media/file

1 file changed

+3
-6
lines changed

uefi/src/proto/media/file/mod.rs

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -43,12 +43,9 @@ pub trait File: Sized {
4343
/// # Errors
4444
///
4545
/// See section `EFI_FILE_PROTOCOL.Open()` in the UEFI Specification for more details.
46-
///
47-
/// ## Note
48-
///
49-
/// Although [`INVALID_PARAMETER`] is not defined as an error in the UEFI Specification,
50-
/// it can be returned if the opened filename exceeds the maximum length of 255 UCS-2
51-
/// characters (not including the null terminator).
46+
/// Note that [`INVALID_PARAMETER`] is not listed in the specification as one of the
47+
/// errors returned by this function, but some implementations (such as EDK2) perform
48+
/// additional validation and may return that status for invalid inputs.
5249
///
5350
/// [`INVALID_PARAMETER`]: uefi::Status::INVALID_PARAMETER
5451
///

0 commit comments

Comments
 (0)