Minior code cleanups (#1276)

sunfishcode · web-flow · commit ce43fdde7aee · 2025-01-24T16:07:05.000-08:00
* Documentation cleanups.

* Fix compilaion with different configurations.
diff --git a/examples/stdio.rs b/examples/stdio.rs
@@ -6,6 +6,7 @@
 use rustix::termios::isatty;
 #[cfg(all(
     not(any(windows, target_os = "fuchsia")),
+    feature = "fs",
     feature = "termios",
     feature = "alloc"
 ))]
@@ -62,6 +63,7 @@ fn show<Fd: AsFd>(fd: Fd) -> io::Result<()> {
     #[cfg(feature = "termios")]
     if isatty(fd) {
         #[cfg(feature = "alloc")]
+        #[cfg(feature = "fs")]
         #[cfg(not(target_os = "fuchsia"))]
         println!(" - ttyname: {}", ttyname(fd, Vec::new())?.to_string_lossy());
 
diff --git a/src/backend/linux_raw/c.rs b/src/backend/linux_raw/c.rs
@@ -30,8 +30,8 @@ pub(crate) use linux_raw_sys::general::epoll_event;
         not(feature = "use-explicitly-provided-auxv"),
         any(
             feature = "param",
-            feature = "process",
             feature = "runtime",
+            feature = "thread",
             feature = "time",
             target_arch = "x86",
         )
diff --git a/src/backend/linux_raw/conv.rs b/src/backend/linux_raw/conv.rs
@@ -303,8 +303,8 @@ pub(super) fn socklen_t<'a, Num: ArgNumber>(i: socklen_t) -> ArgReg<'a, Num> {
         not(feature = "use-explicitly-provided-auxv"),
         any(
             feature = "param",
-            feature = "process",
             feature = "runtime",
+            feature = "thread",
             feature = "time",
             target_arch = "x86",
         )
diff --git a/src/backend/linux_raw/mod.rs b/src/backend/linux_raw/mod.rs
@@ -18,9 +18,9 @@
 mod arch;
 mod conv;
 mod reg;
-#[cfg(any(feature = "time", feature = "process", target_arch = "x86"))]
+#[cfg(any(feature = "time", feature = "thread", target_arch = "x86"))]
 mod vdso;
-#[cfg(any(feature = "time", feature = "process", target_arch = "x86"))]
+#[cfg(any(feature = "time", feature = "thread", target_arch = "x86"))]
 mod vdso_wrappers;
 
 #[cfg(feature = "event")]
@@ -32,8 +32,8 @@ pub(crate) mod event;
         not(feature = "use-explicitly-provided-auxv"),
         any(
             feature = "param",
-            feature = "process",
             feature = "runtime",
+            feature = "thread",
             feature = "time",
             target_arch = "x86",
         )
@@ -51,8 +51,8 @@ pub(crate) mod mount;
 pub(crate) mod net;
 #[cfg(any(
     feature = "param",
-    feature = "process",
     feature = "runtime",
+    feature = "thread",
     feature = "time",
     target_arch = "x86",
 ))]
diff --git a/src/backend/linux_raw/termios/syscalls.rs b/src/backend/linux_raw/termios/syscalls.rs
@@ -8,14 +8,17 @@
 use crate::backend::c;
 use crate::backend::conv::{by_ref, c_uint, ret};
 use crate::fd::BorrowedFd;
+#[cfg(feature = "alloc")]
+use crate::ffi::CStr;
 use crate::io;
 use crate::pid::Pid;
 use crate::termios::{
     speed, Action, ControlModes, InputModes, LocalModes, OptionalActions, OutputModes,
     QueueSelector, SpecialCodeIndex, Termios, Winsize,
 };
 #[cfg(feature = "alloc")]
-use crate::{ffi::CStr, fs::FileType, path::DecInt};
+#[cfg(feature = "fs")]
+use crate::{fs::FileType, path::DecInt};
 use core::mem::MaybeUninit;
 
 #[inline]
@@ -365,6 +368,7 @@ pub(crate) fn isatty(fd: BorrowedFd<'_>) -> bool {
 }
 
 #[cfg(feature = "alloc")]
+#[cfg(feature = "fs")]
 pub(crate) fn ttyname(fd: BorrowedFd<'_>, buf: &mut [MaybeUninit<u8>]) -> io::Result<usize> {
     let fd_stat = crate::backend::fs::syscalls::fstat(fd)?;
 
diff --git a/src/backend/linux_raw/thread/syscalls.rs b/src/backend/linux_raw/thread/syscalls.rs
@@ -20,8 +20,7 @@ use crate::thread::{
 use crate::utils::as_mut_ptr;
 use core::mem::MaybeUninit;
 use core::sync::atomic::AtomicU32;
-use linux_raw_sys::general::TIMER_ABSTIME;
-use linux_raw_sys::general::{membarrier_cmd, membarrier_cmd_flag};
+use linux_raw_sys::general::{membarrier_cmd, membarrier_cmd_flag, TIMER_ABSTIME};
 #[cfg(target_pointer_width = "32")]
 use {crate::utils::option_as_ptr, linux_raw_sys::general::timespec as __kernel_old_timespec};
 
diff --git a/src/backend/linux_raw/vdso_wrappers.rs b/src/backend/linux_raw/vdso_wrappers.rs
@@ -15,7 +15,7 @@ use super::reg::{ArgReg, RetReg, SyscallNumber, A0, A1, A2, A3, A4, A5, R0};
 use super::vdso;
 #[cfg(target_arch = "x86")]
 use core::arch::global_asm;
-#[cfg(feature = "process")]
+#[cfg(feature = "thread")]
 #[cfg(any(
     target_arch = "x86_64",
     target_arch = "x86",
@@ -33,7 +33,7 @@ use core::sync::atomic::Ordering::Relaxed;
 use linux_raw_sys::general::timespec as __kernel_old_timespec;
 #[cfg(any(
     all(
-        feature = "process",
+        feature = "thread",
         any(
             target_arch = "x86_64",
             target_arch = "x86",
@@ -114,7 +114,7 @@ pub(crate) fn clock_gettime_dynamic(which_clock: DynamicClockId<'_>) -> io::Resu
     }
 }
 
-#[cfg(feature = "process")]
+#[cfg(feature = "thread")]
 #[cfg(any(
     target_arch = "x86_64",
     target_arch = "x86",
@@ -266,7 +266,7 @@ pub(super) mod x86_via_vdso {
 #[cfg(feature = "time")]
 type ClockGettimeType = unsafe extern "C" fn(c::c_int, *mut Timespec) -> c::c_int;
 
-#[cfg(feature = "process")]
+#[cfg(feature = "thread")]
 #[cfg(any(
     target_arch = "x86_64",
     target_arch = "x86",
@@ -293,7 +293,7 @@ fn init_clock_gettime() -> ClockGettimeType {
 }
 
 /// Initialize `GETCPU` and return its value.
-#[cfg(feature = "process")]
+#[cfg(feature = "thread")]
 #[cfg(any(
     target_arch = "x86_64",
     target_arch = "x86",
@@ -324,7 +324,7 @@ fn init_syscall() -> SyscallType {
 struct Function;
 #[cfg(feature = "time")]
 static CLOCK_GETTIME: AtomicPtr<Function> = AtomicPtr::new(null_mut());
-#[cfg(feature = "process")]
+#[cfg(feature = "thread")]
 #[cfg(any(
     target_arch = "x86_64",
     target_arch = "x86",
@@ -394,7 +394,7 @@ unsafe fn _rustix_clock_gettime_via_syscall(
     ret(syscall!(__NR_clock_gettime, c_int(clockid), res))
 }
 
-#[cfg(feature = "process")]
+#[cfg(feature = "thread")]
 #[cfg(any(
     target_arch = "x86_64",
     target_arch = "x86",
@@ -458,7 +458,7 @@ fn minimal_init() {
             .ok();
     }
 
-    #[cfg(feature = "process")]
+    #[cfg(feature = "thread")]
     #[cfg(any(
         target_arch = "x86_64",
         target_arch = "x86",
@@ -545,7 +545,7 @@ fn init() {
             }
         }
 
-        #[cfg(feature = "process")]
+        #[cfg(feature = "thread")]
         #[cfg(any(
             target_arch = "x86_64",
             target_arch = "x86",
diff --git a/src/clockid.rs b/src/clockid.rs
@@ -25,6 +25,13 @@ pub enum ClockId {
     Monotonic = bitcast!(c::CLOCK_MONOTONIC),
 
     /// `CLOCK_UPTIME`
+    ///
+    /// On FreeBSD, this is an alias for [`Self::Boottime`].
+    ///
+    /// On OpenBSD, this differs from `Self::Boottime`; it only advances when
+    /// the system is not suspended.
+    ///
+    /// [`Self::Uptime`]: https://docs.rs/rustix/*/x86_64-unknown-freebsd/rustix/time/enum.ClockId.html#variant.Uptime
     #[cfg(any(freebsdlike, target_os = "openbsd"))]
     #[doc(alias = "CLOCK_UPTIME")]
     Uptime = c::CLOCK_UPTIME,
@@ -75,11 +82,6 @@ pub enum ClockId {
     Tai = bitcast!(c::CLOCK_TAI),
 
     /// `CLOCK_BOOTTIME`
-    ///
-    /// On FreeBSD, use [`Self::Uptime`], as `CLOCK_BOOTTIME` is an alias for
-    /// `CLOCK_UPTIME`.
-    ///
-    /// [`Self::Uptime`]: https://docs.rs/rustix/*/x86_64-unknown-freebsd/rustix/time/enum.ClockId.html#variant.Uptime
     #[cfg(any(linux_kernel, target_os = "fuchsia", target_os = "openbsd"))]
     #[doc(alias = "CLOCK_BOOTTIME")]
     Boottime = bitcast!(c::CLOCK_BOOTTIME),
diff --git a/src/lib.rs b/src/lib.rs
@@ -310,8 +310,8 @@ pub mod runtime;
     not(feature = "use-explicitly-provided-auxv"),
     any(
         feature = "param",
-        feature = "process",
         feature = "runtime",
+        feature = "thread",
         feature = "time",
         target_arch = "x86",
     )
@@ -328,8 +328,8 @@ pub(crate) mod fs;
     not(feature = "use-explicitly-provided-auxv"),
     any(
         feature = "param",
-        feature = "process",
         feature = "runtime",
+        feature = "thread",
         feature = "time",
         target_arch = "x86",
     )
diff --git a/src/net/sockopt.rs b/src/net/sockopt.rs
@@ -759,8 +759,9 @@ pub fn ipv6_multicast_hops<Fd: AsFd>(fd: Fd) -> io::Result<u32> {
 
 /// `setsockopt(fd, IPPROTO_IP, IP_ADD_MEMBERSHIP, multiaddr, interface)`
 ///
-/// This is similar to [`set_ip_add_membership`] but always sets `ifindex`
-/// value to zero.
+/// This is similar to [`set_ip_add_membership`] but always sets the `ifindex`
+/// value to zero. See [`set_ip_add_membership_with_ifindex`] instead to also
+/// give the `ifindex` value.
 ///
 /// See the [module-level documentation] for more.
 ///
@@ -778,8 +779,8 @@ pub fn set_ip_add_membership<Fd: AsFd>(
 /// `setsockopt(fd, IPPROTO_IP, IP_ADD_MEMBERSHIP, multiaddr, address,
 /// ifindex)`
 ///
-/// This is similar to [`set_ip_add_membership_with_ifindex`] but additionally
-/// allows a `ifindex` value to be given.
+/// This is similar to [`set_ip_add_membership`] but additionally allows an
+/// `ifindex` value to be given.
 ///
 /// See the [module-level documentation] for more.
 ///
diff --git a/src/path/arg.rs b/src/path/arg.rs
@@ -8,8 +8,7 @@
 
 use crate::ffi::CStr;
 use crate::io;
-use crate::path::DecInt;
-use crate::path::SMALL_PATH_BUFFER_SIZE;
+use crate::path::{DecInt, SMALL_PATH_BUFFER_SIZE};
 #[cfg(feature = "alloc")]
 use alloc::borrow::ToOwned;
 use core::mem::MaybeUninit;
diff --git a/src/process/wait.rs b/src/process/wait.rs
@@ -295,7 +295,7 @@ pub enum WaitId<'a> {
 /// # Bugs
 ///
 /// This function does not currently support waiting for given process group
-/// (the < 0 case of `waitpid`); to do that, currently the [`waitpgid`] or
+/// (the `< -1` case of `waitpid`); to do that, currently the [`waitpgid`] or
 /// [`waitid`] function must be used.
 ///
 /// This function does not currently support waiting for any process (the
diff --git a/src/termios/tty.rs b/src/termios/tty.rs
@@ -1,13 +1,14 @@
 //! Functions which operate on file descriptors which might be terminals.
 
 use crate::backend;
+#[cfg(feature = "alloc")]
+#[cfg(feature = "fs")]
+#[cfg(not(any(target_os = "fuchsia", target_os = "wasi")))]
+use crate::path::SMALL_PATH_BUFFER_SIZE;
 use backend::fd::AsFd;
 #[cfg(feature = "alloc")]
 #[cfg(not(any(target_os = "fuchsia", target_os = "wasi")))]
-use {
-    crate::ffi::CString, crate::io, crate::path::SMALL_PATH_BUFFER_SIZE, alloc::vec::Vec,
-    backend::fd::BorrowedFd,
-};
+use {crate::ffi::CString, crate::io, alloc::vec::Vec, backend::fd::BorrowedFd};
 
 /// `isatty(fd)`—Tests whether a file descriptor refers to a terminal.
 ///
@@ -34,14 +35,18 @@ pub fn isatty<Fd: AsFd>(fd: Fd) -> bool {
 /// [Linux]: https://man7.org/linux/man-pages/man3/ttyname.3.html
 #[cfg(not(any(target_os = "fuchsia", target_os = "wasi")))]
 #[cfg(feature = "alloc")]
+#[cfg(feature = "fs")]
 #[doc(alias = "ttyname_r")]
+#[cfg_attr(docsrs, doc(cfg(feature = "fs")))]
+#[cfg_attr(docsrs, doc(cfg(feature = "alloc")))]
 #[inline]
 pub fn ttyname<Fd: AsFd, B: Into<Vec<u8>>>(dirfd: Fd, reuse: B) -> io::Result<CString> {
     _ttyname(dirfd.as_fd(), reuse.into())
 }
 
 #[cfg(not(any(target_os = "fuchsia", target_os = "wasi")))]
 #[cfg(feature = "alloc")]
+#[cfg(feature = "fs")]
 #[allow(unsafe_code)]
 fn _ttyname(dirfd: BorrowedFd<'_>, mut buffer: Vec<u8>) -> io::Result<CString> {
     buffer.clear();
diff --git a/tests/event/select.rs b/tests/event/select.rs
@@ -1,7 +1,7 @@
 use rustix::event::{
-    fd_set_bound, fd_set_insert, fd_set_num_elements, fd_set_remove, FdSetElement, FdSetIter,
+    fd_set_bound, fd_set_insert, fd_set_num_elements, fd_set_remove, select, FdSetElement,
+    FdSetIter, Timespec,
 };
-use rustix::event::{select, Timespec};
 use rustix::fd::{AsRawFd, RawFd};
 #[cfg(feature = "pipe")]
 #[cfg(not(windows))]
diff --git a/tests/net/unix.rs b/tests/net/unix.rs
@@ -416,6 +416,7 @@ fn test_abstract_unix_msg_unconnected() {
     do_test_unix_msg_unconnected(name);
 }
 
+#[cfg(feature = "pipe")]
 #[cfg(not(any(target_os = "redox", target_os = "wasi")))]
 #[test]
 fn test_unix_msg_with_scm_rights() {
@@ -704,6 +705,7 @@ fn test_unix_peercred_implicit() {
 
 /// Like `test_unix_msg_with_scm_rights`, but with multiple file descriptors
 /// over multiple control messages.
+#[cfg(feature = "pipe")]
 #[cfg(not(any(target_os = "redox", target_os = "wasi")))]
 #[test]
 fn test_unix_msg_with_combo() {
diff --git a/tests/net/unix_alloc.rs b/tests/net/unix_alloc.rs
@@ -414,6 +414,7 @@ fn test_abstract_unix_msg_unconnected() {
     do_test_unix_msg_unconnected(name);
 }
 
+#[cfg(feature = "pipe")]
 #[cfg(not(any(target_os = "redox", target_os = "wasi")))]
 #[test]
 fn test_unix_msg_with_scm_rights() {
@@ -649,6 +650,7 @@ fn test_unix_peercred() {
 
 /// Like `test_unix_msg_with_scm_rights`, but with multiple file descriptors
 /// over multiple control messages.
+#[cfg(feature = "pipe")]
 #[cfg(not(any(target_os = "redox", target_os = "wasi")))]
 #[test]
 fn test_unix_msg_with_combo() {
diff --git a/tests/path/arg.rs b/tests/path/arg.rs
@@ -3,8 +3,7 @@
 
 use rustix::ffi::{CStr, CString};
 use rustix::io;
-use rustix::path::Arg;
-use rustix::path::DecInt;
+use rustix::path::{Arg, DecInt};
 use std::borrow::Cow;
 use std::ffi::{OsStr, OsString};
 use std::path::{Component, Components, Iter, Path, PathBuf};
diff --git a/tests/termios/main.rs b/tests/termios/main.rs
@@ -10,5 +10,6 @@ mod pgrp;
 mod sid;
 #[cfg(all(not(windows), feature = "pty"))]
 mod termios;
+#[cfg(feature = "fs")]
 #[cfg(not(any(windows, target_os = "fuchsia")))]
 mod ttyname;
