[Emacs-diffs] trunk r114278: Fix bug #15375 with inaccurate docs of display margin width values.

[Eli Zaretskii]

------------------------------------------------------------
revno: 114278
revision-id: address@hidden
parent: address@hidden
fixes bug: http://debbugs.gnu.org/15375
committer: Eli Zaretskii <address@hidden>
branch nick: trunk
timestamp: Sat 2013-09-14 12:24:34 +0300
message:
  Fix bug #15375 with inaccurate docs of display margin width values.
  
   doc/lispref/display.texi (Display Margins): State the units of measuring
   margin width.
  
   src/buffer.c (syms_of_buffer) <left-margin-width, right-margin-width>:
   Doc fix.
modified:
  doc/lispref/ChangeLog          changelog-20091113204419-o5vbwnq5f7feedwu-6155
  doc/lispref/display.texi       
display.texi-20091113204419-o5vbwnq5f7feedwu-6172
  src/ChangeLog                  changelog-20091113204419-o5vbwnq5f7feedwu-1438
  src/buffer.c                   buffer.c-20091113204419-o5vbwnq5f7feedwu-264

=== modified file 'doc/lispref/ChangeLog'
--- a/doc/lispref/ChangeLog     2013-09-13 08:26:03 +0000
+++ b/doc/lispref/ChangeLog     2013-09-14 09:24:34 +0000
@@ -1,3 +1,8 @@
+2013-09-14  Eli Zaretskii  <address@hidden>
+
+       * display.texi (Display Margins): State the units of measuring
+       margin width.  (Bug#15375)
+
 2013-09-13  Eli Zaretskii  <address@hidden>
 
        * text.texi (Not Intervals): Minor wording fix.

=== modified file 'doc/lispref/display.texi'
--- a/doc/lispref/display.texi  2013-08-16 05:15:51 +0000
+++ b/doc/lispref/display.texi  2013-09-14 09:24:34 +0000
@@ -4189,13 +4189,15 @@
 variables:
 
 @defvar left-margin-width
-This variable specifies the width of the left margin.
-It is buffer-local in all buffers.
+This variable specifies the width of the left margin, in character
+cell units.  It is buffer-local in all buffers.  A value of @code{nil}
+means no left marginal area.
 @end defvar
 
 @defvar right-margin-width
-This variable specifies the width of the right margin.
-It is buffer-local in all buffers.
+This variable specifies the width of the right margin, in character
+cell units.  It is buffer-local in all buffers.  A value of @code{nil}
+means no right marginal area.
 @end defvar
 
   Setting these variables does not immediately affect the window.  These
@@ -4206,15 +4208,19 @@
   You can also set the margin widths immediately.
 
 @defun set-window-margins window left &optional right
-This function specifies the margin widths for window @var{window}.
-The argument @var{left} controls the left margin and
address@hidden controls the right margin (default @code{0}).
+This function specifies the margin widths for window @var{window}, in
+character cell (a.k.a.@: ``column''), units.  The argument @var{left}
+controls the left margin and @var{right} controls the right margin
+(default @code{0}).
 @end defun
 
 @defun window-margins &optional window
-This function returns the left and right margins of @var{window}
-as a cons cell of the form @code{(@var{left} . @var{right})}.
-If @var{window} is @code{nil}, the selected window is used.
+This function returns the width of the left and right margins of
address@hidden as a cons cell of the form @address@hidden(@var{left}
+. @var{right})}}.  If one of the two marginal areas does not exist,
+its width is returned as @code{nil}; if none of the two margins exist,
+the function returns @code{nil}.  If @var{window} is @code{nil}, the
+selected window is used.
 @end defun
 
 @node Images

=== modified file 'src/ChangeLog'
--- a/src/ChangeLog     2013-09-13 16:46:18 +0000
+++ b/src/ChangeLog     2013-09-14 09:24:34 +0000
@@ -1,3 +1,8 @@
+2013-09-14  Eli Zaretskii  <address@hidden>
+
+       * buffer.c (syms_of_buffer) <left-margin-width, right-margin-width>:
+       Doc fix.  (Bug#15375)
+
 2013-09-13  Dmitry Antipov  <address@hidden>
 
        Unify Fx_focus_frame between all ports.

=== modified file 'src/buffer.c'
--- a/src/buffer.c      2013-09-03 14:40:09 +0000
+++ b/src/buffer.c      2013-09-14 09:24:34 +0000
@@ -5900,7 +5900,7 @@
 
   DEFVAR_PER_BUFFER ("left-margin-width", &BVAR (current_buffer, 
left_margin_cols),
                     Qintegerp,
-                    doc: /* Width of left marginal area for display of a 
buffer.
+                    doc: /* Width in columns of left marginal area for display 
of a buffer.
 A value of nil means no marginal area.
 
 Setting this variable does not take effect until a new buffer is displayed
@@ -5908,7 +5908,7 @@
 
   DEFVAR_PER_BUFFER ("right-margin-width", &BVAR (current_buffer, 
right_margin_cols),
                     Qintegerp,
-                    doc: /* Width of right marginal area for display of a 
buffer.
+                    doc: /* Width in columns of right marginal area for 
display of a buffer.
 A value of nil means no marginal area.
 
 Setting this variable does not take effect until a new buffer is displayed