summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorPádraig Brady <P@draigBrady.com>2017-02-08 20:45:32 -0800
committerPádraig Brady <P@draigBrady.com>2017-02-09 21:52:23 -0800
commit99deaff7e804298cecc326142bbe7263e2576224 (patch)
tree745758ac56da6b33e40e1f5a470f6d6e149b5987
parent1ddcd24d52afbe9af1d7d8712674eed2221cef97 (diff)
downloadcoreutils-99deaff7e804298cecc326142bbe7263e2576224.tar.xz
doc: note the relationship between realpath and readlink
* doc/coreutils.texi (realpath invocation): Mention that realpath is the preferred command for canonicalization. (readlink invocation): Likewise. * man/readlink.x: Likewise.
-rw-r--r--doc/coreutils.texi8
-rw-r--r--man/readlink.x2
2 files changed, 9 insertions, 1 deletions
diff --git a/doc/coreutils.texi b/doc/coreutils.texi
index 629136b01..3eac96b7d 100644
--- a/doc/coreutils.texi
+++ b/doc/coreutils.texi
@@ -10260,7 +10260,8 @@ of a symbolic link, it produces no output and exits with a nonzero exit code.
@command{readlink} outputs the absolute name of the given files which contain
no @file{.}, @file{..} components nor any repeated separators
-(@file{/}) or symbolic links.
+(@file{/}) or symbolic links. Note the @command{realpath} command is the
+preferred command to use for canonicalization. @xref{realpath invocation}
@end table
@@ -13685,6 +13686,11 @@ all but the last component of the specified files must exist. Synopsis:
realpath [@var{option}]@dots{} @var{file}@dots{}
@end example
+The file name canonicalization functionality overlaps with that of the
+@command{readlink} command. This is the preferred command for
+canonicalization as it's a more suitable and standard name. In addition
+this command supports relative file name processing functionality.
+
The program accepts the following options. Also see @ref{Common options}.
@table @samp
diff --git a/man/readlink.x b/man/readlink.x
index 6b28bca47..3141cd253 100644
--- a/man/readlink.x
+++ b/man/readlink.x
@@ -2,5 +2,7 @@
readlink \- print resolved symbolic links or canonical file names
[DESCRIPTION]
.\" Add any additional description here
+Note realpath(1) is the preferred command to use
+for canonicalization functionality.
[SEE ALSO]
readlink(2), realpath(1), realpath(3)