doc: clarify current realpath --relative-base behavior
commita6342a320eebe522c42399733c8bb6be88749368
authorEric Blake <eblake@redhat.com>
Wed, 14 Mar 2012 20:02:59 +0000 (14 14:02 -0600)
committerEric Blake <eblake@redhat.com>
Tue, 20 Mar 2012 16:13:13 +0000 (20 10:13 -0600)
treea9cae45c71f73050d1f7335a4e0b146403a8d983
parentd42f3a4d41034d099bf29ade22221b401528c060
doc: clarify current realpath --relative-base behavior

For compatibility with MacOS relpath(1), as seen here:

http://opensource.apple.com/source/bootstrap_cmds/\
bootstrap_cmds-79/relpath.tproj/relpath.c

we implemented 'realpath --relative-base=dir1 --relative-to=dir2 file'
in the same way as 'relpath -d dir1 dir2 file'.  This can result
in --relative-base rendering --relative-to as a no-op if dir1 is a
child of dir2.  Document this.

* doc/coreutils.texi (realpath invocation): Mention restriction.
doc/coreutils.texi