summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJakob L. Kreuze <zerodaysfordays@sdf.lonestar.org>2019-05-25 14:38:00 -0400
committerJakob L. Kreuze <zerodaysfordays@sdf.lonestar.org>2019-05-25 14:38:00 -0400
commit69ee7669095b6e7bda04ab1108277f5c182600c9 (patch)
tree1ca6307906e115749ea3617a5da4008202da37c8
parentf45db7c2b3b6afbe0777858cad59a4a1bf4d9b42 (diff)
Document file scoping behavior
-rw-r--r--dired-rmjunk.el11
1 files changed, 10 insertions, 1 deletions
diff --git a/dired-rmjunk.el b/dired-rmjunk.el
index 96f9188..7a5773e 100644
--- a/dired-rmjunk.el
+++ b/dired-rmjunk.el
@@ -55,7 +55,16 @@
(defun dired-rmjunk ()
"Mark all junk files in the current dired buffer.
'Junk' is defined to be any file with a name matching one of the
-patterns in `dired-rmjunk-patterns'."
+patterns in `dired-rmjunk-patterns'. A pattern is said to match
+under the following conditions:
+
+ 1. If the pattern lacks a directory component, matching means
+ that the regexp specified by the pattern matches the file-name.
+ 2. If the pattern lacks a directory component, matching means
+ that that the regexp specified by the file-name component of
+ the pattern matches the file-name, AND the regexp specified by
+ the directory component of the pattern matches the current
+ directory."
(interactive)
(when (eq major-mode 'dired-mode)
(save-excursion