diff options
| author | Eli Zaretskii | 2013-09-14 12:24:34 +0300 |
|---|---|---|
| committer | Eli Zaretskii | 2013-09-14 12:24:34 +0300 |
| commit | 0df00f5905b75a5a0601c8696f41c8796c3d1baa (patch) | |
| tree | cb89288606f46b9ca8bf3fb2f6609471760b28a5 | |
| parent | d3fc65499a4bf85799eee7996128cd74fea17cce (diff) | |
| download | emacs-0df00f5905b75a5a0601c8696f41c8796c3d1baa.tar.gz emacs-0df00f5905b75a5a0601c8696f41c8796c3d1baa.zip | |
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.
| -rw-r--r-- | doc/lispref/ChangeLog | 5 | ||||
| -rw-r--r-- | doc/lispref/display.texi | 26 | ||||
| -rw-r--r-- | src/ChangeLog | 5 | ||||
| -rw-r--r-- | src/buffer.c | 4 |
4 files changed, 28 insertions, 12 deletions
diff --git a/doc/lispref/ChangeLog b/doc/lispref/ChangeLog index b37fa4e64f3..a1503ea4dde 100644 --- a/doc/lispref/ChangeLog +++ b/doc/lispref/ChangeLog | |||
| @@ -1,3 +1,8 @@ | |||
| 1 | 2013-09-14 Eli Zaretskii <eliz@gnu.org> | ||
| 2 | |||
| 3 | * display.texi (Display Margins): State the units of measuring | ||
| 4 | margin width. (Bug#15375) | ||
| 5 | |||
| 1 | 2013-09-13 Eli Zaretskii <eliz@gnu.org> | 6 | 2013-09-13 Eli Zaretskii <eliz@gnu.org> |
| 2 | 7 | ||
| 3 | * text.texi (Not Intervals): Minor wording fix. | 8 | * text.texi (Not Intervals): Minor wording fix. |
diff --git a/doc/lispref/display.texi b/doc/lispref/display.texi index ff9d98170d1..2e7d4f4c010 100644 --- a/doc/lispref/display.texi +++ b/doc/lispref/display.texi | |||
| @@ -4189,13 +4189,15 @@ them a nonzero width. The usual way to do that is to set these | |||
| 4189 | variables: | 4189 | variables: |
| 4190 | 4190 | ||
| 4191 | @defvar left-margin-width | 4191 | @defvar left-margin-width |
| 4192 | This variable specifies the width of the left margin. | 4192 | This variable specifies the width of the left margin, in character |
| 4193 | It is buffer-local in all buffers. | 4193 | cell units. It is buffer-local in all buffers. A value of @code{nil} |
| 4194 | means no left marginal area. | ||
| 4194 | @end defvar | 4195 | @end defvar |
| 4195 | 4196 | ||
| 4196 | @defvar right-margin-width | 4197 | @defvar right-margin-width |
| 4197 | This variable specifies the width of the right margin. | 4198 | This variable specifies the width of the right margin, in character |
| 4198 | It is buffer-local in all buffers. | 4199 | cell units. It is buffer-local in all buffers. A value of @code{nil} |
| 4200 | means no right marginal area. | ||
| 4199 | @end defvar | 4201 | @end defvar |
| 4200 | 4202 | ||
| 4201 | Setting these variables does not immediately affect the window. These | 4203 | Setting these variables does not immediately affect the window. These |
| @@ -4206,15 +4208,19 @@ Thus, you can make changes take effect by calling | |||
| 4206 | You can also set the margin widths immediately. | 4208 | You can also set the margin widths immediately. |
| 4207 | 4209 | ||
| 4208 | @defun set-window-margins window left &optional right | 4210 | @defun set-window-margins window left &optional right |
| 4209 | This function specifies the margin widths for window @var{window}. | 4211 | This function specifies the margin widths for window @var{window}, in |
| 4210 | The argument @var{left} controls the left margin and | 4212 | character cell (a.k.a.@: ``column''), units. The argument @var{left} |
| 4211 | @var{right} controls the right margin (default @code{0}). | 4213 | controls the left margin and @var{right} controls the right margin |
| 4214 | (default @code{0}). | ||
| 4212 | @end defun | 4215 | @end defun |
| 4213 | 4216 | ||
| 4214 | @defun window-margins &optional window | 4217 | @defun window-margins &optional window |
| 4215 | This function returns the left and right margins of @var{window} | 4218 | This function returns the width of the left and right margins of |
| 4216 | as a cons cell of the form @code{(@var{left} . @var{right})}. | 4219 | @var{window} as a cons cell of the form @w{@code{(@var{left} |
| 4217 | If @var{window} is @code{nil}, the selected window is used. | 4220 | . @var{right})}}. If one of the two marginal areas does not exist, |
| 4221 | its width is returned as @code{nil}; if none of the two margins exist, | ||
| 4222 | the function returns @code{nil}. If @var{window} is @code{nil}, the | ||
| 4223 | selected window is used. | ||
| 4218 | @end defun | 4224 | @end defun |
| 4219 | 4225 | ||
| 4220 | @node Images | 4226 | @node Images |
diff --git a/src/ChangeLog b/src/ChangeLog index cc8704da2a1..8df160e1196 100644 --- a/src/ChangeLog +++ b/src/ChangeLog | |||
| @@ -1,3 +1,8 @@ | |||
| 1 | 2013-09-14 Eli Zaretskii <eliz@gnu.org> | ||
| 2 | |||
| 3 | * buffer.c (syms_of_buffer) <left-margin-width, right-margin-width>: | ||
| 4 | Doc fix. (Bug#15375) | ||
| 5 | |||
| 1 | 2013-09-13 Dmitry Antipov <dmantipov@yandex.ru> | 6 | 2013-09-13 Dmitry Antipov <dmantipov@yandex.ru> |
| 2 | 7 | ||
| 3 | Unify Fx_focus_frame between all ports. | 8 | Unify Fx_focus_frame between all ports. |
diff --git a/src/buffer.c b/src/buffer.c index 0bcb608dbd3..3d7468904f2 100644 --- a/src/buffer.c +++ b/src/buffer.c | |||
| @@ -5900,7 +5900,7 @@ See also the functions `display-table-slot' and `set-display-table-slot'. */); | |||
| 5900 | 5900 | ||
| 5901 | DEFVAR_PER_BUFFER ("left-margin-width", &BVAR (current_buffer, left_margin_cols), | 5901 | DEFVAR_PER_BUFFER ("left-margin-width", &BVAR (current_buffer, left_margin_cols), |
| 5902 | Qintegerp, | 5902 | Qintegerp, |
| 5903 | doc: /* Width of left marginal area for display of a buffer. | 5903 | doc: /* Width in columns of left marginal area for display of a buffer. |
| 5904 | A value of nil means no marginal area. | 5904 | A value of nil means no marginal area. |
| 5905 | 5905 | ||
| 5906 | Setting this variable does not take effect until a new buffer is displayed | 5906 | Setting this variable does not take effect until a new buffer is displayed |
| @@ -5908,7 +5908,7 @@ in a window. To make the change take effect, call `set-window-buffer'. */); | |||
| 5908 | 5908 | ||
| 5909 | DEFVAR_PER_BUFFER ("right-margin-width", &BVAR (current_buffer, right_margin_cols), | 5909 | DEFVAR_PER_BUFFER ("right-margin-width", &BVAR (current_buffer, right_margin_cols), |
| 5910 | Qintegerp, | 5910 | Qintegerp, |
| 5911 | doc: /* Width of right marginal area for display of a buffer. | 5911 | doc: /* Width in columns of right marginal area for display of a buffer. |
| 5912 | A value of nil means no marginal area. | 5912 | A value of nil means no marginal area. |
| 5913 | 5913 | ||
| 5914 | Setting this variable does not take effect until a new buffer is displayed | 5914 | Setting this variable does not take effect until a new buffer is displayed |