Re: New Flymake rewrite in emacs-26

[joaotavora@gmail.com (João Távora)]

Eli Zaretskii <eliz@gnu.org> writes:

> We should add some minimal documentation about the new features.

I added this to doc/misc/flymake.texi. It needs proofreading, but
otherwise I consider it a fairly complete description of the new API.

Importantly, a complete annotated example of a working Flymake backend
is presented. This can be a model for future backends.

> This should be in NEWS, perhaps after adjusting the style a bit.

I'm not great at summarizing changes in a NEWS-snazzy manner, but a
patch is attached.  Apart from that, I see these loose ends:

* Are we keeping track of the Flymake backends developed by people?
  Thus far, I think I counted backends for python, ruby, clang
  (minimal), gcc (minimal) and tex.  Am I missing any?

* Should Flymake do something with next-error-function?

* There is a "Flymake diagnostics buffer" sub-feature in
  scratch/flymake-diagnostics-buffer.  It is reasonably stable.  Is it
  OK to merge into emacs-26?

* Shouldn't flymake.texi be split into two parts, one for the Emacs
  manual and another for Emacs Lisp manual?

João

--- a/etc/NEWS
+++ b/etc/NEWS
@@ -1146,7 +1146,19 @@ languages.  (Version 2.1.0 or later of Enchant is required.)
 ** Flymake
 
 +++
-*** Emacs no longer prompts the user before killing Flymake processes on exit.
+*** Flymake has been completely redesigned
+
+Flymake now annotates arbitrary buffer regions, not just lines. It
+supports arbitrary diagnostic types, not not just errors and warnings
+(see variable 'flymake-diagnostic-types-alist').
+
+It also supports multiple simultaneous backends, meaning that you can
+check your buffer from different perspectives (see variable
+'flymake-diagnostic-functions'). Backends for Emacs-lisp mode are
+provided.
+
+The old Flymake behaviour is preserved in the so-called "legacy
+backend", which has been updated to benefit from new UI features.
 
 \f
 * New Modes and Packages in Emacs 26.1