[Emacs-diffs] /srv/bzr/emacs/trunk r106857: find-ls-option doc fixes (bug#10262)

[Glenn Morris]

------------------------------------------------------------
revno: 106857
committer: Glenn Morris <address@hidden>
branch nick: trunk
timestamp: Thu 2012-01-12 21:32:07 -0500
message:
  find-ls-option doc fixes (bug#10262)
  
  * doc/emacs/dired.texi (Dired and Find): Clarify find-ls-options.
  * lisp/find-dired.el (find-ls-option): Doc fix.
modified:
  doc/emacs/ChangeLog
  doc/emacs/dired.texi
  lisp/ChangeLog
  lisp/find-dired.el

=== modified file 'doc/emacs/ChangeLog'
--- a/doc/emacs/ChangeLog       2012-01-09 07:48:51 +0000
+++ b/doc/emacs/ChangeLog       2012-01-13 02:32:07 +0000
@@ -1,3 +1,7 @@
+2012-01-13  Glenn Morris  <address@hidden>
+
+       * dired.texi (Dired and Find): Clarify find-ls-options.
+
 2012-01-09  Chong Yidong  <address@hidden>
 
        * custom.texi (Custom Themes): Switched custom-safe-themes to use

=== modified file 'doc/emacs/dired.texi'
--- a/doc/emacs/dired.texi      2012-01-05 09:46:05 +0000
+++ b/doc/emacs/dired.texi      2012-01-13 02:32:07 +0000
@@ -1228,9 +1228,9 @@
 
 @vindex find-ls-option
   The format of listing produced by these commands is controlled by
-the variable @code{find-ls-option}, whose default value specifies
-using options @samp{-ld} for @command{ls}.  If your listings are
-corrupted, you may need to change the value of this variable.
+the variable @code{find-ls-option}.  This is a pair of options; the
+first specifying how to call @command{find} to produce the file listing,
+and the second telling Dired to parse the output.
 
 @findex locate
 @findex locate-with-filter

=== modified file 'lisp/ChangeLog'
--- a/lisp/ChangeLog    2012-01-12 02:05:15 +0000
+++ b/lisp/ChangeLog    2012-01-13 02:32:07 +0000
@@ -1,3 +1,7 @@
+2012-01-13  Glenn Morris  <address@hidden>
+
+       * find-dired.el (find-ls-option): Doc fix.  (Bug#10262)
+
 2012-01-12  Glenn Morris  <address@hidden>
 
        * mail/sendmail.el (mail-mode): Update paragraph-separate for

=== modified file 'lisp/find-dired.el'
--- a/lisp/find-dired.el        2012-01-05 09:46:05 +0000
+++ b/lisp/find-dired.el        2012-01-13 02:32:07 +0000
@@ -63,10 +63,20 @@
     (cons
      (format "-exec ls -ld {} %s" find-exec-terminator)
      "-ld"))
-  "Description of the option to `find' to produce an `ls -l'-type listing.
-This is a cons of two strings (FIND-OPTION . LS-SWITCHES).  FIND-OPTION
-gives the option (or options) to `find' that produce the desired output.
-LS-SWITCHES is a list of `ls' switches to tell dired how to parse the output."
+  "A pair of options to produce and parse an `ls -l'-type list from `find'.
+This is a cons of two strings (FIND-OPTION . LS-SWITCHES).
+FIND-OPTION is the option (or options) passed to `find' to produce
+a file listing in the desired format.  LS-SWITCHES is a set of
+`ls' switches that tell dired how to parse the output of `find'.
+
+The two options must be set to compatible values.
+For example, to use human-readable file sizes with GNU ls:
+   \(\"-exec ls -ldh {} +\" . \"-ldh\")
+
+To use GNU find's inbuilt \"-ls\" option to list files:
+   \(\"-ls\" . \"-dilsb\")
+since GNU find's output has the same format as using GNU ls with
+the options \"-dilsb\"."
   :version "24.1"             ; add tests for -ls and -exec + support
   :type '(cons (string :tag "Find Option")
               (string :tag "Ls Switches"))