mirror of
git://git.sv.gnu.org/emacs.git
synced 2025-12-05 22:20:24 -08:00
; Update doc strings of Dired functions due to 'marked' value of ARG
* lisp/dired-aux.el (dired-do-compress, dired-do-byte-compile) (dired-do-load, dired-do-redisplay): * lisp/dired.el (dired-map-over-marks, dired-get-marked-files) (dired-mouse-drag, dired-do-delete): Doc fixes (bug#79042).
This commit is contained in:
parent
a05be41af7
commit
e675d5ba64
2 changed files with 39 additions and 23 deletions
|
|
@ -1921,7 +1921,10 @@ 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."
|
||||
uncompress and unpack all the files in the archive.
|
||||
|
||||
When called from Lisp, if ARG is the symbol `marked', compress
|
||||
only the marked files, or none if no files are marked."
|
||||
(interactive "P" dired-mode)
|
||||
(dired-map-over-marks-check #'dired-compress arg 'compress t))
|
||||
|
||||
|
|
@ -1950,7 +1953,10 @@ uncompress and unpack all the files in the archive."
|
|||
|
||||
;;;###autoload
|
||||
(defun dired-do-byte-compile (&optional arg)
|
||||
"Byte compile marked (or next ARG) Emacs Lisp files."
|
||||
"Byte compile marked (or next ARG) Emacs Lisp files.
|
||||
|
||||
When called from Lisp, if ARG is the symbol `marked', byte-compile
|
||||
only the marked files, or none if no files are marked."
|
||||
(interactive "P" dired-mode)
|
||||
(dired-map-over-marks-check #'dired-byte-compile arg 'byte-compile t))
|
||||
|
||||
|
|
@ -1967,7 +1973,10 @@ uncompress and unpack all the files in the archive."
|
|||
|
||||
;;;###autoload
|
||||
(defun dired-do-load (&optional arg)
|
||||
"Load the marked (or next ARG) Emacs Lisp files."
|
||||
"Load the marked (or next ARG) Emacs Lisp files.
|
||||
|
||||
When called from Lisp, if ARG is the symbol `marked', load
|
||||
only the marked files, or none if no files are marked."
|
||||
(interactive "P" dired-mode)
|
||||
(dired-map-over-marks-check #'dired-load arg 'load t))
|
||||
|
||||
|
|
@ -1983,7 +1992,10 @@ or delete subdirectories can bypass this machinery. Hence, you sometimes
|
|||
may have to reset some subdirectory switches after a `dired-undo'.
|
||||
You can reset all subdirectory switches to the default using
|
||||
\\<dired-mode-map>\\[dired-reset-subdir-switches].
|
||||
See Info node `(emacs)Subdir switches' for more details."
|
||||
See Info node `(emacs)Subdir switches' for more details.
|
||||
|
||||
When called from Lisp, if ARG is the symbol `marked', redisplay
|
||||
only the marked files, or none if no files are marked."
|
||||
;; Moves point if the next ARG files are redisplayed.
|
||||
(interactive "P\np" dired-mode)
|
||||
(if (and test-for-subdir (dired-get-subdir))
|
||||
|
|
|
|||
|
|
@ -931,19 +931,18 @@ Return value is the number of files marked, or nil if none were marked."
|
|||
(defmacro dired-map-over-marks (body arg &optional show-progress
|
||||
distinguish-one-marked)
|
||||
"Eval BODY with point on each marked line. Return a list of BODY's results.
|
||||
If no marked file could be found, execute BODY on the current
|
||||
line. ARG, if non-nil, specifies the files to use instead of the
|
||||
If no marked file could be found and ARG is nil, execute BODY on the current
|
||||
line. If ARG is non-nil, it specifies the files to use instead of the
|
||||
marked files.
|
||||
|
||||
If ARG is an integer, use the next ARG (or previous -ARG, if
|
||||
ARG<0) files. In that case, point is dragged along. This is so
|
||||
that commands on the next ARG (instead of the marked) files can
|
||||
be chained easily.
|
||||
If ARG is an integer, use the next ARG (or previous -ARG, if ARG<0)
|
||||
files. In that case, point is dragged along. This is so that
|
||||
commands on the next ARG (instead of the marked) files can be
|
||||
chained easily.
|
||||
If ARG is the symbol `marked', use only marked files; if none are
|
||||
marked, don't eval BODY and return nil.
|
||||
For any other non-nil value of ARG, use the current file.
|
||||
|
||||
If ARG is `marked', don't return the current file if nothing else
|
||||
is marked.
|
||||
|
||||
If optional third arg SHOW-PROGRESS evaluates to non-nil,
|
||||
redisplay the Dired buffer after each file is processed.
|
||||
|
||||
|
|
@ -951,14 +950,16 @@ No guarantee is made about the position on the marked line.
|
|||
BODY must ensure this itself if it depends on this.
|
||||
|
||||
Search starts at the beginning of the buffer, thus the car of the
|
||||
list corresponds to the line nearest to the buffer's bottom.
|
||||
returnede list corresponds to the line nearest to the buffer's bottom.
|
||||
This is also true for (positive and negative) integer values of
|
||||
ARG.
|
||||
|
||||
BODY should not be too long as it is expanded four times.
|
||||
|
||||
If DISTINGUISH-ONE-MARKED is non-nil, then if we find just one
|
||||
marked file, return (t FILENAME) instead of (FILENAME)."
|
||||
marked file, return (t BODY-RESULT) instead of (BODY-RESULT),
|
||||
where BODY-RESULT is the result of evaluating BODY with point
|
||||
on the single marked file's line."
|
||||
;;
|
||||
;;Warning: BODY must not add new lines before point - this may cause an
|
||||
;;endless loop.
|
||||
|
|
@ -1009,14 +1010,17 @@ marked file, return (t FILENAME) instead of (FILENAME)."
|
|||
|
||||
(defun dired-get-marked-files (&optional localp arg filter distinguish-one-marked error)
|
||||
"Return the marked files' names as list of strings.
|
||||
The list is in the same order as the buffer, that is, the car is the
|
||||
first marked file.
|
||||
The list is in the same order as the Dired buffer text, that is, the car
|
||||
is the first marked file.
|
||||
Values returned are normally absolute file names.
|
||||
Optional arg LOCALP as in `dired-get-filename'.
|
||||
Optional arg LOCALP is as in `dired-get-filename'.
|
||||
Optional second argument ARG, if non-nil, specifies files near
|
||||
point instead of marked files. It usually comes from the prefix
|
||||
argument.
|
||||
If ARG is an integer, use the next ARG files.
|
||||
point to return instead of marked files. It usually comes from the
|
||||
prefix argument of the caller.
|
||||
If ARG is an integer, return the next ARG files (previous if ARG is
|
||||
negative).
|
||||
If ARG is the symbol `marked', return only marked files; return nil
|
||||
if none are marked
|
||||
If ARG is any other non-nil value, return the current file name.
|
||||
If no files are marked, and ARG is nil, also return the current file name.
|
||||
Optional third argument FILTER, if non-nil, is a function to select
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue