diff options
author | Eli Zaretskii <eliz@gnu.org> | 2015-03-07 11:55:58 +0200 |
---|---|---|
committer | Eli Zaretskii <eliz@gnu.org> | 2015-03-07 11:55:58 +0200 |
commit | eb62887e97a3be6f4fc8769479a30827163ea775 (patch) | |
tree | 448a7ca18024457c8107a9dc05a8077cd2171f2e /lisp/dired.el | |
parent | 69204d5a8ad8c3ea8f99880fdfb634b6109a59fb (diff) | |
download | emacs-eb62887e97a3be6f4fc8769479a30827163ea775.tar.gz |
lisp/dired.el (dired-delete-file): Doc fix. (Bug#20021)
Diffstat (limited to 'lisp/dired.el')
-rw-r--r-- | lisp/dired.el | 15 |
1 files changed, 10 insertions, 5 deletions
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 |