[PATCH 3/5] manual: Document renameat

Arjun Shankar arjun@redhat.com
Thu Dec 19 16:12:07 GMT 2024


---
 manual/filesys.texi | 23 ++++++++++++++++++++++-
 1 file changed, 22 insertions(+), 1 deletion(-)

diff --git a/manual/filesys.texi b/manual/filesys.texi
index 7062569748..53718830e7 100644
--- a/manual/filesys.texi
+++ b/manual/filesys.texi
@@ -1826,6 +1826,28 @@ file systems.
 @end table
 @end deftypefun
 
+@deftypefun int renameat (int @var{oldfiledes}, const char *@var{oldname}, int @var{newfiledes}, const char *@var{newname})
+@standards{POSIX.1-2008, stdio.h}
+@comment Unaudited and therefore marked AC-Unsafe and AS-Unsafe by default
+@safety{@mtsafe{}@asunsafe{@asucorrupt{}}@acunsafe{@acucorrupt{}}}
+This function is a descriptor-relative version of the @code{rename}
+function above.  @xref{Descriptor-Relative Access}.
+
+Compared to @code{rename}, the following additional error conditions can
+occur:
+
+@table @code
+@item EBADF
+The @var{oldfiledes} and/or @var{newfiledes} arguments are not valid file
+descriptors.
+
+@item ENOTDIR
+The descriptor @var{oldfiledes} is not associated with a directory, and
+@var{oldname} is a relative file name, or correspondingly similar condition
+for @var{newfiledes} and @var{newname}.
+@end table
+@end deftypefun
+
 @node Creating Directories
 @section Creating Directories
 @cindex creating a directory
@@ -3820,7 +3842,6 @@ The @code{mkdtemp} function comes from OpenBSD.
 @c openat
 @c open_by_handle_at
 @c readlinkat
-@c renameat
 @c renameat2
 @c scandirat
 @c symlinkat
-- 
2.47.1



More information about the Libc-alpha mailing list