summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorEli Zaretskii <eliz@gnu.org>2015-03-07 11:55:58 +0200
committerEli Zaretskii <eliz@gnu.org>2015-03-07 11:55:58 +0200
commiteb62887e97a3be6f4fc8769479a30827163ea775 (patch)
tree448a7ca18024457c8107a9dc05a8077cd2171f2e
parent69204d5a8ad8c3ea8f99880fdfb634b6109a59fb (diff)
downloademacs-eb62887e97a3be6f4fc8769479a30827163ea775.tar.gz
lisp/dired.el (dired-delete-file): Doc fix. (Bug#20021)
-rw-r--r--lisp/ChangeLog4
-rw-r--r--lisp/dired.el15
2 files changed, 14 insertions, 5 deletions
diff --git a/lisp/ChangeLog b/lisp/ChangeLog
index a1cf2a07dbe..0e4e463e200 100644
--- a/lisp/ChangeLog
+++ b/lisp/ChangeLog
@@ -1,3 +1,7 @@
+2015-03-07 Eli Zaretskii <eliz@gnu.org>
+
+ * dired.el (dired-delete-file): Doc fix. (Bug#20021)
+
2015-03-03 Agustín Martín Domingo <agustin6martin@gmail.com>
* textmodes/ispell.el (ispell-aspell-find-dictionary): Make sure
diff --git a/lisp/dired.el b/lisp/dired.el
index 211f9242e80..1d5a75a2202 100644
--- a/lisp/dired.el
+++ b/lisp/dired.el
@@ -2850,11 +2850,16 @@ Any other value means to ask for each directory."
;; to e.g. recursive-delete-file and put it somewhere else.
(defun dired-delete-file (file &optional recursive trash) "\
Delete FILE or directory (possibly recursively if optional RECURSIVE is true.)
-RECURSIVE determines what to do with a non-empty directory. If RECURSIVE is:
-nil, do not delete.
-`always', delete recursively without asking.
-`top', ask for each directory at top level.
-Anything else, ask for each sub-directory."
+RECURSIVE determines what to do with a non-empty directory. The effect of
+its possible values is:
+
+ nil -- do not delete.
+ `always' -- delete recursively without asking.
+ `top' -- ask for each directory at top level.
+ Anything else -- ask for each sub-directory.
+
+TRASH non-nil means to trash the file instead of deleting, provided
+`delete-by-moving-to-trash' (which see) is non-nil."
;; This test is equivalent to
;; (and (file-directory-p fn) (not (file-symlink-p fn)))
;; but more efficient