view doc/posix-functions/readlink.texi @ 12060:95a12a00ea4f

readlink: document portability issue with symlink length Per comments in areadlink, ERANGE on a too-small buffer is expected on some platforms; making the readlink module guarantee GNU behavior of truncated contents is counter-productive, since we would be duplicating areadlink to learn a-priori how large to make the buffer, and since truncated contents are not as useful. * doc/posix-functions/lstat.texi (lstat): Mention that some file systems have bogus st_size on symlinks, and mention the areadlink-with-size module. * doc/posix-functions/fstatat.texi (fstatat): Likewise. * doc/posix-functions/readlink.texi (readlink): Mention the areadlink module, and ERANGE failure. * doc/posix-functions/readlinkat.texi (readlinkat): Likewise. * tests/test-readlink.c (main): Relax test for AIX, HP-UX. Signed-off-by: Eric Blake <ebb9@byu.net>
author Eric Blake <ebb9@byu.net>
date Mon, 21 Sep 2009 14:40:20 -0600
parents 6babf16a67dd
children 0583a6917a64
line wrap: on
line source

@node readlink
@section @code{readlink}
@findex readlink

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)}:
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

Portability problems not fixed by Gnulib:
@itemize
@item
When @code{readlink} is called on a directory: In the case of NFS mounted
directories, Cygwin sets @code{errno} to @code{ENOENT} or @code{EIO} instead of
@code{EINVAL}.  To avoid this problem, check for a directory before calling
@code{readlink}.
@item
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