]> git.ipfire.org Git - thirdparty/glibc.git/commitdiff
manual: Clarify renameat documentation
authorJitka Obselkova <jobselko@redhat.com>
Sat, 14 Jun 2025 09:19:46 +0000 (11:19 +0200)
committerFlorian Weimer <fweimer@redhat.com>
Thu, 26 Jun 2025 12:24:40 +0000 (14:24 +0200)
Clarify the meaning of renameat arguments.

Reviewed-by: Collin Funk <collin.funk1@gmail.com>
manual/filesys.texi

index f21f21804251e480abbc8b51a41459c22840ad98..e1c7be867edbb4a6272e71fc2a9108456a9a110d 100644 (file)
@@ -1940,7 +1940,10 @@ file systems.
 @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}.
+function above.  @xref{Descriptor-Relative Access}.  If @var{oldname} or
+@var{newname} is a relative path, it is interpreted relative to the
+directory associated with @var{oldfiledes} or @var{newfiledes},
+respectively.  Absolute paths are interpreted in the usual way.
 
 Compared to @code{rename}, some additional error conditions can occur.
 @xref{Descriptor-Relative Access}.