mu4e-vars: Update docs for mu4e-index-lazy-check

Explicitly mention the limitation with sub-dirs, as discussed in issue
This commit is contained in:
Dirk-Jan C. Binnema 2021-08-07 17:18:15 +03:00
parent e52683f0ed
commit 6a4eb68428
1 changed files with 10 additions and 4 deletions

View File

@ -129,10 +129,16 @@ shown but can slow with large message stores on slow file-systems."
(defcustom mu4e-index-lazy-check nil
"Whether to only use a 'lazy check' during reindexing.
This influences how we decide whether a message
needs (re)indexing or not. When this is set to t, mu only uses
the directory timestamps to decide whether it needs to check the
messages beneath it, which would miss messages that are modified
outside mu. On the other hand, it's significantly faster."
needs (re)indexing or not.
When this is set to non-nil, mu only uses the directory
timestamps to decide whether it needs to check the messages
beneath it. This makes indexing much faster, but has some
limitations: since directory timestamp changes do not traverse
upwards and therefore this does not see changes in
sub-directories: a change in 'bar' in 'Maildir/foo/bar/...' is
not detected, only a change in 'foo'. In that case, this option
should not be set."
:type 'boolean
:group 'mu4e
:safe 'booleanp)