Docs fixes.

Author: sunfishcode

src/event/epoll.rs

@@ -82,6 +82,8 @@ use crate::io;
 use crate::timespec::Timespec;
 use core::ffi::c_void;
 use core::hash::{Hash, Hasher};
+#[cfg(doc)]
+use io::Errno;
 
 /// `epoll_create1(flags)`—Creates a new epoll object.
 ///
@@ -193,8 +195,8 @@ pub fn delete<EpollFd: AsFd, SourceFd: AsFd>(epoll: EpollFd, source: SourceFd) -
 /// Linux versions older than 5.11 (those that don't support `epoll_pwait2`)
 /// don't support timeouts greater than `c_int::MAX` milliseconds; if an
 /// unsupported timeout is passed, this function fails with
-/// [`io::Errno::INVAL`]. Enable the "linux_5_11" feature to enable the full
-/// range of timeouts.
+/// [`Errno::INVAL`]. Enable the "linux_5_11" feature to enable the full range
+/// of timeouts.
 ///
 /// # References
 ///  - [Linux]

src/event/kqueue.rs

@@ -6,12 +6,12 @@ use crate::pid::Pid;
 use crate::signal::Signal;
 use crate::timespec::Timespec;
 use crate::{backend, io};
-
 use backend::c::{self, intptr_t, kevent as kevent_t, uintptr_t};
 use backend::event::syscalls;
-
 use core::mem::zeroed;
 use core::time::Duration;
+#[cfg(doc)]
+use io::Errno;
 
 /// A `kqueue` event for use with [`kevent`].
 #[repr(transparent)]
@@ -400,7 +400,7 @@ pub fn kqueue() -> io::Result<OwnedFd> {
 /// `kqueue`.
 ///
 /// If an unsupported timeout is passed, this function fails with
-/// [`io::Errno::INVAL`].
+/// [`Errno::INVAL`].
 ///
 /// # Safety
 ///

src/event/poll.rs

@@ -1,13 +1,15 @@
 use crate::event::Timespec;
 use crate::{backend, io};
+#[cfg(doc)]
+use io::Errno;
 
 pub use backend::event::poll_fd::{PollFd, PollFlags};
 
 /// `poll(self.fds, timeout)`—Wait for events on lists of file descriptors.
 ///
 /// Some platforms (those that don't support `ppoll`) don't support timeouts
 /// greater than `c_int::MAX` milliseconds; if an unsupported timeout is
-/// passed, this function fails with [`io::Errno::INVAL`].
+/// passed, this function fails with [`Errno::INVAL`].
 ///
 /// On macOS, `poll` doesn't work on fds for /dev/tty or /dev/null, however
 /// [`select`] is available and does work on these fds.

src/event/port.rs

@@ -33,6 +33,8 @@ use crate::buffer::Buffer;
 use crate::fd::{AsFd, AsRawFd, OwnedFd};
 use crate::timespec::Timespec;
 use crate::{ffi, io};
+#[cfg(doc)]
+use io::Errno;
 
 pub use super::PollFlags;
 
@@ -124,7 +126,7 @@ pub unsafe fn dissociate_fd<Fd: AsFd, RawFd: AsRawFd>(port: Fd, object: RawFd) -
 /// `port_get(port, timeout)`—Gets an event from a port.
 ///
 /// If an unsupported timeout is passed, this function fails with
-/// [`io::Errno::INVAL`].
+/// [`Errno::INVAL`].
 ///
 /// # References
 ///  - [OpenSolaris]
@@ -145,7 +147,7 @@ pub fn get<Fd: AsFd>(port: Fd, timeout: Option<&Timespec>) -> io::Result<Event>
 /// To query the number of events without retrieving any, use [`getn_query`].
 ///
 /// If an unsupported timeout is passed, this function fails with
-/// [`io::Errno::INVAL`].
+/// [`Errno::INVAL`].
 ///
 /// # References
 ///  - [OpenSolaris]

src/event/select.rs

@@ -13,6 +13,8 @@ use crate::{backend, io};
 #[cfg(any(windows, target_os = "wasi"))]
 use core::mem::align_of;
 use core::mem::size_of;
+#[cfg(doc)]
+use io::Errno;
 
 /// wasi-libc's `fd_set` type. The libc bindings for it have private fields, so
 /// we redeclare it for ourselves so that we can access the fields. They're
@@ -70,7 +72,7 @@ pub struct FdSetElement(pub(crate) usize);
 /// containing at least `nfds.div_ceil(size_of::<FdSetElement>())` elements.
 ///
 /// If an unsupported timeout is passed, this function fails with
-/// [`io::Errno::INVAL`].
+/// [`Errno::INVAL`].
 ///
 /// This `select` wrapper differs from POSIX in that `nfds` is not limited to
 /// `FD_SETSIZE`. Instead of using the fixed-sized `fd_set` type, this function

src/fs/at.rs

@@ -27,6 +27,8 @@ use crate::fs::{Gid, Uid};
 use crate::fs::{Mode, OFlags};
 use crate::{backend, io, path};
 use backend::fd::AsFd;
+#[cfg(doc)]
+use io::Errno;
 #[cfg(feature = "alloc")]
 use {
     crate::ffi::{CStr, CString},
@@ -402,7 +404,7 @@ pub fn utimensat<P: path::Arg, Fd: AsFd>(
 ///
 /// Platform support for flags varies widely, for example on Linux
 /// [`AtFlags::SYMLINK_NOFOLLOW`] is not implemented and therefore
-/// [`io::Errno::OPNOTSUPP`] will be returned.
+/// [`Errno::OPNOTSUPP`] will be returned.
 ///
 /// # References
 ///  - [POSIX]

src/fs/statx.rs

@@ -5,6 +5,8 @@ use crate::fs::AtFlags;
 use crate::{backend, io, path};
 use backend::c;
 use bitflags::bitflags;
+#[cfg(doc)]
+use io::Errno;
 
 #[cfg(feature = "linux_4_11")]
 use backend::fs::syscalls::statx as _statx;
@@ -161,8 +163,8 @@ bitflags! {
 
 /// `statx(dirfd, path, flags, mask, statxbuf)`—Extended `stat`.
 ///
-/// This function returns [`io::Errno::NOSYS`] if `statx` is not available on
-/// the platform, such as Linux before 4.11. This also includes older Docker
+/// This function returns [`Errno::NOSYS`] if `statx` is not available on the
+/// platform, such as Linux before 4.11. This also includes older Docker
 /// versions where the actual syscall fails with different error codes; rustix
 /// handles this and translates them into `NOSYS`.
 ///

src/process/procctl.rs

@@ -5,21 +5,21 @@
 
 #![allow(unsafe_code)]
 
-#[cfg(feature = "alloc")]
-use alloc::{vec, vec::Vec};
-use core::mem::MaybeUninit;
-use core::num::NonZeroI32;
-use core::ptr;
-
-use bitflags::bitflags;
-
 use crate::backend::process::syscalls;
 use crate::backend::process::types::RawId;
 use crate::ffi::{c_int, c_uint, c_void};
 use crate::io;
 use crate::process::{Pid, RawPid};
 use crate::signal::Signal;
 use crate::utils::{as_mut_ptr, as_ptr};
+#[cfg(feature = "alloc")]
+use alloc::{vec, vec::Vec};
+use bitflags::bitflags;
+use core::mem::MaybeUninit;
+use core::num::NonZeroI32;
+use core::ptr;
+#[cfg(doc)]
+use io::Errno;
 
 //
 // Helper functions.
@@ -471,7 +471,7 @@ pub enum TrapCapBehavior {
 ///
 /// If this behavior is enabled, the kernel would deliver a [`Signal::Trap`]
 /// signal on any return from a system call that would result in a
-/// [`io::Errno::NOTCAPABLE`] or [`io::Errno::CAPMODE`] error.
+/// [`Errno::NOTCAPABLE`] or [`Errno::CAPMODE`] error.
 ///
 /// This behavior is inherited by the children of the process and is kept
 /// across `execve` calls.

src/pty.rs

@@ -11,6 +11,8 @@ use crate::backend::c;
 use crate::fd::{AsFd, OwnedFd};
 use crate::fs::OFlags;
 use crate::{backend, io};
+#[cfg(doc)]
+use io::Errno;
 #[cfg(all(
     feature = "alloc",
     any(
@@ -64,8 +66,8 @@ impl From<OpenptFlags> for OFlags {
 /// close-on-exec flag be set.
 ///
 /// On Linux, if the system has no free pseudoterminals available, the
-/// underlying system call fails with [`io::Errno::NOSPC`], however this rustix
-/// function translates that to [`io::Errno::AGAIN`], so that the linux_raw and
+/// underlying system call fails with [`Errno::NOSPC`], however this rustix
+/// function translates that to [`Errno::AGAIN`], so that the linux_raw and
 /// libc backends have the same behavior.
 ///
 /// # References

src/termios/ioctl.rs

@@ -5,11 +5,13 @@
 use crate::fd::AsFd;
 use crate::{backend, io, ioctl};
 use backend::c;
+#[cfg(doc)]
+use io::Errno;
 
 /// `ioctl(fd, TIOCEXCL)`—Enables exclusive mode on a terminal.
 ///
 /// In exclusive mode, subsequent unprivileged `open` calls on the terminal
-/// device fail with [`io::Errno::BUSY`].
+/// device fail with [`Errno::BUSY`].
 ///
 /// # References
 ///  - [Linux]