Doc suggestion for `cursor-type' in buffer.c

Doc suggestion for `cursor-type' in buffer.c

[Ben North]

The docstring for the variable `cursor-type' ends with the text

   When the buffer is displayed in a nonselected window,
   this variable has no effect; the cursor appears as a hollow box.

which suggests the user has no control over the cursor when in a
non-selected window.  In fact the user can control this, by means of the
variable `cursor-in-non-selected-windows'.  Would a patch like the below
(made against CVS 1.571) clarify the docstring?

Ben.




diff -Nur ORIG/buffer.c NEW/buffer.c
--- ORIG/buffer.c       2008-11-07 09:28:13.621444300 +0000
+++ NEW/buffer.c        2008-11-07 09:32:17.647201000 +0000
@@ -6213,8 +6213,9 @@
   (hbar . HEIGHT) display a horizontal bar cursor with height HEIGHT
   ANYTHING ELSE          display a hollow box cursor

-When the buffer is displayed in a nonselected window,
-this variable has no effect; the cursor appears as a hollow box.  */);
+When the buffer is displayed in a nonselected window, the cursor's
+appearance is instead controlled by the variable
+`cursor-in-non-selected-windows'.  */);

   DEFVAR_PER_BUFFER ("line-spacing",
                     &current_buffer->extra_line_spacing, Qnil,

Re: Doc suggestion for `cursor-type' in buffer.c

[martin rudalics]

 > Would a patch like the below
 > (made against CVS 1.571) clarify the docstring?
[...]
 > -When the buffer is displayed in a nonselected window,
 > -this variable has no effect; the cursor appears as a hollow box.  */);
 > +When the buffer is displayed in a nonselected window, the cursor's
 > +appearance is instead controlled by the variable
 > +`cursor-in-non-selected-windows'.  */);

Thank you, applied.

martin