branch: elpa/flycheck
commit 4d29dabf88d6a2dac160c1dd9c81a132617caf5a
Author: Bozhidar Batsov <[email protected]>
Commit: Bozhidar Batsov <[email protected]>
Document previously undocumented 36.0 features
- Update mode-line table to show new errors|warnings|infos format
- Document flycheck-error-list-after-jump-hook in error list page
- Document auto re-check after revert-buffer
---
doc/user/error-list.rst | 13 ++++++++++++
doc/user/error-reports.rst | 52 ++++++++++++++++++++++++----------------------
doc/user/syntax-checks.rst | 1 +
3 files changed, 41 insertions(+), 25 deletions(-)
diff --git a/doc/user/error-list.rst b/doc/user/error-list.rst
index d6232dc674..2c6eff9e15 100644
--- a/doc/user/error-list.rst
+++ b/doc/user/error-list.rst
@@ -39,6 +39,19 @@ Within the error list the following key bindings are
available:
:kbd:`q` Quit the error list and hide its window
========== ====
+When you jump to an error from the error list with :kbd:`RET`, Flycheck runs
+`flycheck-error-list-after-jump-hook` in the source buffer. This is useful for
+post-jump actions like recentering:
+
+.. defcustom:: flycheck-error-list-after-jump-hook
+
+ Functions to run after jumping to an error from the error list. For
+ example, to recenter the window on the error location:
+
+ .. code-block:: elisp
+
+ (add-hook 'flycheck-error-list-after-jump-hook #'recenter)
+
Filter the list
===============
diff --git a/doc/user/error-reports.rst b/doc/user/error-reports.rst
index cb3a5826ad..ccd588186b 100644
--- a/doc/user/error-reports.rst
+++ b/doc/user/error-reports.rst
@@ -240,31 +240,33 @@ Like all minor modes Flycheck also has a mode line
indicator. You can see it in
the bottom right corner of the above screenshot. By default the indicator
shows
Flycheck’s current state via one of the following texts:
-+-------------+----------------------------------------------------------------+
-|``FlyC`` |Current buffer has not been checked.
|
-+-------------+----------------------------------------------------------------+
-|``FlyC*`` |Flycheck is checking the buffer currently.
|
-+-------------+----------------------------------------------------------------+
-|``FlyC:0`` |Last check resulted in no errors and no warnings.
|
-+-------------+----------------------------------------------------------------+
-|``FlyC:3/5`` |There are three errors and five warnings in the current buffer.
|
-+-------------+----------------------------------------------------------------+
-|``FlyC-`` |Flycheck did not find a syntax checker for the current buffer.
|
-| |Take a look at the :ref:`list of supported languages
|
-| |<flycheck-languages>` and type `C-c ! v` to see what checkers
|
-| |are available for the current buffer.
|
-+-------------+----------------------------------------------------------------+
-|``FlyC!`` |The last syntax check failed. Inspect the ``*Messages*``
buffer,|
-| |look for error messages, and consider :ref:`reporting a bug
|
-| |<flycheck-bug-reports>`.
|
-+-------------+----------------------------------------------------------------+
-|``FlyC.`` |The last syntax check was manually interrupted.
|
-+-------------+----------------------------------------------------------------+
-|``FlyC?`` |The last syntax check had a dubious result. The definition of
a|
-| |syntax checker may have a bug. Inspect the ``*Messages*``
|
-| |buffer and consider :ref:`reporting a bug
|
-| |<flycheck-bug-reports>`.
|
-+-------------+----------------------------------------------------------------+
++------------------+-------------------------------------------------------------+
+|``FlyC`` |Current buffer has not been checked.
|
++------------------+-------------------------------------------------------------+
+|``FlyC*`` |Flycheck is checking the buffer currently.
|
++------------------+-------------------------------------------------------------+
+|``FlyC:0`` |Last check resulted in no errors, no warnings and no info
|
+| |messages.
|
++------------------+-------------------------------------------------------------+
+|``FlyC:3|5|1`` |There are three errors, five warnings and one info message
in|
+| |the current buffer.
|
++------------------+-------------------------------------------------------------+
+|``FlyC-`` |Flycheck did not find a syntax checker for the current
|
+| |buffer. Take a look at the :ref:`list of supported
languages|
+| |<flycheck-languages>` and type `C-c ! v` to see what
checkers|
+| |are available for the current buffer.
|
++------------------+-------------------------------------------------------------+
+|``FlyC!`` |The last syntax check failed. Inspect the ``*Messages*``
|
+| |buffer, look for error messages, and consider
|
+| |:ref:`reporting a bug <flycheck-bug-reports>`.
|
++------------------+-------------------------------------------------------------+
+|``FlyC.`` |The last syntax check was manually interrupted.
|
++------------------+-------------------------------------------------------------+
+|``FlyC?`` |The last syntax check had a dubious result. The
definition |
+| |of a syntax checker may have a bug. Inspect the
|
+| |``*Messages*`` buffer and consider :ref:`reporting a bug
|
+| |<flycheck-bug-reports>`.
|
++------------------+-------------------------------------------------------------+
You can entirely customise the mode line indicator with `flycheck-mode-line`:
diff --git a/doc/user/syntax-checks.rst b/doc/user/syntax-checks.rst
index c443b8329b..f63b8f56ff 100644
--- a/doc/user/syntax-checks.rst
+++ b/doc/user/syntax-checks.rst
@@ -76,6 +76,7 @@ By default :mode:`flycheck` automatically checks a buffer
whenever
* it is enabled,
* the buffer is saved,
+* the buffer is reverted (e.g. via ``global-auto-revert-mode``),
* a new line is inserted,
* or a short time after the last change was made in a buffer.
