[Emacs-diffs] emacs-24 r116957: Improve documentation of blink-cursor-mode and its customization variables.

[Eli Zaretskii]

------------------------------------------------------------
revno: 116957
revision-id: address@hidden
parent: address@hidden
committer: Eli Zaretskii <address@hidden>
branch nick: emacs-24
timestamp: Sun 2014-04-13 10:49:23 +0300
message:
  Improve documentation of blink-cursor-mode and its customization variables.
  
   lisp/frame.el (blink-cursor-blinks, blink-cursor-blinks-done): Doc fixes.
   (blink-cursor-mode): Mention customization variables and the
   effect of 'blink-cursor-blinks'.
  
   doc/emacs/display.texi (Cursor Display): Explain better how to customize
   'blink-cursor-blinks'.
modified:
  doc/emacs/ChangeLog            changelog-20091113204419-o5vbwnq5f7feedwu-6227
  doc/emacs/display.texi         
display.texi-20091113204419-o5vbwnq5f7feedwu-6243
  lisp/ChangeLog                 changelog-20091113204419-o5vbwnq5f7feedwu-1432
  lisp/frame.el                  frame.el-20091113204419-o5vbwnq5f7feedwu-275

=== modified file 'doc/emacs/ChangeLog'
--- a/doc/emacs/ChangeLog       2014-04-05 18:33:55 +0000
+++ b/doc/emacs/ChangeLog       2014-04-13 07:49:23 +0000
@@ -1,3 +1,8 @@
+2014-04-13  Eli Zaretskii  <address@hidden>
+
+       * display.texi (Cursor Display): Explain better how to customize
+       'blink-cursor-blinks'.
+
 2014-04-05  Glenn Morris  <address@hidden>
 
        * trouble.texi (Checklist): Dribble files may contain passwords.

=== modified file 'doc/emacs/display.texi'
--- a/doc/emacs/display.texi    2014-02-07 07:18:02 +0000
+++ b/doc/emacs/display.texi    2014-04-13 07:49:23 +0000
@@ -1482,18 +1482,27 @@
 @vindex blink-cursor-mode
 @vindex blink-cursor-blinks
 @vindex blink-cursor-alist
-  By default, the cursor stops blinking after 10 blinks.  This can be
-changed by customizing the variable @code{blink-cursor-blinks}.  To
-disable cursor blinking altogether, change the variable
address@hidden to @code{nil} (@pxref{Easy Customization}),
-or add the line @code{(blink-cursor-mode 0)} to your init file.
-Alternatively, you can change how the cursor looks when it ``blinks
-off'' by customizing the list variable @code{blink-cursor-alist}.
-Each element in the list should have the form @code{(@var{on-type}
-. @var{off-type})}; this means that if the cursor is displayed as
address@hidden when it blinks on (where @var{on-type} is one of the
-cursor types described above), then it is displayed as @var{off-type}
-when it blinks off.
+  By default, the cursor stops blinking after 10 blinks, if Emacs does
+not get any input during that time; any input event restarts the
+count.  You can customize the variable @code{blink-cursor-blinks} to
+control that: its value says how many times to blink without input
+before stopping.  Setting that variable to a zero or negative value
+will make the cursor blink forever.  To disable cursor blinking
+altogether, change the variable @code{blink-cursor-mode} to @code{nil}
+(@pxref{Easy Customization}), or add the line
+
address@hidden
+  (blink-cursor-mode 0)
address@hidden lisp
+
address@hidden
+to your init file.  Alternatively, you can change how the cursor
+looks when it ``blinks off'' by customizing the list variable
address@hidden  Each element in the list should have the
+form @code{(@var{on-type} . @var{off-type})}; this means that if the
+cursor is displayed as @var{on-type} when it blinks on (where
address@hidden is one of the cursor types described above), then it is
+displayed as @var{off-type} when it blinks off.
 
 @vindex x-stretch-cursor
 @cindex wide block cursor

=== modified file 'lisp/ChangeLog'
--- a/lisp/ChangeLog    2014-04-12 19:20:44 +0000
+++ b/lisp/ChangeLog    2014-04-13 07:49:23 +0000
@@ -1,3 +1,9 @@
+2014-04-13  Eli Zaretskii  <address@hidden>
+
+       * frame.el (blink-cursor-blinks, blink-cursor-blinks-done): Doc fixes.
+       (blink-cursor-mode): Mention customization variables and the
+       effect of 'blink-cursor-blinks'.
+
 2014-04-12  Barry O'Reilly  <address@hidden>
 
        * simple.el (undo): Prevent insertion of identity mapping into

=== modified file 'lisp/frame.el'
--- a/lisp/frame.el     2014-03-23 22:11:59 +0000
+++ b/lisp/frame.el     2014-04-13 07:49:23 +0000
@@ -1722,14 +1722,14 @@
   :group 'cursor)
 
 (defcustom blink-cursor-blinks 10
-  "How many times to blink before using a solid cursor on NS and X.
+  "How many times to blink before using a solid cursor on NS, X, and 
MS-Windows.
 Use 0 or negative value to blink forever."
   :version "24.4"
   :type 'integer
   :group 'cursor)
 
 (defvar blink-cursor-blinks-done 1
-  "Number of blinks done since we started blinking on NS and X")
+  "Number of blinks done since we started blinking on NS, X, and MS-Windows.")
 
 (defvar blink-cursor-idle-timer nil
   "Timer started after `blink-cursor-delay' seconds of Emacs idle time.
@@ -1807,6 +1807,12 @@
 positive, and disable it otherwise.  If called from Lisp, enable
 the mode if ARG is omitted or nil.
 
+If the value of `blink-cursor-blinks' is positive (10 by default),
+the cursor stops blinking after that number of blinks, if Emacs
+gets no input during that time.
+
+See also `blink-cursor-interval' and `blink-cursor-delay'.
+
 This command is effective only on graphical frames.  On text-only
 terminals, cursor blinking is controlled by the terminal."
   :init-value (not (or noninteractive