Miscellaneous documentation cleanups. (#883)

Author: sunfishcode

.github/workflows/main.yml

@@ -209,8 +209,7 @@ jobs:
     - run: cargo check -Z build-std --target aarch64-unknown-linux-gnu_ilp32 --features=all-apis
     # Omit --all-targets on haiku because not all the tests build yet.
     - run: cargo check -Z build-std --target x86_64-unknown-haiku --features=all-apis
-    # x86_64-uwp-windows-msvc isn't currently working.
-    #- run: cargo check -Z build-std --target x86_64-uwp-windows-msvc --all-targets --features=all-apis
+    - run: cargo check -Z build-std --target x86_64-uwp-windows-msvc --all-targets --features=all-apis
     - run: cargo check -Z build-std --target=riscv32imc-esp-espidf --features=all-apis
     - run: cargo check -Z build-std --target=aarch64-unknown-nto-qnx710 --features=all-apis
     - run: cargo check -Z build-std --target=x86_64-pc-nto-qnx710 --features=all-apis

src/backend/libc/mm/syscalls.rs

@@ -225,10 +225,11 @@ pub(crate) unsafe fn userfaultfd(flags: UserfaultfdFlags) -> io::Result<OwnedFd>
 
 /// Locks all pages mapped into the address space of the calling process.
 ///
-/// This includes the pages of the code, data and stack segment, as well as shared libraries,
-/// user space kernel data, shared memory, and memory-mapped files. All mapped pages are
-/// guaranteed to be resident in RAM when the call returns successfully;
-/// the pages are guaranteed to stay in RAM until later unlocked.
+/// This includes the pages of the code, data and stack segment, as well as
+/// shared libraries, user space kernel data, shared memory, and memory-mapped
+/// files. All mapped pages are guaranteed to be resident in RAM when the call
+/// returns successfully; the pages are guaranteed to stay in RAM until later
+/// unlocked.
 #[inline]
 #[cfg(any(linux_kernel, freebsdlike, netbsdlike))]
 pub(crate) fn mlockall(flags: MlockAllFlags) -> io::Result<()> {

src/backend/linux_raw/mm/syscalls.rs

@@ -215,10 +215,11 @@ pub(crate) unsafe fn userfaultfd(flags: UserfaultfdFlags) -> io::Result<OwnedFd>
 
 /// Locks all pages mapped into the address space of the calling process.
 ///
-/// This includes the pages of the code, data and stack segment, as well as shared libraries,
-/// user space kernel data, shared memory, and memory-mapped files. All mapped pages are
-/// guaranteed to be resident in RAM when the call returns successfully;
-/// the pages are guaranteed to stay in RAM until later unlocked.
+/// This includes the pages of the code, data and stack segment, as well as
+/// shared libraries, user space kernel data, shared memory, and memory-mapped
+/// files. All mapped pages are guaranteed to be resident in RAM when the call
+/// returns successfully; the pages are guaranteed to stay in RAM until later
+/// unlocked.
 #[inline]
 #[cfg(any(linux_kernel, freebsdlike, netbsdlike))]
 pub(crate) fn mlockall(flags: MlockAllFlags) -> io::Result<()> {

src/mm/mmap.rs

@@ -345,10 +345,11 @@ pub unsafe fn munlock(ptr: *mut c_void, len: usize) -> io::Result<()> {
 
 /// Locks all pages mapped into the address space of the calling process.
 ///
-/// This includes the pages of the code, data and stack segment, as well as shared libraries,
-/// user space kernel data, shared memory, and memory-mapped files. All mapped pages are
-/// guaranteed to be resident in RAM when the call returns successfully;
-/// the pages are guaranteed to stay in RAM until later unlocked.
+/// This includes the pages of the code, data and stack segment, as well as
+/// shared libraries, user space kernel data, shared memory, and memory-mapped
+/// files. All mapped pages are guaranteed to be resident in RAM when the call
+/// returns successfully; the pages are guaranteed to stay in RAM until later
+/// unlocked.
 ///
 /// # References
 ///  - [POSIX]
@@ -378,9 +379,10 @@ pub fn mlockall(flags: MlockAllFlags) -> io::Result<()> {
 ///
 /// # Warnings
 ///
-/// This function is aware of all the memory pages in the process, as if it were a debugger.
-/// It unlocks all the pages, which could potentially compromise security assumptions made by
-/// code about memory it has encapsulated.
+/// This function is aware of all the memory pages in the process, as if it
+/// were a debugger. It unlocks all the pages, which could potentially
+/// compromise security assumptions made by code about memory it has
+/// encapsulated.
 ///
 /// # References
 ///  - [POSIX]

src/process/wait.rs

@@ -9,7 +9,7 @@ use crate::fd::BorrowedFd;
 use crate::backend::process::wait::SiginfoExt;
 
 bitflags! {
-    /// Options for modifying the behavior of wait/waitpid
+    /// Options for modifying the behavior of [`wait`]/[`waitpid`].
     #[repr(transparent)]
     #[derive(Copy, Clone, Eq, PartialEq, Hash, Debug)]
     pub struct WaitOptions: u32 {

src/pty.rs

@@ -23,7 +23,7 @@ use crate::{fd::FromRawFd, ioctl};
 bitflags::bitflags! {
     /// `O_*` flags for use with [`openpt`] and [`ioctl_tiocgptpeer`].
     ///
-    /// [`ioctl_tiocgtpeer`]: https://docs.rs/rustix/*/x86_64-unknown-linux-gnu/rustix/pty/fn.ioctl_tiocgtpeer.html
+    /// [`ioctl_tiocgtpeer`]: https://docs.rs/rustix/*/x86_64-unknown-linux-gnu/rustix/pty/fn.ioctl_tiocgptpeer.html
     #[repr(transparent)]
     #[derive(Copy, Clone, Eq, PartialEq, Hash, Debug)]
     pub struct OpenptFlags: u32 {

src/runtime.rs

@@ -89,7 +89,7 @@ pub unsafe fn arm_set_tls(data: *mut c_void) -> io::Result<()> {
     backend::runtime::syscalls::tls::arm_set_tls(data)
 }
 
-/// `prctl(PR_SET_FS, data)`—Set the x86_64 `fs` register.
+/// `prctl(PR_SET_FS, data)`—Set the x86-64 `fs` register.
 ///
 /// # Safety
 ///
@@ -101,7 +101,7 @@ pub unsafe fn set_fs(data: *mut c_void) {
     backend::runtime::syscalls::tls::set_fs(data)
 }
 
-/// Set the x86_64 thread ID address.
+/// Set the x86-64 thread ID address.
 ///
 /// # Safety
 ///