[elpa] master c9dea38 363/433: Update the FAQ

[Dmitry Gutov]

branch: master
commit c9dea386e3c654db5745cd93bb26d7c81abbf282
Author: Dmitry Gutov <address@hidden>
Commit: Dmitry Gutov <address@hidden>

    Update the FAQ
---
 FAQ | 65 ++++++++++++++++++++++++++++++++++++++---------------------------
 1 file changed, 38 insertions(+), 27 deletions(-)

diff --git a/FAQ b/FAQ
index 20cb8e0..6bdd9c2 100644
--- a/FAQ
+++ b/FAQ
@@ -45,6 +45,10 @@ the need to type the delimiters as well as the need to 
reparse the
 block: type `C-c % h' for a list of available insertion commands for
 current submode class(es).
 
+With a recent update, you can set `mmm-parse-when-idle' to t, to allow
+MMM Mode to reparse the buffer when it's modified and Emacs is idle.
+This comes at a certain performance cost.
+
 
 * Why is the first character of the end delimiter in the submode region?
 
@@ -72,8 +76,7 @@ up, that MMM Mode doesn't yet know about.  Often this sort of 
problem
 can be fixed by adding elements to `mmm-save-local-variables'.  If you
 know some Elisp, you may want to try and track down the problem
 yourself, or you can contact the mailing list and ask for help.
-Either way, please contact the maintainer or the mailing list when
-(if) you find something that works, so that in the future, folks can
+Either way, please file an issue, so that in the future, folks can
 use MMM Mode and foo-mode together more easily.
 
 
@@ -93,28 +96,33 @@ your init code, try manually evaluating it line by line 
(`C-x C-e') to
 see where the error occurs.  Folks on the mailing list can also help
 point out errors, but only with your init code and a backtrace.
 
+If you're having a problem with syntax highlighting, debugging is
+complicated by the fact that font-lock swallows errors. To trigger the
+error, evaluate the following in the problem buffer (with `M-:'):
+
+  (font-lock-fontify-region (point-min) (point-max))
+
 (1) To get a stack backtrace of an error, set the emacs variable
-    `debug-on-error' to non-nil (type `M-x set-variable RET
-    debug-on-error RET t RET' or `M-: (setq debug-on-error t) RET'),
-    then repeat the actions which caused the error.  A stack backtrace
-    should pop up which you can select and copy.  If the error occurs
-    while loading emacs, invoke emacs with the `--debug-init' (Emacs)
-    or `-debug-init' (XEmacs) switch.
+    `debug-on-error' to non-nil (type `M-x toggle-debug-on-error RET' or
+    `M-: (setq debug-on-error t) RET'), then repeat the actions which
+    caused the error. A stack backtrace should pop up which you can
+    select and copy. If the error occurs while loading emacs, invoke
+    emacs with the `--debug-init' (Emacs) or `-debug-init' (XEmacs)
+    switch.
 
 
-* Will MMM Mode work with (Emacs 19 / XEmacs 20 / XEmacs 21 / etc...)?
+* Will MMM Mode work with (Emacs 23 / XEmacs 20 / XEmacs 21 / etc...)?
 
-MMM Mode was designed for FSF Emacs 20 and 21 and works best there.
+MMM Mode was designed for FSF Emacs and works best in versions 23 and 24.
 But don't let that stop you from trying it under other variants of
 emacs.  If you encounter problems, feel free to ask the mailing list,
 but success is not guaranteed.
 
-For example, the font-lock support in XEmacs 20 is known to be broken
-and well-nigh unfixable; consider upgrading.  XEmacs 21 also has
-problems with font-lock: for example, often apostrophes in a different
-submode region can cause code to be incorrectly font-locked as a
-string.  I have given up trying to support Emacs 19; you should
-upgrade to Emacs 20 or 21.
+XEmacs 21 has problems with font-lock: for example, often apostrophes in
+a different submode region can cause code to be incorrectly font-locked
+as a string.
+
+Versions of FSF Emacs < 23 and XEmacs < 21 are not supported.
 
 
 * XEmacs says `Symbol's function definition is void: make-indirect-buffer'.
@@ -135,12 +143,12 @@ error message this problem produces may change with newer 
versions of
 MMM Mode; always be sure you have compiled for the correct emacsen.
 
 
-* I want to install the CVS version, but there's no `configure' script.
+* I want to install the Git version, but there's no `configure' script.
 
 The `configure' script which is included in the official distributions
-is not present in CVS, because it is automatically generated by GNU
+is not present in Git, because it is automatically generated by GNU
 Automake/Autoconf from files like `Makefile.am' and `configure.in'.
-To build the CVS version the same way as the official distributions,
+To build the Git version the same way as the official distributions,
 you must first run `autogen.sh':
 
 $ cd mmm-mode
@@ -155,27 +163,30 @@ $ make install
 Note that autogen.sh requires aclocal, automake, and autoconf, which
 may or may not be installed on your system, since they are considered
 developer tools rather than end-user tools.  If you can't or don't
-want to install them, however, you can still use the CVS version of
+want to install them, however, you can still use the Git version of
 MMM Mode by manually copying all the `.el' files into a directory in
 your `load-path'.  Optionally, you may also byte-compile them manually
 (this is what `make' normally does).  Byte-compiling gives some speed
 improvement, but if you experience problems, the stack traces are
 sometimes more informative if you are using the source files only.
 
-The Info files `mmm.info-*' are also not included in CVS, since they
+The Info files `mmm.info-*' are also not included in Git, since they
 are generated from `mmm.texinfo' by the program `makeinfo'.  If you
-want to install the Info documentation from CVS, you will have to run
+want to install the Info documentation from Git, you will have to run
 this manually as well, and copy the resulting info files into the
 appropriate location for your system.
 
-The CVS version is, of course, even less guaranteed to be bug-free
+The Git version is, of course, even less guaranteed to be bug-free
 than the official distributions.  But please report any problems you
 have with it, so they can be fixed for the next release.
 
 
 * You haven't answered my question; how can I get more help?
 
-At the MMM Mode web site, <http://mmm-mode.sourceforge.net>, there is
-a link to the subscription page for the MMM Mode mailing list.  When
-asking a question on the list, be sure to give the versions of emacs
-and MMM Mode you are using, and any other relevant information.
+Create an issue at <https://github.com/purcell/mmm-mode/issues>, or
+check out the MMM Mode web site, <http://mmm-mode.sourceforge.net>,
+there is a link to the subscription page for the MMM Mode mailing list.
+
+When asking a question or reporting a problem, be sure to give the
+versions of emacs and MMM Mode you are using, and any other relevant
+information.