docs: don't mention helper items

This makes the docs more concise.

Co-authored-by: Έλλεν Εμίλια Άννα Zscheile <[email protected]>

Author: mkroening

src/arch/x86_64/kernel/apic.rs

@@ -384,7 +384,7 @@ fn detect_from_acpi() -> Result<PhysAddr, ()> {
 	Ok(PhysAddr::new(madt_header.local_apic_address.into()))
 }
 
-/// Helper function to search Floating Pointer Structure of the Multiprocessing Specification
+/// Search Floating Pointer Structure of the Multiprocessing Specification
 fn search_mp_floating(memory_range: AddrRange<PhysAddr>) -> Result<&'static ApicMP, ()> {
 	let layout = PageLayout::from_size(BasePageSize::SIZE as usize).unwrap();
 	let page_range = PageBox::new(layout).unwrap();
@@ -415,7 +415,7 @@ fn search_mp_floating(memory_range: AddrRange<PhysAddr>) -> Result<&'static Apic
 	Err(())
 }
 
-/// Helper function to detect APIC by the Multiprocessor Specification
+/// Detect APIC by the Multiprocessor Specification
 fn detect_from_mp() -> Result<PhysAddr, ()> {
 	let mp_float = if let Ok(mpf) = search_mp_floating(
 		AddrRange::new(PhysAddr::new(0x9f000u64), PhysAddr::new(0xa0000u64)).unwrap(),

src/arch/x86_64/mod.rs

@@ -6,8 +6,7 @@ use x86_64::registers::segmentation::SegmentSelector;
 
 use crate::arch::mm::paging::ExceptionStackFrame;
 
-/// Helper function to swap the GS register, if the user-space is
-/// is interrupted.
+/// Swap the GS register, if the user-space is is interrupted.
 #[cfg(feature = "common-os")]
 #[inline(always)]
 pub(crate) fn swapgs(stack_frame: &ExceptionStackFrame) {

src/fs/mod.rs

@@ -65,7 +65,7 @@ pub(crate) trait VfsNode: Send + Sync + fmt::Debug {
 		Err(Errno::Nosys)
 	}
 
-	/// Helper function to create a new directory node
+	/// Create a new directory node
 	fn traverse_mkdir(
 		&self,
 		_components: &mut Vec<&str>,
@@ -74,32 +74,32 @@ pub(crate) trait VfsNode: Send + Sync + fmt::Debug {
 		Err(Errno::Nosys)
 	}
 
-	/// Helper function to delete a directory node
+	/// Delete a directory node
 	fn traverse_rmdir(&self, _components: &mut Vec<&str>) -> io::Result<()> {
 		Err(Errno::Nosys)
 	}
 
-	/// Helper function to remove the specified file
+	/// Remove the specified file
 	fn traverse_unlink(&self, _components: &mut Vec<&str>) -> io::Result<()> {
 		Err(Errno::Nosys)
 	}
 
-	/// Helper function to open a directory
+	/// Open a directory
 	fn traverse_readdir(&self, _components: &mut Vec<&str>) -> io::Result<Vec<DirectoryEntry>> {
 		Err(Errno::Nosys)
 	}
 
-	/// Helper function to get file status
+	/// Get file status
 	fn traverse_lstat(&self, _components: &mut Vec<&str>) -> io::Result<FileAttr> {
 		Err(Errno::Nosys)
 	}
 
-	/// Helper function to get file status
+	/// Get file status
 	fn traverse_stat(&self, _components: &mut Vec<&str>) -> io::Result<FileAttr> {
 		Err(Errno::Nosys)
 	}
 
-	/// Helper function to mount a file system
+	/// Mount a file system
 	fn traverse_mount(
 		&self,
 		_components: &mut Vec<&str>,
@@ -108,7 +108,7 @@ pub(crate) trait VfsNode: Send + Sync + fmt::Debug {
 		Err(Errno::Nosys)
 	}
 
-	/// Helper function to open a file
+	/// Open a file
 	fn traverse_open(
 		&self,
 		_components: &mut Vec<&str>,
@@ -118,7 +118,7 @@ pub(crate) trait VfsNode: Send + Sync + fmt::Debug {
 		Err(Errno::Nosys)
 	}
 
-	/// Helper function to create a read-only file
+	/// Create a read-only file
 	fn traverse_create_file(
 		&self,
 		_components: &mut Vec<&str>,

src/syscalls/mod.rs

@@ -736,7 +736,9 @@ mod dirent_display {
 
 	use super::Dirent64;
 
-	/// Helperstruct for unsafe formatting of [`Dirent64`]
+	/// [`Display`] adapter for [`Dirent64`].
+	///
+	/// [`Display`]: fmt::Display
 	pub(super) struct Dirent64Display<'a> {
 		dirent: &'a Dirent64,
 	}