[Emacs-diffs] /srv/bzr/emacs/emacs-24 r110848: Document flymake fringe bitmaps

[Glenn Morris]

------------------------------------------------------------
revno: 110848
committer: Glenn Morris <address@hidden>
branch nick: emacs-24
timestamp: Mon 2012-11-12 00:42:27 -0800
message:
  Document flymake fringe bitmaps
  
  * doc/misc/flymake.texi (Customizable variables)
  (Highlighting erroneous lines): Mention flymake-error-bitmap,
  flymake-warning-bitmap, and flymake-fringe-indicator-position.
  
  * lisp/progmodes/flymake.el (flymake-error-bitmap)
  (flymake-warning-bitmap, flymake-fringe-indicator-position): Doc fixes.
  (flymake-error-bitmap, flymake-warning-bitmap): Fix :types.
  
  * etc/NEWS: Related markup.
modified:
  doc/misc/ChangeLog
  doc/misc/flymake.texi
  etc/NEWS
  lisp/ChangeLog
  lisp/progmodes/flymake.el

=== modified file 'doc/misc/ChangeLog'
--- a/doc/misc/ChangeLog        2012-11-09 08:34:17 +0000
+++ b/doc/misc/ChangeLog        2012-11-12 08:42:27 +0000
@@ -1,3 +1,9 @@
+2012-11-12  Glenn Morris  <address@hidden>
+
+       * flymake.texi (Customizable variables)
+       (Highlighting erroneous lines): Mention flymake-error-bitmap,
+       flymake-warning-bitmap, and flymake-fringe-indicator-position.
+
 2012-11-09  Chong Yidong  <address@hidden>
 
        * url.texi (Introduction): Move url-configuration-directory to

=== modified file 'doc/misc/flymake.texi'
--- a/doc/misc/flymake.texi     2012-03-10 04:10:21 +0000
+++ b/doc/misc/flymake.texi     2012-11-12 08:42:27 +0000
@@ -337,6 +337,17 @@
 A custom face for highlighting lines for which at least one warning
 and no errors have been reported.
 
address@hidden flymake-error-bitmap
+A bitmap used in the fringe to mark lines for which an error has
+been reported.
+
address@hidden flymake-warning-bitmap
+A bitmap used in the fringe to mark lines for which a warning has
+been reported.
+
address@hidden flymake-fringe-indicator-position
+Which fringe (if any) should show the warning/error bitmaps.
+
 @end table
 
 @node Adding support for a new syntax check tool
@@ -718,6 +729,15 @@
 @code{flymake-warnline}.  Errors belonging outside the current
 buffer are considered to belong to line 1 of the current buffer.
 
address@hidden This manual does not use vindex.
address@hidden @vindex flymake-fringe-indicator-position
address@hidden @vindex flymake-error-bitmap
address@hidden @vindex flymake-warning-bitmap
+If the option @code{flymake-fringe-indicator-position} is address@hidden,
+errors and warnings are also highlighted in the left or right fringe,
+using the bitmaps specified by @code{flymake-error-bitmap}
+and @code{flymake-warning-bitmap}.
+
 @node Interaction with other modes
 @section Interaction with other modes
 @cindex Interaction with other modes

=== modified file 'etc/NEWS'
--- a/etc/NEWS  2012-11-12 08:18:38 +0000
+++ b/etc/NEWS  2012-11-12 08:42:27 +0000
@@ -440,6 +440,7 @@
 *** ERC will look up server/channel names via auth-source and use any
 channel keys found.
 
++++
 ** Flymake uses fringe bitmaps to indicate errors and warnings.
 See `flymake-fringe-indicator-position', `flymake-error-bitmap' and
 `flymake-warning-bitmap'.

=== modified file 'lisp/ChangeLog'
--- a/lisp/ChangeLog    2012-11-12 01:11:06 +0000
+++ b/lisp/ChangeLog    2012-11-12 08:42:27 +0000
@@ -1,3 +1,9 @@
+2012-11-12  Glenn Morris  <address@hidden>
+
+       * progmodes/flymake.el (flymake-error-bitmap)
+       (flymake-warning-bitmap, flymake-fringe-indicator-position): Doc fixes.
+       (flymake-error-bitmap, flymake-warning-bitmap): Fix :types.
+
 2012-11-12  Dmitry Gutov  <address@hidden>
 
        * progmodes/ruby-mode.el (ruby-move-to-block): When moving

=== modified file 'lisp/progmodes/flymake.el'
--- a/lisp/progmodes/flymake.el 2012-10-20 11:34:06 +0000
+++ b/lisp/progmodes/flymake.el 2012-11-12 08:42:27 +0000
@@ -764,25 +764,39 @@
   (and (overlayp ov) (overlay-get ov 'flymake-overlay)))
 
 (defcustom flymake-error-bitmap '(exclamation-mark error)
-  "Bitmap used in the fringe for indicating errors.
+  "Bitmap (a symbol) used in the fringe for indicating errors.
 The value may also be a list of two elements where the second
-element specifies the face for the bitmap."
+element specifies the face for the bitmap.  For possible bitmap
+symbols, see `fringe-bitmaps'.  See also `flymake-warning-bitmap'.
+
+The option `flymake-fringe-indicator-position' controls how and where
+this is used."
   :group 'flymake
   :version "24.3"
-  :type 'symbol)
+  :type '(choice (symbol :tag "Bitmap")
+                 (list :tag "Bitmap and face"
+                       (symbol :tag "Bitmap")
+                       (face :tag "Face"))))
 
 (defcustom flymake-warning-bitmap 'question-mark
-  "Bitmap used in the fringe for indicating warnings.
+  "Bitmap (a symbol) used in the fringe for indicating warnings.
 The value may also be a list of two elements where the second
-element specifies the face for the bitmap."
+element specifies the face for the bitmap.  For possible bitmap
+symbols, see `fringe-bitmaps'.  See also `flymake-error-bitmap'.
+
+The option `flymake-fringe-indicator-position' controls how and where
+this is used."
   :group 'flymake
   :version "24.3"
-  :type 'symbol)
+  :type '(choice (symbol :tag "Bitmap")
+                 (list :tag "Bitmap and face"
+                       (symbol :tag "Bitmap")
+                       (face :tag "Face"))))
 
 (defcustom flymake-fringe-indicator-position 'left-fringe
   "The position to put flymake fringe indicator.
-The value can be nil, left-fringe or right-fringe.
-Fringe indicators are disabled if nil."
+The value can be nil (do not use indicators), `left-fringe' or `right-fringe'.
+See `flymake-error-bitmap' and `flymake-warning-bitmap'."
   :group 'flymake
   :version "24.3"
   :type '(choice (const left-fringe)