diff options
Diffstat (limited to 'doc/misc/flymake.texi')
| -rw-r--r-- | doc/misc/flymake.texi | 39 |
1 files changed, 36 insertions, 3 deletions
diff --git a/doc/misc/flymake.texi b/doc/misc/flymake.texi index 03d296a1d42..b6a540a6ea3 100644 --- a/doc/misc/flymake.texi +++ b/doc/misc/flymake.texi @@ -1,8 +1,8 @@ \input texinfo @c -*- mode: texinfo; coding: utf-8 -*- @comment %**start of header @setfilename ../../info/flymake.info -@set VERSION 1.2.2 -@set UPDATED November 2021 +@set VERSION 1.3.4 +@set UPDATED April 2023 @settitle GNU Flymake @value{VERSION} @include docstyle.texi @syncodeindex pg cp @@ -142,6 +142,12 @@ highlighted regions to learn what the specific problem is. Alternatively, place point on the highlighted regions and use the commands @code{eldoc} or @code{display-local-help}. +Another easy way to get instant access to the diagnostic text is to +set @code{flymake-show-diagnostics-at-end-of-line} to a non-@code{nil} +value. This makes the diagnostic messages appear at the end of the +line where the regular annotation is located (@pxref{Customizable +variables}) + @cindex next and previous diagnostic If the diagnostics are outside the visible region of the buffer, @code{flymake-goto-next-error} and @code{flymake-goto-prev-error} are @@ -314,6 +320,22 @@ Which fringe (if any) should show the warning/error bitmaps. @item flymake-wrap-around If non-@code{nil}, moving to errors with @code{flymake-goto-next-error} and @code{flymake-goto-prev-error} wraps around buffer boundaries. + +@item flymake-show-diagnostics-at-end-of-line +If non-@code{nil}, show summarized descriptions of diagnostics at the +end of the line. Depending on your preference, this can either be +distracting and easily confused with actual code, or a significant +early aid that relieves you from moving around or reaching for the +mouse to consult an error message. + +@item flymake-error-eol +A custom face for summarizing diagnostic error messages. + +@item flymake-warning-eol +A custom face for summarizing diagnostic warning messages. + +@item flymake-note-eol +A custom face for summarizing diagnostic notes. @end vtable @node Extending Flymake @@ -394,7 +416,7 @@ its @code{flymake-overlay-control} property: @item @cindex severity of diagnostic -@code{flymake-severity} is a non-negative integer specifying the +@code{severity} is a non-negative integer specifying the diagnostic's severity. The higher the value, the more serious is the error. If the overlay property @code{priority} is not specified in @code{flymake-overlay-control}, @code{flymake-severity} is used to set @@ -409,6 +431,17 @@ type, in case the name of the symbol associated with it is very long. @vindex flymake-category @code{flymake-category} is a symbol whose property list is considered the default for missing values of any other properties. + +@item +@cindex mode-line appearance of a diagnostic +@code{mode-line-face} is a face specifier controlling the appearance +of the indicator of this type of diagnostic in the mode line. + +@item +@cindex summarized appearance of a diagnostic +@code{echo-face} is a face specifier controlling the appearance of the +summarized description of this diagnostic when reading diagnostic +messages (@pxref{Finding diagnostics}). @end itemize @cindex predefined diagnostic types |