Skip to content

Commit d8a4f00

Browse files
committed
clippy: deny doc_overindented_list_items lint
1 parent 2367f23 commit d8a4f00

File tree

5 files changed

+12
-14
lines changed

5 files changed

+12
-14
lines changed

uefi-raw/src/lib.rs

-1
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,6 @@
2121
missing_debug_implementations,
2222
unused
2323
)]
24-
#![allow(clippy::doc_overindented_list_items)]
2524

2625
#[macro_use]
2726
mod enums;

uefi/src/lib.rs

-1
Original file line numberDiff line numberDiff line change
@@ -227,7 +227,6 @@
227227
unsafe_op_in_unsafe_fn,
228228
unused
229229
)]
230-
#![allow(clippy::doc_overindented_list_items)]
231230

232231
#[cfg(feature = "alloc")]
233232
extern crate alloc;

uefi/src/proto/console/pointer/mod.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -15,11 +15,11 @@ pub struct Pointer(SimplePointerProtocol);
1515
impl Pointer {
1616
/// Resets the pointer device hardware.
1717
///
18+
/// # Arguments
1819
/// The `extended_verification` parameter is used to request that UEFI
1920
/// performs an extended check and reset of the input device.
2021
///
2122
/// # Errors
22-
///
2323
/// - `DeviceError` if the device is malfunctioning and cannot be reset.
2424
pub fn reset(&mut self, extended_verification: bool) -> Result {
2525
unsafe { (self.0.reset)(&mut self.0, extended_verification.into()) }.to_result()

uefi/src/proto/media/block.rs

+10-9
Original file line numberDiff line numberDiff line change
@@ -23,11 +23,12 @@ impl BlockIO {
2323
/// Resets the block device hardware.
2424
///
2525
/// # Arguments
26-
/// * `extended_verification` Indicates that the driver may perform a more exhaustive verification operation of
27-
/// the device during reset.
26+
/// * `extended_verification` Indicates that the driver may perform a more
27+
/// exhaustive verification operation of the device during reset.
2828
///
2929
/// # Errors
30-
/// * `uefi::Status::DEVICE_ERROR` The block device is not functioning correctly and could not be reset.
30+
/// * `uefi::Status::DEVICE_ERROR` The block device is not functioning
31+
/// correctly and could not be reset.
3132
pub fn reset(&mut self, extended_verification: bool) -> Result {
3233
unsafe { (self.0.reset)(&mut self.0, extended_verification.into()) }.to_result()
3334
}
@@ -41,13 +42,13 @@ impl BlockIO {
4142
///
4243
/// # Errors
4344
/// * `uefi::Status::DEVICE_ERROR` The device reported an error while attempting to perform the read
44-
/// operation.
45+
/// operation.
4546
/// * `uefi::Status::NO_MEDIA` There is no media in the device.
4647
/// * `uefi::Status::MEDIA_CHANGED` The `media_id` is not for the current media.
4748
/// * `uefi::Status::BAD_BUFFER_SIZE` The buffer size parameter is not a multiple of the intrinsic block size of
48-
/// the device.
49+
/// the device.
4950
/// * `uefi::Status::INVALID_PARAMETER` The read request contains LBAs that are not valid, or the buffer is not on
50-
/// proper alignment.
51+
/// proper alignment.
5152
pub fn read_blocks(&self, media_id: u32, lba: Lba, buffer: &mut [u8]) -> Result {
5253
let buffer_size = buffer.len();
5354
unsafe {
@@ -74,11 +75,11 @@ impl BlockIO {
7475
/// * `uefi::Status::NO_MEDIA` There is no media in the device.
7576
/// * `uefi::Status::MEDIA_CHANGED` The `media_id` is not for the current media.
7677
/// * `uefi::Status::DEVICE_ERROR` The device reported an error while attempting to perform the write
77-
/// operation.
78+
/// operation.
7879
/// * `uefi::Status::BAD_BUFFER_SIZE` The buffer size parameter is not a multiple of the intrinsic block size
79-
/// of the device.
80+
/// of the device.
8081
/// * `uefi::Status::INVALID_PARAMETER` The write request contains LBAs that are not valid, or the buffer is not
81-
/// on proper alignment.
82+
/// on proper alignment.
8283
pub fn write_blocks(&mut self, media_id: u32, lba: Lba, buffer: &[u8]) -> Result {
8384
let buffer_size = buffer.len();
8485
unsafe {

uefi/src/proto/media/disk.rs

+1-2
Original file line numberDiff line numberDiff line change
@@ -95,8 +95,7 @@ impl DiskIo2 {
9595
/// Terminates outstanding asynchronous requests to the device.
9696
///
9797
/// # Errors:
98-
/// * [`Status::DEVICE_ERROR`] The device reported an error while performing
99-
/// the cancel operation.
98+
/// * [`Status::DEVICE_ERROR`] The device reported an error while performing
10099
pub fn cancel(&mut self) -> Result {
101100
unsafe { (self.0.cancel)(&mut self.0) }.to_result()
102101
}

0 commit comments

Comments
 (0)