summaryrefslogtreecommitdiff
path: root/doc/misc/flymake.texi
diff options
context:
space:
mode:
authorBasil L. Contovounesios <contovob@tcd.ie>2023-06-12 14:42:31 +0100
committerBasil L. Contovounesios <contovob@tcd.ie>2023-06-13 15:29:06 +0100
commit0e9307eb2b8a7ee527427164b9d07f8232d5c34f (patch)
tree0db79f92bc801b885724cc7a34e0568163501d91 /doc/misc/flymake.texi
parent8dc08333eeaa5938227512cb14fa288f4d6823b6 (diff)
downloademacs-0e9307eb2b8a7ee527427164b9d07f8232d5c34f.tar.gz
emacs-0e9307eb2b8a7ee527427164b9d07f8232d5c34f.tar.bz2
emacs-0e9307eb2b8a7ee527427164b9d07f8232d5c34f.zip
Fix some Texinfo markup in manuals
* doc/emacs/macos.texi (Mac / GNUstep Customization): * doc/lispintro/emacs-lisp-intro.texi (condition-case): * doc/lispref/control.texi (pcase Macro): * doc/lispref/debugging.texi (Internals of Debugger): * doc/lispref/internals.texi (Building Emacs): * doc/lispref/modes.texi (Imenu): (Parser-based Font Lock, Parser-based Indentation): * doc/lispref/parsing.texi (Retrieving Nodes, Tree-sitter C API): * doc/lispref/processes.texi (Network, Bindat Types): * doc/lispref/searching.texi (Rx Functions): * doc/lispref/text.texi (Replacing): * doc/lispref/windows.texi (Textual Scrolling): * doc/misc/calc.texi (Killing From Stack, Customizing Calc): * doc/misc/cc-mode.texi (Misc Font Locking, List Line-Up): * doc/misc/ede.texi (ede-cpp-root-project) (ede-proj-target-makefile, ede-sourcecode): * doc/misc/ert.texi (Running Tests in Batch Mode): * doc/misc/eudc.texi (Emacs-only Configuration, The Server Hotlist): * doc/misc/eww.texi (Advanced): * doc/misc/flymake.texi (Starting Flymake) (Proc customization variables): * doc/misc/tramp.texi (File name completion): * doc/misc/gnus.texi (Summary Buffer Lines, Gnus Registry Setup) (Fancy splitting to parent, Customizing the IMAP Connection) (Mail Source Specifiers, Agent as Cache): Consistently mark up nil and t as @code. Also fix the markup and wording of some surrounding text (bug#64016). * doc/lispref/display.texi (SVG Images, Icons): * doc/lispref/modes.texi (Customizing Keywords): Prefer ASCII apostrophe over Unicode right single quotation mark.
Diffstat (limited to 'doc/misc/flymake.texi')
-rw-r--r--doc/misc/flymake.texi23
1 files changed, 14 insertions, 9 deletions
diff --git a/doc/misc/flymake.texi b/doc/misc/flymake.texi
index 03d296a1d42..c7c46896709 100644
--- a/doc/misc/flymake.texi
+++ b/doc/misc/flymake.texi
@@ -115,11 +115,11 @@ Syntax checks happen ``on-the-fly''. Each check is started whenever:
@itemize @bullet
@item
@code{flymake-mode} is started, unless
-@code{flymake-start-on-flymake-mode} is nil;
+@code{flymake-start-on-flymake-mode} is @code{nil};
@item
the buffer is saved, unless @code{flymake-start-on-save-buffer} is
-nil;
+@code{nil};
@item
some changes were made to the buffer more than @code{0.5} seconds ago
@@ -876,13 +876,18 @@ Patterns for error/warning messages in the form @code{(regexp file-idx
line-idx col-idx err-text-idx)}. @xref{Parsing the output}.
@item flymake-proc-diagnostic-type-pred
-A function to classify a diagnostic text as particular type of error.
-Should be a function taking an error text and returning a diagnostic
-symbol (@pxref{Flymake error types}). If non-@code{nil} is returned but
-there is no such symbol in that table, a warning is assumed. If nil
-is returned, an error is assumed. Can also be a regular expression
-that should match only warnings. This variable replaces the old
-@code{flymake-warning-re} and @code{flymake-warning-predicate}.
+A function to classify a diagnostic text as a particular type of
+error. The value of this variable should be a function taking an
+error text and returning a diagnostic symbol (@pxref{Flymake error
+types}). If it returns a non-@code{nil} value but there is no such
+symbol in that table, the text is interpreted as a warning. If the
+function returns @code{nil}, the text is assumed to be an error.
+
+The value of this variable can alternatively be a regular expression
+that should match only warnings.
+
+This variable replaces the old @code{flymake-warning-re} and
+@code{flymake-warning-predicate}.
@item flymake-proc-compilation-prevents-syntax-check
A flag indicating whether compilation and syntax check of the same