X-Git-Url: http://erislabs.net/gitweb/?a=blobdiff_plain;f=doc%2Fposix-functions%2Freadlink.texi;h=de898fba1eb59c9800eaa0aa82162b5b87fdb736;hb=def5620070337b3aadabd4c65e56524dd2352a34;hp=e2a2a1e3adf02534a64c456a5e25ec24a5e44fad;hpb=09ef7461110822a3970aa8eebcfaa740996a82f2;p=gnulib.git

diff --git a/doc/posix-functions/readlink.texi b/doc/posix-functions/readlink.texi
index e2a2a1e3a..de898fba1 100644
--- a/doc/posix-functions/readlink.texi
+++ b/doc/posix-functions/readlink.texi
@@ -9,6 +9,13 @@ 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}:
+FreeBSD 6.0, OpenBSD 3.8, Cygwin 1.5.x.
+@item
 This function is missing on some platforms:
 mingw.
 @end itemize
@@ -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