From 83bab7fa23d38db6886680a7f19dc19a688514b2 Mon Sep 17 00:00:00 2001 From: Raymond Toy <toy.raymond@gmail.com> Date: Thu, 17 Jan 2013 20:02:24 -0800 Subject: [PATCH] Document the return values for RENAME-FILE. --- src/code/filesys.lisp | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/src/code/filesys.lisp b/src/code/filesys.lisp index 308b8b542..9d224df5e 100644 --- a/src/code/filesys.lisp +++ b/src/code/filesys.lisp @@ -938,8 +938,13 @@ ;;; Rename-File -- Public ;;; (defun rename-file (file new-name) - "Rename File to have the specified New-Name. If file is a stream open to a - file, then the associated file is renamed." + "Rename File to have the specified New-Name. If file is a stream + open to a file, then the associated file is renamed. + + Three values are returned if successful: the defaulted new name + composed of New-Name with missing components filled in from File; + the truename of File before it was renamed; the new truename of the + File after it was renamed." (let* ((original (truename file)) (original-namestring (unix-namestring original t)) (new-name (merge-pathnames new-name file)) -- GitLab