Documentation and test cleanups. (#1357)

* Documentation and test cleanups.

Fix broken links and typos in documentaion, and add a testt for the
`ioctl::opcode` functions.

* Mention `rustix::ioctl` in the README.md.

* Fix and enable the `secure_computing_mode` test.

* Use a Rust-style signal name in a comment.

* Remove some redundant `cfg`s.

Author: sunfishcode

CHANGES.md

@@ -92,11 +92,14 @@ The `rustix::procfs` is removed. This functionality is now available in the
 
 [rustix-linux-procfs crate]: https://crates.io/crates/rustix-linux-procfs
 
-The `flags` field of [`rustix::net::RecvMsgReturn`] changed type from
-[`RecvFlags`] to a new [`ReturnFlags`], since it supports a different set of
-flags.
+`rustix::net::RecvMsgReturn` is renamed to [`rustix::net::RecvMsg`].
+
+[`rustix::net::RecvMsg`]: https://docs.rs/rustix/1.0.0/rustix/net/struct.RecvMsg.html
+
+The `flags` field of [`rustix::net::RecvMsg`] changed type from [`RecvFlags`]
+to a new [`ReturnFlags`], since it supports a different set of flags.
 
-[`rustix::net::RecvMsgReturn`]: https://docs.rs/rustix/1.0.0/rustix/net/struct.RecvMsgReturn.html
+[`rustix::net::RecvMsg`]: https://docs.rs/rustix/1.0.0/rustix/net/struct.RecvMsg.html
 [`RecvFlags`]: https://docs.rs/rustix/1.0.0/rustix/net/struct.RecvFlags.html
 [`ReturnFlags`]: https://docs.rs/rustix/1.0.0/rustix/net/struct.ReturnFlags.html
 
@@ -106,8 +109,8 @@ mean a timeout in milliseconds to an `Option<&Timespec>`. The [`Timespec`]'s
 fields are `tv_sec` which holds seconds and `tv_nsec` which holds nanoseconds.
 
 [`rustix::event::poll`]: https://docs.rs/rustix/1.0.0/rustix/event/fn.poll.html
-[`rustix::event::epoll`]: https://docs.rs/rustix/1.0.0/rustix/event/fn.epoll.html
-[`Timespec`]: https://docs.rs/rustix/1.0.0/rustix/time/type.Timespec.html
+[`rustix::event::epoll`]: https://docs.rs/rustix/1.0.0/rustix/event/epoll/index.html
+[`Timespec`]: https://docs.rs/rustix/1.0.0/rustix/time/struct.Timespec.html
 
 Functions in [`rustix::event::port`] are renamed to remove the redundant
 `port_*` prefix.
@@ -124,22 +127,22 @@ Functions in [`rustix::event::port`] are renamed to remove the redundant
 directly. They are now signed instead of unsigned, so that they can represent
 times before the epoch.
 
-[`rustix::fs::Stat`]: https://docs.rs/rustix/1.0.0/rustix/fs/type.Stat.html
+[`rustix::fs::Stat`]: https://docs.rs/rustix/1.0.0/rustix/fs/struct.Stat.html
 
 `rustix::io::is_read_write` is removed, as it's higher-level functionality that
 can be implemented in terms of lower-level rustix calls.
 
-[`rustix::net::recv_uninit`] and [`rustix::net::recvfrom_uninit`] now include
+[`rustix::net::recv`] and [`rustix::net::recvfrom`] now include
 the number of received bytes in their return types, as this number may differ
 from the number of bytes written to the buffer when
 [`rustix::net::RecvFlags::TRUNC`] is used.
 
-[`rustix::net::recv_uninit`]: https://docs.rs/rustix/1.0.0/rustix/net/fn.recv_uninit.html
-[`rustix::net::recvfrom_uninit`]: https://docs.rs/rustix/1.0.0/rustix/net/fn.recvfrom_uninit.html
+[`rustix::net::recv`]: https://docs.rs/rustix/1.0.0/rustix/net/fn.recv.html
+[`rustix::net::recvfrom`]: https://docs.rs/rustix/1.0.0/rustix/net/fn.recvfrom.html
 [`rustix::net::RecvFlags::TRUNC`]: https://docs.rs/rustix/1.0.0/rustix/net/struct.RecvFlags.html#associatedconstant.TRUNC
 
 [`rustix::io_uring::io_uring_register`] now has a [`IoringRegisterFlags`]
-argument, and `rustix::io_uring::io_uring_register` is removed.
+argument, and `rustix::io_uring::io_uring_register_with` is removed.
 
 [`rustix::io_uring::io_uring_register`]: https://docs.rs/rustix/1.0.0/rustix/io_uring/fn.io_uring_register.html
 [`IoringRegisterFlags`]: https://docs.rs/rustix/1.0.0/rustix/io_uring/struct.IoringRegisterFlags.html
@@ -148,20 +151,16 @@ argument, and `rustix::io_uring::io_uring_register` is removed.
 `Signal::Int` is now named [`Signal::INT`]. Also, `Signal` is no longer
 directly convertible to `i32`; use [`Signal::as_raw`] instead.
 
-[`rustix::process::Signal`]: https://docs.rs/rustix/1.0.0/rustix/process/enum.Signal.html
-[`Signal::INT`]: https://docs.rs/rustix/1.0.0/rustix/process/enum.Signal.html#variant.Int
-[`Signal::as_raw`]: https://docs.rs/rustix/1.0.0/rustix/process/enum.Signal.html#method.as_raw
+[`rustix::process::Signal`]: https://docs.rs/rustix/1.0.0/rustix/process/struct.Signal.html
+[`Signal::INT`]: https://docs.rs/rustix/1.0.0/rustix/process/struct.Signal.html#variant.Int
+[`Signal::as_raw`]: https://docs.rs/rustix/1.0.0/rustix/process/struct.Signal.html#method.as_raw
 
 The associated constant `rustix::ioctl::Ioctl::OPCODE` is now replaced with an
 associated method [`rustix::ioctl::Ioctl::opcode`], to support ioctls where the
 opcode is computed rather than a constant.
 
 [`rustix::ioctl::Ioctl::opcode`]: https://docs.rs/rustix/1.0.0/rustix/ioctl/trait.Ioctl.html#tymethod.opcode
 
-`rustix::net::RecvMsgReturn` is renamed to [`rustix::net::RecvMsg`].
-
-[`rustix::net::RecvMsg`]: https://docs.rs/rustix/1.0.0/rustix/net/struct.RecvMsgReturn.html
-
 The `ifindex` argument in
 [`rustix::net::sockopt::set_ip_add_membership_with_ifindex`] and
 [`rustix::net::sockopt::set_ip_drop_membership_with_ifindex`]
@@ -172,7 +171,7 @@ changed from `i32` to `u32`.
 
 The `list` argument in [`rustix::fs::listxattr`], [`rustix::fs::flistxattr`],
 and [`rustix::fs::llistxattr`] changed from `[c_char]`, which is `[i8]` on some
-architectures, to [`u8`].
+architectures, to `[u8]`.
 
 [`rustix::fs::listxattr`]: https://docs.rs/rustix/1.0.0/rustix/fs/fn.listxattr.html
 [`rustix::fs::flistxattr`]: https://docs.rs/rustix/1.0.0/rustix/fs/fn.flistxattr.html
@@ -188,7 +187,7 @@ with other platforms:
 | `st_ctimensec` | `st_ctime_nsec` |
 | `st_birthtimensec` | `st_birthtime_nsec` |
 
-[`Stat`]: https://docs.rs/rustix/1.0.0/x86_64-unknown-netbsd/rustix/fs/type.Stat.html
+[`Stat`]: https://docs.rs/rustix/1.0.0/x86_64-unknown-netbsd/rustix/fs/struct.Stat.html
 
 [`rustix::mount::mount`]'s `data` argument is now an `Option`, so it can now
 be used in place of `mount2`, and `mount2` is now removed.
@@ -247,13 +246,14 @@ pointer provenance.
 
 The aliases for [`fcntl_dupfd_cloexec`], [`fcntl_getfd`], and [`fcntl_setfd`]
 in `rustix::fs` are removed; these functions are just available in
-`rustix::io` now.
+[`rustix::io`] now.
 
 [`fcntl_dupfd_cloexec`]: https://docs.rs/rustix/1.0.0/rustix/io/fn.fcntl_dupfd_cloexec.html
 [`fcntl_getfd`]: https://docs.rs/rustix/1.0.0/rustix/io/fn.fcntl_getfd.html
 [`fcntl_setfd`]: https://docs.rs/rustix/1.0.0/rustix/io/fn.fcntl_setfd.html
+[`rustix::io`]: https://docs.rs/rustix/1.0.0/rustix/io/index.html
 
-[`SocketAddrXdp`] no longer has a shared umem field. A new
+[`SocketAddrXdp`] no longer has a shared UMEM field. A new
 [`SocketAddrXdpWithSharedUmem`] is added for the purpose of calling `bind` and
 passing it an XDP address with a shared UMEM fd. And `SockaddrXdpFlags` is
 renamed to [`SocketAddrXdpFlags`].
@@ -303,11 +303,11 @@ vector before calling `epoll::wait` or `kqueue`, or consuming it using
 [`Buffer` trait]: https://docs.rs/rustix/1.0.0/rustix/buffer/trait.Buffer.html
 [`spare_capacity`]: https://docs.rs/rustix/1.0.0/rustix/buffer/fn.spare_capacity.html
 
-The `Opcode` type has changed from a struct to a raw integer value, and the
-associated utilities are change to `const` functions. In place of `ReadOpcode`,
-`WriteOpcode`, `ReadWriteOpcode`, and `NoneOpcode`, use the `read`, `write`,
-`read_write`, and `none` const functions in the [`ioctl::opcode`] module. For
-example, in place of this:
+The [`rustix::ioctl::Opcode`] type has changed from a struct to a raw integer
+value, and the associated utilities are change to `const` functions. In place
+of `ReadOpcode`, `WriteOpcode`, `ReadWriteOpcode`, and `NoneOpcode`, use the
+`read`, `write`, `read_write`, and `none` const functions in the
+[`ioctl::opcode`] module. For example, in place of this:
 ```rust
 ioctl::Setter::<ioctl::ReadOpcode<b'U', 15, c_uint>, c_uint>::new(interface)
 ```
@@ -319,6 +319,7 @@ use this:
 
 In place of `BadOpcode`, use the opcode value directly.
 
+[`rustix::ioctl::Opcode`]: https://docs.rs/rustix/1.0.0/rustix/ioctl/type.Opcode.html
 [`ioctl::opcode`]: https://docs.rs/rustix/1.0.0/rustix/ioctl/opcode/index.html
 
 All explicitly deprecated functions and types have been removed. Their

README.md

@@ -52,8 +52,9 @@ building.
 
 ## Cargo features
 
-The modules [`rustix::io`], [`rustix::fd`], and [`rustix::ffi`] are enabled by
-default. The rest of the API is conditional with cargo feature flags:
+The modules [`rustix::io`], [`rustix::fd`], [`rustix::ffi`], and
+[`rustix::ioctl`] are enabled by default. The rest of the API is conditional
+with cargo feature flags:
 
 | Name       | Description                                                    |
 | ---------- | -------------------------------------------------------------- |
@@ -97,6 +98,7 @@ default. The rest of the API is conditional with cargo feature flags:
 [`rustix::io`]: https://docs.rs/rustix/*/rustix/io/index.html
 [`rustix::fd`]: https://docs.rs/rustix/*/rustix/fd/index.html
 [`rustix::ffi`]: https://docs.rs/rustix/*/rustix/ffi/index.html
+[`rustix::ioctl`]: https://docs.rs/rustix/*/rustix/ffi/ioctl.html
 
 ## 64-bit Large File Support (LFS) and Year 2038 (y2038) support
 

src/backend/libc/mount/syscalls.rs

@@ -1,8 +1,5 @@
 use crate::backend::c;
-use crate::backend::conv::ret;
-#[cfg(feature = "mount")]
-use crate::backend::conv::{borrowed_fd, c_str, ret_owned_fd};
-#[cfg(feature = "mount")]
+use crate::backend::conv::{borrowed_fd, c_str, ret, ret_owned_fd};
 use crate::fd::{BorrowedFd, OwnedFd};
 use crate::ffi::CStr;
 use crate::io;
@@ -33,7 +30,6 @@ pub(crate) fn unmount(target: &CStr, flags: super::types::UnmountFlags) -> io::R
 }
 
 #[cfg(linux_kernel)]
-#[cfg(feature = "mount")]
 pub(crate) fn fsopen(fs_name: &CStr, flags: super::types::FsOpenFlags) -> io::Result<OwnedFd> {
     syscall! {
         fn fsopen(
@@ -45,7 +41,6 @@ pub(crate) fn fsopen(fs_name: &CStr, flags: super::types::FsOpenFlags) -> io::Re
 }
 
 #[cfg(linux_kernel)]
-#[cfg(feature = "mount")]
 pub(crate) fn fsmount(
     fs_fd: BorrowedFd<'_>,
     flags: super::types::FsMountFlags,
@@ -62,7 +57,6 @@ pub(crate) fn fsmount(
 }
 
 #[cfg(linux_kernel)]
-#[cfg(feature = "mount")]
 pub(crate) fn move_mount(
     from_dfd: BorrowedFd<'_>,
     from_pathname: &CStr,
@@ -91,7 +85,6 @@ pub(crate) fn move_mount(
 }
 
 #[cfg(linux_kernel)]
-#[cfg(feature = "mount")]
 pub(crate) fn open_tree(
     dfd: BorrowedFd<'_>,
     filename: &CStr,
@@ -109,7 +102,6 @@ pub(crate) fn open_tree(
 }
 
 #[cfg(linux_kernel)]
-#[cfg(feature = "mount")]
 pub(crate) fn fspick(
     dfd: BorrowedFd<'_>,
     path: &CStr,
@@ -126,7 +118,6 @@ pub(crate) fn fspick(
     unsafe { ret_owned_fd(fspick(borrowed_fd(dfd), c_str(path), flags.bits())) }
 }
 
-#[cfg(feature = "mount")]
 #[cfg(linux_kernel)]
 syscall! {
     fn fsconfig(
@@ -139,7 +130,6 @@ syscall! {
 }
 
 #[cfg(linux_kernel)]
-#[cfg(feature = "mount")]
 pub(crate) fn fsconfig_set_flag(fs_fd: BorrowedFd<'_>, key: &CStr) -> io::Result<()> {
     unsafe {
         ret(fsconfig(
@@ -153,7 +143,6 @@ pub(crate) fn fsconfig_set_flag(fs_fd: BorrowedFd<'_>, key: &CStr) -> io::Result
 }
 
 #[cfg(linux_kernel)]
-#[cfg(feature = "mount")]
 pub(crate) fn fsconfig_set_string(
     fs_fd: BorrowedFd<'_>,
     key: &CStr,
@@ -171,7 +160,6 @@ pub(crate) fn fsconfig_set_string(
 }
 
 #[cfg(linux_kernel)]
-#[cfg(feature = "mount")]
 pub(crate) fn fsconfig_set_binary(
     fs_fd: BorrowedFd<'_>,
     key: &CStr,
@@ -189,7 +177,6 @@ pub(crate) fn fsconfig_set_binary(
 }
 
 #[cfg(linux_kernel)]
-#[cfg(feature = "mount")]
 pub(crate) fn fsconfig_set_fd(
     fs_fd: BorrowedFd<'_>,
     key: &CStr,
@@ -207,7 +194,6 @@ pub(crate) fn fsconfig_set_fd(
 }
 
 #[cfg(linux_kernel)]
-#[cfg(feature = "mount")]
 pub(crate) fn fsconfig_set_path(
     fs_fd: BorrowedFd<'_>,
     key: &CStr,
@@ -226,7 +212,6 @@ pub(crate) fn fsconfig_set_path(
 }
 
 #[cfg(linux_kernel)]
-#[cfg(feature = "mount")]
 pub(crate) fn fsconfig_set_path_empty(
     fs_fd: BorrowedFd<'_>,
     key: &CStr,
@@ -244,7 +229,6 @@ pub(crate) fn fsconfig_set_path_empty(
 }
 
 #[cfg(linux_kernel)]
-#[cfg(feature = "mount")]
 pub(crate) fn fsconfig_create(fs_fd: BorrowedFd<'_>) -> io::Result<()> {
     unsafe {
         ret(fsconfig(
@@ -258,7 +242,6 @@ pub(crate) fn fsconfig_create(fs_fd: BorrowedFd<'_>) -> io::Result<()> {
 }
 
 #[cfg(linux_kernel)]
-#[cfg(feature = "mount")]
 pub(crate) fn fsconfig_reconfigure(fs_fd: BorrowedFd<'_>) -> io::Result<()> {
     unsafe {
         ret(fsconfig(
@@ -272,7 +255,6 @@ pub(crate) fn fsconfig_reconfigure(fs_fd: BorrowedFd<'_>) -> io::Result<()> {
 }
 
 #[cfg(linux_kernel)]
-#[cfg(feature = "mount")]
 pub(crate) fn fsconfig_create_excl(fs_fd: BorrowedFd<'_>) -> io::Result<()> {
     unsafe {
         ret(fsconfig(

src/backend/libc/mount/types.rs

@@ -83,7 +83,6 @@ bitflags! {
     }
 }
 
-#[cfg(feature = "mount")]
 #[cfg(linux_kernel)]
 bitflags! {
     /// `FSOPEN_*` constants for use with [`fsopen`].
@@ -100,7 +99,6 @@ bitflags! {
     }
 }
 
-#[cfg(feature = "mount")]
 #[cfg(linux_kernel)]
 bitflags! {
     /// `FSMOUNT_*` constants for use with [`fsmount`].
@@ -118,7 +116,6 @@ bitflags! {
 }
 
 /// `FSCONFIG_*` constants for use with the `fsconfig` syscall.
-#[cfg(feature = "mount")]
 #[cfg(linux_kernel)]
 #[derive(Debug, Copy, Clone, Eq, PartialEq)]
 #[repr(u32)]
@@ -151,7 +148,6 @@ pub(crate) enum FsConfigCmd {
     CreateExclusive = 8,
 }
 
-#[cfg(feature = "mount")]
 #[cfg(linux_kernel)]
 bitflags! {
     /// `MOUNT_ATTR_*` constants for use with [`fsmount`].
@@ -201,7 +197,6 @@ bitflags! {
     }
 }
 
-#[cfg(feature = "mount")]
 #[cfg(linux_kernel)]
 bitflags! {
     /// `MOVE_MOUNT_*` constants for use with [`move_mount`].
@@ -242,7 +237,6 @@ bitflags! {
     }
 }
 
-#[cfg(feature = "mount")]
 #[cfg(linux_kernel)]
 bitflags! {
     /// `OPENTREE_*` constants for use with [`open_tree`].
@@ -274,7 +268,6 @@ bitflags! {
     }
 }
 
-#[cfg(feature = "mount")]
 #[cfg(linux_kernel)]
 bitflags! {
     /// `FSPICK_*` constants for use with [`fspick`].