Miscellaneous cleanups. (#1380)

sunfishcode · web-flow · commit 156e6f4eeb05 · 2025-03-04T18:59:36.000-08:00
diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml
@@ -220,8 +220,7 @@ jobs:
     - run: cargo check -Z build-std --target aarch64-unknown-linux-gnu_ilp32 --all-targets --features=all-apis
     - run: cargo check -Z build-std --target x86_64-unknown-haiku --all-targets --features=all-apis
     - run: cargo check -Z build-std --target x86_64-uwp-windows-msvc --all-targets --features=all-apis
-    # Temporarily disable riscv32imc-esp-espidf, as it gets build errors.
-    # - run: cargo check -Z build-std --target=riscv32imc-esp-espidf --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
     - run: cargo check -Z build-std --target=armv6k-nintendo-3ds --all-features
diff --git a/src/backend/libc/fs/syscalls.rs b/src/backend/libc/fs/syscalls.rs
@@ -1287,7 +1287,7 @@ pub(crate) fn fadvise(
     // also avoid exposing this artifact of casting an unsigned value to the
     // signed type. To do this, we use a no-op call in this case.
     //
-    // [Rust convention]: https://doc.rust-lang.org/stable/std/io/enum.SeekFrom.html#variant.Start
+    // [Rust convention]: std::io::SeekFrom::Start
     #[cfg(target_os = "freebsd")]
     if offset < 0 {
         if len < 0 {
diff --git a/src/backend/libc/mod.rs b/src/backend/libc/mod.rs
@@ -27,7 +27,7 @@ pub(crate) mod fd {
     pub trait AsRawFd {
         /// A version of [`as_raw_fd`] for use with Winsock API.
         ///
-        /// [`as_raw_fd`]: https://doc.rust-lang.org/stable/std/os/fd/trait.FromRawFd.html#tymethod.as_raw_fd
+        /// [`as_raw_fd`]: https://doc.rust-lang.org/stable/std/os/fd/trait.AsRawFd.html#tymethod.as_raw_fd
         fn as_raw_fd(&self) -> RawFd;
     }
     impl<T: AsRawSocket> AsRawFd for T {
@@ -43,7 +43,7 @@ pub(crate) mod fd {
     pub trait IntoRawFd {
         /// A version of [`into_raw_fd`] for use with Winsock API.
         ///
-        /// [`into_raw_fd`]: https://doc.rust-lang.org/stable/std/os/fd/trait.FromRawFd.html#tymethod.into_raw_fd
+        /// [`into_raw_fd`]: https://doc.rust-lang.org/stable/std/os/fd/trait.IntoRawFd.html#tymethod.into_raw_fd
         fn into_raw_fd(self) -> RawFd;
     }
     impl<T: IntoRawSocket> IntoRawFd for T {
diff --git a/src/backend/linux_raw/param/libc_auxv.rs b/src/backend/linux_raw/param/libc_auxv.rs
@@ -154,7 +154,7 @@ pub(crate) fn linux_secure() -> bool {
 #[inline]
 pub(crate) fn exe_phdrs() -> (*const c::c_void, usize, usize) {
     unsafe {
-        let phdr = getauxval(AT_PHDR) as *const c::c_void;
+        let phdr: *const c::c_void = getauxval(AT_PHDR);
         let phent = getauxval(AT_PHENT) as usize;
         let phnum = getauxval(AT_PHNUM) as usize;
         (phdr, phent, phnum)
diff --git a/src/backend/linux_raw/runtime/syscalls.rs b/src/backend/linux_raw/runtime/syscalls.rs
@@ -41,7 +41,7 @@ pub(crate) unsafe fn kernel_fork() -> io::Result<Fork> {
     //
     // Architectures differ on the order of the parameters.
     #[cfg(target_arch = "x86_64")]
-    let pid = ret_c_int(syscall_readonly!(
+    let pid = ret_c_int(syscall!(
         __NR_clone,
         c_int(c::SIGCHLD | c::CLONE_CHILD_SETTID),
         zero(),
@@ -62,7 +62,7 @@ pub(crate) unsafe fn kernel_fork() -> io::Result<Fork> {
         target_arch = "s390x",
         target_arch = "x86"
     ))]
-    let pid = ret_c_int(syscall_readonly!(
+    let pid = ret_c_int(syscall!(
         __NR_clone,
         c_int(c::SIGCHLD | c::CLONE_CHILD_SETTID),
         zero(),
diff --git a/src/io/dup.rs b/src/io/dup.rs
@@ -81,9 +81,9 @@ pub fn dup<Fd: AsFd>(fd: Fd) -> io::Result<OwnedFd> {
 /// [DragonFly BSD]: https://man.dragonflybsd.org/?command=dup2&section=2
 /// [illumos]: https://illumos.org/man/2/dup
 /// [glibc]: https://sourceware.org/glibc/manual/latest/html_node/Duplicating-Descriptors.html
-/// [`stdio::dup2_stdin`]: https://docs.rs/rustix/*/rustix/stdio/fn.dup2_stdin.html
-/// [`stdio::dup2_stdout`]: https://docs.rs/rustix/*/rustix/stdio/fn.dup2_stdout.html
-/// [`stdio::dup2_stderr`]: https://docs.rs/rustix/*/rustix/stdio/fn.dup2_stderr.html
+/// [`stdio::dup2_stdin`]: crate::stdio::dup2_stdin
+/// [`stdio::dup2_stdout`]: crate::stdio::dup2_stdout
+/// [`stdio::dup2_stderr`]: crate::stdio::dup2_stderr
 #[cfg(not(target_os = "wasi"))]
 #[inline]
 pub fn dup2<Fd: AsFd>(fd: Fd, new: &mut OwnedFd) -> io::Result<()> {
diff --git a/src/io/mod.rs b/src/io/mod.rs
@@ -1,9 +1,9 @@
 //! I/O operations.
 //!
-//! If you're looking for [`SeekFrom`], that's in the [`fs`] module.
+//! If you're looking for [`SeekFrom`], it's in the [`fs`] module.
 //!
-//! [`SeekFrom`]: https://docs.rs/rustix/*/rustix/fs/enum.SeekFrom.html
-//! [`fs`]: https://docs.rs/rustix/*/rustix/fs/index.html
+//! [`SeekFrom`]: crate::fs::SeekFrom
+//! [`fs`]: crate::fs
 
 mod close;
 #[cfg(not(windows))]
diff --git a/src/lib.rs b/src/lib.rs
@@ -94,8 +94,7 @@
 //! [`AsFd`]: https://doc.rust-lang.org/stable/std/os/fd/trait.AsFd.html
 //! [`OwnedFd`]: https://doc.rust-lang.org/stable/std/os/fd/struct.OwnedFd.html
 //! [I/O-safe]: https://github.com/rust-lang/rfcs/blob/master/text/3128-io-safety.md
-//! [`Result`]: https://doc.rust-lang.org/stable/std/result/enum.Result.html
-//! [`Arg`]: https://docs.rs/rustix/*/rustix/path/trait.Arg.html
+//! [`Arg`]: path::Arg
 //! [support for externally defined flags]: https://docs.rs/bitflags/*/bitflags/#externally-defined-flags
 
 #![deny(missing_docs)]
diff --git a/src/not_implemented.rs b/src/not_implemented.rs
@@ -25,7 +25,7 @@ macro_rules! not_implemented {
 ///
 /// [dlmalloc]: https://crates.io/crates/dlmalloc
 /// [talc]: https://crates.io/crates/talc
-/// [rustix-dlmalloc]: https://github.com/sunfishcode/rustix-dlmalloc
+/// [rustix-dlmalloc]: https://crates.io/crates/rustix-dlmalloc
 pub mod memory_allocation {
     not_implemented!(malloc);
     not_implemented!(realloc);
@@ -223,15 +223,15 @@ pub mod higher_level {
     not_implemented!(execvpe);
     not_implemented!(wordexp);
 
-    /// See [rustix-openpty](https://github.com/sunfishcode/rustix-openpty).
+    /// See [rustix-openpty](https://crates.io/crates/rustix-openpty).
     pub fn closefrom() {
         unimplemented!()
     }
-    /// See [rustix-openpty](https://github.com/sunfishcode/rustix-openpty).
+    /// See [rustix-openpty](https://crates.io/crates/rustix-openpty).
     pub fn login_tty() {
         unimplemented!()
     }
-    /// See [rustix-openpty](https://github.com/sunfishcode/rustix-openpty).
+    /// See [rustix-openpty](https://crates.io/crates/rustix-openpty).
     pub fn openpty() {
         unimplemented!()
     }
@@ -241,9 +241,9 @@ pub mod higher_level {
     /// For Rust < 1.70, see [is-terminal]. For a rustix-based implementation,
     /// see [rustix-is-terminal].
     ///
-    /// [`std::io::IsTerminal`]: https://doc.rust-lang.org/stable/std/io/trait.IsTerminal.html
+    /// [`std::io::IsTerminal`]: std::io::IsTerminal
     /// [is-terminal]: https://crates.io/crates/is-terminal
-    /// [rustix-is-terminal]: https://github.com/sunfishcode/rustix-is-terminal
+    /// [rustix-is-terminal]: https://crates.io/crates/rustix-is-terminal
     pub fn isatty() {
         unimplemented!()
     }
diff --git a/src/process/ioctl.rs b/src/process/ioctl.rs
@@ -61,7 +61,7 @@ unsafe impl ioctl::Ioctl for Tiocsctty {
     }
 
     fn as_ptr(&mut self) -> *mut c::c_void {
-        (&0_u32) as *const u32 as *mut c::c_void
+        crate::utils::as_ptr(&0_u32) as *mut c::c_void
     }
 
     unsafe fn output_from_ptr(
diff --git a/src/termios/mod.rs b/src/termios/mod.rs
@@ -3,10 +3,11 @@
 //! This API automatically supports setting arbitrary I/O speeds, on any
 //! platform that supports them, including Linux and the BSDs.
 //!
-//! The [`speed`] module contains various predefined speed constants which
-//! are more likely to be portable, however any `u32` value can be passed to
-//! [`Termios::set_input_speed`], and it will simply fail if the speed is not
-//! supported by the platform.
+//! The [`speed`] module contains various predefined speed constants which are
+//! more likely to be portable, however any `u32` value can be passed to
+//! [`Termios::set_speed`], [`Termios::set_input_speed`], and
+//! [`Termios::set_output_speed`], and they will simply fail if the speed is
+//! not supported by the platform or the device.
 
 #[cfg(not(any(target_os = "espidf", target_os = "haiku", target_os = "wasi")))]
 mod ioctl;
diff --git a/src/termios/types.rs b/src/termios/types.rs
@@ -647,14 +647,14 @@ bitflags! {
     }
 }
 
-/// Speeds for use with [`Termios::set_input_speed`] and
-/// [`Termios::set_output_speed`].
+/// Speeds for use with [`Termios::set_speed`], [`Termios::set_input_speed`],
+/// and [`Termios::set_output_speed`].
 ///
 /// Unlike in some platforms' libc APIs, these always have the same numerical
 /// value as their names; for example, `B50` has the value `50`, and so on.
 /// Consequently, it's not necessary to use them. They are provided here
 /// because they help identify speeds which are likely to be supported, on
-/// platforms which don't support arbitrary speeds.
+/// platforms and devices which don't support arbitrary speeds.
 pub mod speed {
     #[cfg(not(bsd))]
     use crate::backend::c;
diff --git a/src/timespec.rs b/src/timespec.rs
@@ -21,6 +21,13 @@ pub struct Timespec {
     pub tv_sec: Secs,
 
     /// Nanoseconds. Must be less than 1_000_000_000.
+    ///
+    /// When passed to [`rustix::fs::utimensat`], this field may instead be
+    /// assigned the values [`UTIME_NOW`] or [`UTIME_OMIT`].
+    ///
+    /// [`UTIME_NOW`]: crate::fs::UTIME_NOW
+    /// [`UTIME_OMIT`]: crate::fs::UTIME_OMIT
+    /// [`rustix::fs::utimensat`]: crate::fs::utimensat
     pub tv_nsec: Nsecs,
 }
 
diff --git a/tests/time/monotonic.rs b/tests/time/monotonic.rs
@@ -1,6 +1,6 @@
-use rustix::time::{clock_gettime, ClockId};
 #[cfg(feature = "thread")]
-use {rustix::thread::nanosleep, rustix::time::Timespec};
+use rustix::thread::nanosleep;
+use rustix::time::{clock_gettime, ClockId, Timespec};
 
 /// Attempt to test that the monotonic clock is monotonic. Time may or may not
 /// advance, but it shouldn't regress.

Original file line number	Diff line number	Diff line change
`@@ -61,7 +61,7 @@ unsafe impl ioctl::Ioctl for Tiocsctty {`
`61`	`61`	`}`
`62`	`62`
`63`	`63`	`fn as_ptr(&mut self) -> *mut c::c_void {`
`64`		`- (&0_u32) as const u32 as mut c::c_void`
	`64`	`+ crate::utils::as_ptr(&0_u32) as *mut c::c_void`
`65`	`65`	`}`
`66`	`66`
`67`	`67`	`unsafe fn output_from_ptr(`