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)
This commit is contained in:
Eli Zaretskii 2018-11-22 21:05:14 +02:00
parent 9c09b1d231
commit 477414ac38

View file

@ -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))