Fix multiple documentation issues concerned by clippy

This commit is contained in:
Zhang Junyang
2024-06-19 08:15:23 +00:00
committed by Tate, Hongliang Tian
parent 4ba60271b1
commit 05533d7afd
14 changed files with 80 additions and 78 deletions

View File

@ -15,6 +15,7 @@
//! - a parent page table node, //! - a parent page table node,
//! - or a handle to a page table node, //! - or a handle to a page table node,
//! - or a processor. //! - or a processor.
//!
//! This is implemented by using a reference counter in the frame metadata. If the above //! This is implemented by using a reference counter in the frame metadata. If the above
//! conditions are not met, the page table node is ensured to be freed upon dropping the last //! conditions are not met, the page table node is ensured to be freed upon dropping the last
//! reference. //! reference.

View File

@ -12,7 +12,8 @@
//! By all means, ktest is an individule crate that only requires: //! By all means, ktest is an individule crate that only requires:
//! - a custom linker script section `.ktest_array`, //! - a custom linker script section `.ktest_array`,
//! - and an alloc implementation. //! - and an alloc implementation.
//! to work. And the frame happens to provide both of them. Thus, any crates depending //!
//! And the frame happens to provide both of them. Thus, any crates depending
//! on the frame can use ktest without any extra dependency. //! on the frame can use ktest without any extra dependency.
//! //!
//! ## Usage //! ## Usage

View File

@ -8,6 +8,7 @@
//! - Level-3: Page Directory Pointer Table (PDPT); //! - Level-3: Page Directory Pointer Table (PDPT);
//! - Level-2: Page Directory (PD); //! - Level-2: Page Directory (PD);
//! - Level-1: Page Table (PT). //! - Level-1: Page Table (PT).
//!
//! We sometimes use "level-n" page table to refer to the page table described //! We sometimes use "level-n" page table to refer to the page table described
//! above, avoiding the use of complicated names in the Intel manual. //! above, avoiding the use of complicated names in the Intel manual.

View File

@ -11,9 +11,9 @@ use crate::prelude::*;
/// Here is a concise description of Auxiliary Vector from GNU's manual: /// Here is a concise description of Auxiliary Vector from GNU's manual:
/// ///
/// > When a program is executed, it receives information from the operating system /// > When a program is executed, it receives information from the operating system
/// about the environment in which it is operating. The form of this information /// > about the environment in which it is operating. The form of this information
/// is a table of key-value pairs, where the keys are from the set of AT_ /// > is a table of key-value pairs, where the keys are from the set of AT_
/// values in elf.h. /// > values in elf.h.
#[allow(non_camel_case_types)] #[allow(non_camel_case_types)]
#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, PartialOrd, Ord)] #[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, PartialOrd, Ord)]

View File

@ -1,7 +1,6 @@
// SPDX-License-Identifier: MPL-2.0 // SPDX-License-Identifier: MPL-2.0
//This crate defines the component system related macros. //This crate defines the component system related macros.
//!
#![feature(proc_macro_diagnostic)] #![feature(proc_macro_diagnostic)]
#![allow(dead_code)] #![allow(dead_code)]