mirror/coreutils
1
0
Fork 0
mirror of https://https.git.savannah.gnu.org/git/coreutils.git synced 2026-01-26 15:29:07 +00:00
Code Issues Packages Projects Releases Wiki Activity

doc: note the relationship between realpath and readlink

Browse Source 
* doc/coreutils.texi (realpath invocation): Mention that realpath
is the preferred command for canonicalization.
(readlink invocation): Likewise.
* man/readlink.x: Likewise.
This commit is contained in:
Pádraig Brady 2017-02-08 20:45:32 -08:00
parent 1ddcd24d52
commit 99deaff7e8
2 changed files with 9 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
doc/coreutils.texi
View File

@ -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

2
man/readlink.x
View File

@ -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)