summaryrefslogtreecommitdiff
path: root/lisp/dired-aux.el
diff options
context:
space:
mode:
authorEli Zaretskii <eliz@gnu.org>2018-11-22 21:05:14 +0200
committerEli Zaretskii <eliz@gnu.org>2018-11-22 21:05:14 +0200
commit477414ac38399a63fd69f3b2457f5716a02b3eae (patch)
tree12cfd4892f5de2fe4be25d5fbae151ae592ee2f9 /lisp/dired-aux.el
parent9c09b1d23124cc3fc27deb476994b288e66bcad0 (diff)
downloademacs-477414ac38399a63fd69f3b2457f5716a02b3eae.tar.gz
Improve documentation of 'dired-do-compress'
* lisp/dired-aux.el (dired-do-compress): Describe in the doc string the effect on directories and on compressed archive. (Bug#33450)
Diffstat (limited to 'lisp/dired-aux.el')
-rw-r--r--lisp/dired-aux.el7
1 files changed, 6 insertions, 1 deletions
diff --git a/lisp/dired-aux.el b/lisp/dired-aux.el
index eaf5f257012..2800bbe9021 100644
--- a/lisp/dired-aux.el
+++ b/lisp/dired-aux.el
@@ -1225,7 +1225,12 @@ return t; if SYM is q or ESC, return nil."
;;;###autoload
(defun dired-do-compress (&optional arg)
- "Compress or uncompress marked (or next ARG) files."
+ "Compress or uncompress marked (or next ARG) files.
+If invoked on a directory, compress all of the files in
+the directory and all of its subdirectories, recursively,
+into a .tar.gz archive.
+If invoked on a .tar.gz or a .tgz or a .zip or a .7z archive,
+uncompress and unpack all the files in the archive."
(interactive "P")
(dired-map-over-marks-check #'dired-compress arg 'compress t))