update documentation

NEWS.org

@@ -36,6 +36,13 @@
 
 *** mu4e
 
+    - ~mu4e~ no longer uses the ~mu4e-maildir~ and ~mu4e-user-mail-address-list~
+      variables; instead it uses the information it gets from ~mu~ (see the ~mu~
+      section above).
+
+      It is strongly recommended that you run ~mu init~ with the appropriate
+      parameters to (re)initialize the Xapian database.
+
     - In many cases, ~mu4e~ used to receive /all/ contacts after each indexing
       operation; this was slow for some users, so we have updated this to /only/
       get the contacts that have changed since the last round.
@@ -46,15 +53,11 @@
       of those should migrate to ~mu4e-contact-process-function~; see its
       docstring for details.
 
-    - ~mu4e~ no longer uses the ~mu4e-maildir~ and ~mu4e-user-mail-address-list~
-      variables; instead it uses the information it gets from ~mu~ (see the ~mu~
-      section above).
-
     - Christophe Troestler contributed support for Gnus' calender-invitation
       handling in mu4e (i.e., you should be able to accept/reject invitations
       etc.). It's very fresh code, and likely it'll be tweaked in the future.
       But it's available now for testing. Note that this requires the gnus-based
-      viewer, ie ~(setq mu4e-view-use-gnus t)~
+      viewer, as per ~(setq mu4e-view-use-gnus t)~
 
     - In addition, he added support for custom headers, so the ones for for the
       non-gnus-view should work just as well.
@@ -66,7 +69,7 @@
     - ~org-mode~ support is enabled by default now. ~speedbar~ support is disabled
       by default.
 
-    - ~mu4e~ now adds message-id's to messages when saving drafts, so we can find
+    - ~mu4e~ now adds message-ids to messages when saving drafts, so we can find
       them even with ~mu4e-headers-skip-duplicates~.
 
     - Bookmarks (as in ~mu4e-bookmarks~) are now simple plists (instead of cl

man/mu-index.1

@@ -27,7 +27,7 @@ E-mail messages which are not stored in something resembling a maildir
 leaf-directory (\fIcur\fR and \fInew\fR) are ignored, as are the cache
 directories for \fInotmuch\fR and \fIgnus\fR, and any dot-directory.
 
-Symlinks are not followed.
+The maildir must be on a single file-system; symlinks are not followed.
 
 If there is a file called \fI.noindex\fR in a directory, the contents of that
 directory and all of its subdirectories will be ignored. This can be useful to

man/mu-init.1

@@ -29,7 +29,8 @@ this defaults to \fI~/.cache/mu\fR, \fI~/.config/mu\fR). Earlier versions of
 \fB\-m\fR, \fB\-\-maildir\fR=\fI<maildir>\fR
 starts searching at \fI<maildir>\fR. By default, \fBmu\fR uses whatever the
 \fBMAILDIR\fR environment variable is set to; if it is not set, it tries
-\fI~/Maildir\fR.
+\fI~/Maildir\fR. The maildir must be on a single file-system; and symbolic links
+are not supported.
 
 .TP
 \fB\-\-my-address\fR=\fI<my-email-address>\fR

mu4e/mu4e-vars.el

@@ -1002,11 +1002,8 @@ mu4e-compose.")
     path))
 
 (defun mu4e-personal-addresses()
-  "Get the user's personal addresses, if any. If none are set on the server-side,
-fall back to the obsolete `mu4e-user-mail-address-list'."
-  (let ((addrs (and mu4e~server-props
-                    (plist-get mu4e~server-props :personal-addresses))))
-    (if addrs addrs mu4e-user-mail-address-list)))
+  "Get the user's personal addresses, if any."
+  (when mu4e~server-props (plist-get mu4e~server-props :personal-addresses)))
 
 (defun mu4e-server-version()
   "Get the server version, which should match mu4e's."

mu4e/mu4e.texi

@@ -394,9 +394,10 @@ have your e-mail messages stored in a
 @emph{maildir}@footnote{@url{https://en.wikipedia.org/wiki/Maildir};
 in this manual we use the term `maildir' for both the standard and the
 hierarchy of maildirs that store your messages} --- a specific
-directory structure with one-file-per-message. If you are already
-using a maildir, you are lucky. If not, some setup is required:
+directory structure with one-file-per-message.
 
+If you are already using a maildir, you are lucky. If not, some setup
+is required:
 @itemize
 @item @emph{Using an external IMAP or POP server} --- if you are using an
 @abbr{IMAP} or @abbr{POP} server, you can use tools like @t{getmail},
@@ -410,6 +411,9 @@ a maildir as well, maybe in combination with @t{procmail}. A bit of
 googling should be able to provide you with the details.
 @end itemize
 
+The maildir must be on a single file-system; and symbolic links are
+not supported.
+
 @node Initializing the message store
 @section Initializing the message store