summaryrefslogtreecommitdiff
path: root/lisp
diff options
context:
space:
mode:
authorJoão Távora <joaotavora@gmail.com>2017-10-12 12:11:26 +0100
committerJoão Távora <joaotavora@gmail.com>2017-10-12 12:30:23 +0100
commit413978727c9fb1d26b64e81412434064d99ec568 (patch)
tree6298d66eb95fe6af27f62985e710ca58bc814b9a /lisp
parent6ff18c3995af5d62c7c2d5690d6daf8984d842de (diff)
downloademacs-413978727c9fb1d26b64e81412434064d99ec568.tar.gz
emacs-413978727c9fb1d26b64e81412434064d99ec568.tar.bz2
emacs-413978727c9fb1d26b64e81412434064d99ec568.zip
Simplify Flymake user documentation
Fix some confusing parts of Flymake user documentation, like a repeated listing of situations leading to a syntax check. Documentation is now divided into three chapters only: "Using Flymake", "Extending Flymake", and a chapter for the legacy backend. Obsolete mention of "errors" and "lines" is replaced by "diagnostics/problems" and "regions" where appropriate. * doc/misc/flymake.texi (Overview of Flymake): Delete chapter. (Using Flymake): Merge with chapter "Overview of Flymake". (Installing Flymake): Delete chapter. (Flymake mode, Running the syntax check) (Navigating to error lines): Delete sections. (Syntax check statuses): Review and augment with x-references. (Backend exceptions): Mention shortcut in menu. * lisp/progmodes/flymake.el (flymake-menu): Tweak minor mode menu to not speak of "errors". (flymake-goto-next-error, flymake-goto-prev-error): Fix wording.
Diffstat (limited to 'lisp')
-rw-r--r--lisp/progmodes/flymake.el31
1 files changed, 16 insertions, 15 deletions
diff --git a/lisp/progmodes/flymake.el b/lisp/progmodes/flymake.el
index e4c6a38a77e..8c9c4b211a2 100644
--- a/lisp/progmodes/flymake.el
+++ b/lisp/progmodes/flymake.el
@@ -878,11 +878,11 @@ Do it only if `flymake-no-changes-timeout' is non-nil."
(flymake-log :warning "Turned on in `flymake-find-file-hook'")))
(defun flymake-goto-next-error (&optional n filter interactive)
- "Go to Nth next Flymake error in buffer matching FILTER.
-Interactively, always move to the next error. With a prefix arg,
-skip any diagnostics with a severity less than `:warning'.
+ "Go to Nth next Flymake diagnostic that matches FILTER.
+Interactively, always move to the next diagnostic. With a prefix
+arg, skip any diagnostics with a severity less than `:warning'.
-If `flymake-wrap-around' is non-nil and no more next errors,
+If `flymake-wrap-around' is non-nil and no more next diagnostics,
resumes search from top.
FILTER is a list of diagnostic types found in
@@ -933,12 +933,13 @@ applied."
""))))))
(defun flymake-goto-prev-error (&optional n filter interactive)
- "Go to Nth previous Flymake error in buffer matching FILTER.
-Interactively, always move to the previous error. With a prefix
-arg, skip any diagnostics with a severity less than `:warning'.
+ "Go to Nth previous Flymake diagnostic that matches FILTER.
+Interactively, always move to the previous diagnostic. With a
+prefix arg, skip any diagnostics with a severity less than
+`:warning'.
-If `flymake-wrap-around' is non-nil and no more previous errors,
-resumes search from bottom.
+If `flymake-wrap-around' is non-nil and no more previous
+diagnostics, resumes search from bottom.
FILTER is a list of diagnostic types found in
`flymake-diagnostic-types-alist', or nil, if no filter is to be
@@ -953,13 +954,13 @@ applied."
;;;
(easy-menu-define flymake-menu flymake-mode-map "Flymake"
`("Flymake"
- [ "Go to next error" flymake-goto-next-error t ]
- [ "Go to previous error" flymake-goto-prev-error t ]
- [ "Check now" flymake-start t ]
- [ "Go to log buffer" flymake-switch-to-log-buffer t ]
- [ "Show error buffer" flymake-show-diagnostics-buffer t ]
+ [ "Go to next problem" flymake-goto-next-error t ]
+ [ "Go to previous problem" flymake-goto-prev-error t ]
+ [ "Check now" flymake-start t ]
+ [ "List all problems" flymake-show-diagnostics-buffer t ]
"--"
- [ "Turn off Flymake" flymake-mode t ]))
+ [ "Go to log buffer" flymake-switch-to-log-buffer t ]
+ [ "Turn off Flymake" flymake-mode t ]))
(defvar flymake--mode-line-format `(:eval (flymake--mode-line-format)))