From 6416c247f4ae767863628fc736e6eac4a929dd26 Mon Sep 17 00:00:00 2001 From: Paul Spooren Date: Wed, 6 Nov 2024 23:36:15 +0100 Subject: [PATCH] docs(fd): fix docstring warnings Signed-off-by: Paul Spooren --- util/src/fd.rs | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/util/src/fd.rs b/util/src/fd.rs index 34c219d..e0c7052 100644 --- a/util/src/fd.rs +++ b/util/src/fd.rs @@ -116,6 +116,10 @@ pub fn clone_fd_to_cloexec(fd: Fd, new: &mut OwnedFd) -> rustix::io::R } #[cfg(not(target_os = "linux"))] +/// Duplicate a file descriptor, setting the close on exec flag. +/// +/// This is slightly different from [clone_fd_cloexec], as this function supports specifying an +/// explicit destination file descriptor. pub fn clone_fd_to_cloexec(fd: Fd, new: &mut OwnedFd) -> rustix::io::Result<()> { use rustix::io::{dup2, fcntl_setfd, FdFlags}; dup2(&fd, new)?;