From e6d6c5c5c70b546b5cbd926f2dcdd2a1b6c7d1b5 Mon Sep 17 00:00:00 2001 From: David Adam Date: Tue, 17 Sep 2019 20:48:22 +0800 Subject: [PATCH] docs: improve realpath documentation --- sphinx_doc_src/cmds/realpath.rst | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/sphinx_doc_src/cmds/realpath.rst b/sphinx_doc_src/cmds/realpath.rst index 5d594e492..7a567804d 100644 --- a/sphinx_doc_src/cmds/realpath.rst +++ b/sphinx_doc_src/cmds/realpath.rst @@ -13,6 +13,8 @@ Synopsis Description ----------- -This is implemented as a function and a builtin. The function will attempt to use an external realpath command if one can be found. Otherwise it falls back to the builtin. The builtin does not support any options. It's meant to be used only by scripts which need to be portable. The builtin implementation behaves like GNU realpath when invoked without any options (which is the most common use case). In general scripts should not invoke the builtin directly. They should just use ``realpath``. +``realpath`` resolves a path to its absolute path. -If the path is invalid no translated path will be written to stdout and an error will be reported. +fish provides a ``realpath`` builtin as a fallback for systems where there is no ``realpath`` command. fish's implementation always resolves its first argument, and does not support any options. + +If the operation fails, an error will be reported.