Skip to content

Commit

Permalink
Merge pull request torvalds#412 from ojeda/fix-doc-warn
Browse files Browse the repository at this point in the history
rust: kernel: clean `rustdoc` warnings
  • Loading branch information
ojeda authored Jul 2, 2021
2 parents 5f9ad6c + 4b832b4 commit fc4c293
Show file tree
Hide file tree
Showing 5 changed files with 5 additions and 5 deletions.
2 changes: 1 addition & 1 deletion rust/kernel/file.rs
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ use core::{mem::ManuallyDrop, ops::Deref};
///
/// # Invariants
///
/// The pointer [`File::ptr`] is non-null and valid. Its reference count is also non-zero.
/// The pointer `File::ptr` is non-null and valid. Its reference count is also non-zero.
pub struct File {
pub(crate) ptr: *mut bindings::file,
}
Expand Down
2 changes: 1 addition & 1 deletion rust/kernel/file_operations.rs
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ use crate::{
///
/// # Invariants
///
/// The pointer [`PollTable::ptr`] is null or valid.
/// The pointer `PollTable::ptr` is null or valid.
pub struct PollTable {
ptr: *mut bindings::poll_table_struct,
}
Expand Down
2 changes: 1 addition & 1 deletion rust/kernel/iov_iter.rs
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ extern "C" {
///
/// # Invariants
///
/// The pointer [`IovIter::ptr`] is non-null and valid.
/// The pointer `IovIter::ptr` is non-null and valid.
pub struct IovIter {
ptr: *mut bindings::iov_iter,
}
Expand Down
2 changes: 1 addition & 1 deletion rust/kernel/pages.rs
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ extern "C" {
///
/// # Invariants
///
/// The pointer [`Pages::pages`] is valid and points to 2^ORDER pages.
/// The pointer `Pages::pages` is valid and points to 2^ORDER pages.
pub struct Pages<const ORDER: u32> {
pages: *mut bindings::page,
}
Expand Down
2 changes: 1 addition & 1 deletion rust/kernel/task.rs
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ extern "C" {
///
/// # Invariants
///
/// The pointer [`Task::ptr`] is non-null and valid. Its reference count is also non-zero.
/// The pointer `Task::ptr` is non-null and valid. Its reference count is also non-zero.
///
/// # Examples
///
Expand Down

0 comments on commit fc4c293

Please sign in to comment.