]> git.eshelyaron.com Git - emacs.git/commitdiff
Improve discoverability of 'insert-directory-program'
authorEli Zaretskii <eliz@gnu.org>
Fri, 15 Apr 2022 20:03:15 +0000 (23:03 +0300)
committerEli Zaretskii <eliz@gnu.org>
Fri, 15 Apr 2022 20:03:15 +0000 (23:03 +0300)
* lisp/files.el (insert-directory-program): Mention 'dired' in the
doc string.
* lisp/dired.el (dired): Mention 'insert-directory-program' in the
doc string.  (Bug#54962)

lisp/dired.el
lisp/files.el

index a3768d224b4c832e0b6b9cffa98e15c85a2a00b0..f5ddd7aa39fe4b3a43244ba936eb7587cdf2167e 100644 (file)
@@ -994,8 +994,11 @@ If a directory or nothing is found at point, return nil."
 ;;;###autoload
 (defun dired (dirname &optional switches)
   "\"Edit\" directory DIRNAME--delete, rename, print, etc. some files in it.
-Optional second argument SWITCHES specifies the `ls' options used.
-\(Interactively, use a prefix argument to be able to specify SWITCHES.)
+Optional second argument SWITCHES specifies the options to be used
+when invoking `insert-directory-program', usually `ls', which produces
+the listing of the directory files and their attributes.
+Interactively, a prefix argument will cause the command to prompt
+for SWITCHES.
 
 If DIRNAME is a string, Dired displays a list of files in DIRNAME (which
 may also have shell wildcards appended to select certain files).
index 5fa38e46af0e4dab6c778f6a4d7187e015b9bb87..d8e7989672ad17209cd114ff28cbb17e07812b83 100644 (file)
@@ -7236,7 +7236,9 @@ need to be passed verbatim to shell commands."
 
 
 (defvar insert-directory-program (purecopy "ls")
-  "Absolute or relative name of the `ls' program used by `insert-directory'.")
+  "Absolute or relative name of the `ls'-like program.
+This is used by `insert-directory' and `dired-insert-directory'
+\(thus, also by `dired').")
 
 (defcustom directory-free-space-program (purecopy "df")
   "Program to get the amount of free space on a file system.