emacs-elpa-diffs
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[elpa] externals/dired-duplicates 383fda8403 45/57: Update README.org af


From: ELPA Syncer
Subject: [elpa] externals/dired-duplicates 383fda8403 45/57: Update README.org after latest changes
Date: Sat, 4 Nov 2023 06:58:30 -0400 (EDT)

branch: externals/dired-duplicates
commit 383fda8403329759fcaab17b395ceba6922ac7fb
Author: Harald Judt <h.judt@gmx.at>
Commit: Harald Judt <h.judt@gmx.at>

    Update README.org after latest changes
---
 README.org | 26 +++++++++++++++++++-------
 1 file changed, 19 insertions(+), 7 deletions(-)

diff --git a/README.org b/README.org
index c5ddf4b40f..1f1abd9d4e 100644
--- a/README.org
+++ b/README.org
@@ -11,23 +11,22 @@ dired-duplicates works by first searching files of the same 
size, then invoking
 the calculation of the checksum for these files, and finally presenting the
 grouped results in a Dired buffer that the user can work with similarly to a
 regular Dired buffer.  It might be even possible to combine this with other
-Dired extension packages, like =dired-narrow=.
+Dired extension packages like =dired-narrow= for increased productivity.
 
-The results will be grouped visually by using a temporary file serving as a
-separator - the author has not yet found any way of making dired add an empty
-line or similar to achieve some sort of separation, but this grouping with a
-temporary file can also be deactivated.
+By default, the results will be grouped visually by separating them using empty
+lines, but this grouping can also be deactivated by setting the custom variable
+=dired-duplicates-separate-result= to =nil=.
 
 * Requirements
 For performance reasons, a checksum program like =md5= or =sha256sum= will be
 used for generating checksums of file contents and therefore needs to be
 available and executable on the local and/or remote hosts.  That way, no files
-need to be read over possibly slow networks and calculating the checksum will
+need to be read over possibly slow networks, thus calculating the checksum will
 be much faster when directly executed on remote hosts.  The name of the
 checksum program can be customized.
 
 * Installation
-The package can be installed via the Emacs package manager,
+The package can be installed from MELPA via the Emacs package manager,
 e.g. ~package-install~.  Or you use the following use-package snippet:
 #+BEGIN_SRC emacs-lisp
 (use-package dired-duplicates)
@@ -42,6 +41,19 @@ You can find all available customization options with 
~customize-group~,
 entering =dired-duplicates= for the desired group.  These options are described
 extensively there.
 
+* Known issues and reporting bugs
+** Known issue with completing-multiple-read
+At the moment, there is a problem in Emacs 28.1 and perhaps other versions with
+~completing-read-multiple~ that makes auto-completion fail.  When you try to
+specify more than one directory separated by commas (e.g. =/tmp/1,/tmp/2=), an
+error /may/ occur depending on the completing system.  In such a case, you
+might just do without auto-completion and ignore that error, dired-duplicates
+will still function properly if you provide valid directories.
+
+** Reporting bugs
+Just open an issue at the homepage of this project in case you hit an error,
+and provide proper steps to reproduce the problem.
+
 * License
 This package is licensed under GPL-3.  See the =LICENSE= file for more
 information.



reply via email to

[Prev in Thread] Current Thread [Next in Thread]