readlink: document portability issue with symlink length
authorEric Blake <ebb9@byu.net>
Mon, 21 Sep 2009 20:40:20 +0000 (14:40 -0600)
committerEric Blake <ebb9@byu.net>
Wed, 23 Sep 2009 11:40:55 +0000 (05:40 -0600)
commit0510d19e64a0c3cfdd7ebe31866be9b45229590a
treefc5295aa5754612bdf8a5274f7d60816acee1d32
parent5835d9b52879c334f16e747c54be8ec9c62e8536
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>
ChangeLog
doc/posix-functions/fstatat.texi
doc/posix-functions/lstat.texi
doc/posix-functions/readlink.texi
doc/posix-functions/readlinkat.texi
tests/test-readlink.c