careadlinkat: Clarify specification.

[gnulib.git] / lib / careadlinkat.c

diff --git a/lib/careadlinkat.c b/lib/careadlinkat.c
index 7a7806d..01883db 100644 (file)
--- a/lib/careadlinkat.c
+++ b/lib/careadlinkat.c
@@ -65,7 +65,10 @@ careadlinkatcwd (int fd, char const *filename, char *buffer,
    the returned value if it is nonnull and is not BUFFER.  A null
    ALLOC stands for the standard allocator.
 
-   The PREADLINKAT function specifies how to read links.
+   The PREADLINKAT function specifies how to read links.  It operates
+   like POSIX readlinkat()
+   <http://pubs.opengroup.org/onlinepubs/9699919799/functions/readlink.html>
+   but can assume that its first argument is the same as FD.
 
    If successful, return the buffer address; otherwise return NULL and
    set errno.  */