Merge branch 'stable'

[gnulib.git] / doc / posix-functions / readlink.texi

diff --git a/doc/posix-functions/readlink.texi b/doc/posix-functions/readlink.texi
index be05c71..2348a84 100644 (file)
--- a/doc/posix-functions/readlink.texi
+++ b/doc/posix-functions/readlink.texi
@@ -2,15 +2,22 @@
 @section @code{readlink}
 @findex readlink
 
-POSIX specification: @url{http://www.opengroup.org/susv3xsh/readlink.html}
+POSIX specification:@* @url{http://www.opengroup.org/onlinepubs/9699919799/functions/readlink.html}
 
 Gnulib module: readlink
 
 Portability problems fixed by Gnulib:
 @itemize
 @item
+Some platforms mistakenly succeed on @code{readlink("link/",buf,len)}:
+FreeBSD 7.2, Solaris 9.
+@item
+On some platforms, @code{readlink} returns @code{int} instead of
+@code{ssize_t}:
+glibc 2.4, FreeBSD 6.0, OpenBSD 3.8, Cygwin 1.5.x.
+@item
 This function is missing on some platforms:
-mingw.
+mingw, MSVC 9.
 @end itemize
 
 Portability problems not fixed by Gnulib:
@@ -24,4 +31,12 @@ directories, Cygwin sets @code{errno} to @code{ENOENT} or @code{EIO} instead of
 When @code{readlink} is called on a file that is not a symbolic link:
 Irix may set @code{errno} to @code{ENXIO} instead of @code{EINVAL}.  Cygwin
 may set errno to @code{EACCES} instead of @code{EINVAL}.
+@item
+Symlink contents do not always have a trailing null byte, and there is
+no indication if symlink contents were truncated if the return value
+matches the length.  Furthermore, AIX 5.1 and HP-UX 11 set
+@code{errno} to @code{ERANGE} rather than returning truncated
+contents, and Linux sets @code{errno} to @code{EINVAL} if the
+requested length is zero.  Use the gnulib module areadlink for
+improved ability to read symlink contents.
 @end itemize