diff options
| author | Martin Rudalics | 2017-04-27 10:18:48 +0200 |
|---|---|---|
| committer | Martin Rudalics | 2017-04-27 10:18:48 +0200 |
| commit | 79c5ea9911a9aba7db0ba0e367e06507cee2fc02 (patch) | |
| tree | c94b6576e5d5d4fd0a53a700b911a6e470ecc79d /doc | |
| parent | ee42f02c91a6d50d67e32c34a66029f5ee9a26ed (diff) | |
| download | emacs-79c5ea9911a9aba7db0ba0e367e06507cee2fc02.tar.gz emacs-79c5ea9911a9aba7db0ba0e367e06507cee2fc02.zip | |
Fix doc and customization type of `window-combination-limit' (Bug#26673)
* src/window.c (Vwindow_combination_limit): Fix doc-string.
* lisp/cus-start.el (window-combination-limit): Fix
customization type.
* doc/lispref/windows.texi (Recombining Windows): Fix
documentation of `window-combination-limit'.
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/lispref/windows.texi | 33 |
1 files changed, 22 insertions, 11 deletions
diff --git a/doc/lispref/windows.texi b/doc/lispref/windows.texi index fed2dea7572..b015233753f 100644 --- a/doc/lispref/windows.texi +++ b/doc/lispref/windows.texi | |||
| @@ -1516,26 +1516,37 @@ direction as the existing window combination (otherwise, a new internal | |||
| 1516 | window is created anyway). | 1516 | window is created anyway). |
| 1517 | 1517 | ||
| 1518 | @item window-size | 1518 | @item window-size |
| 1519 | In this case @code{display-buffer} makes a new parent window if it is | 1519 | This means that @code{display-buffer} makes a new parent window when it |
| 1520 | passed a @code{window-height} or @code{window-width} entry in the | 1520 | splits a window and is passed a @code{window-height} or |
| 1521 | @var{alist} argument (@pxref{Display Action Functions}). | 1521 | @code{window-width} entry in the @var{alist} argument (@pxref{Display |
| 1522 | Action Functions}). Otherwise, window splitting behaves as for a value | ||
| 1523 | of @code{nil}. | ||
| 1524 | |||
| 1525 | @item temp-buffer-resize | ||
| 1526 | In this case @code{with-temp-buffer-window} makes a new parent window | ||
| 1527 | when it splits a window and @code{temp-buffer-resize-mode} is enabled | ||
| 1528 | (@pxref{Temporary Displays}). Otherwise, window splitting behaves as | ||
| 1529 | for @code{nil}. | ||
| 1522 | 1530 | ||
| 1523 | @item temp-buffer | 1531 | @item temp-buffer |
| 1524 | This value causes the creation of a new parent window when a window is | 1532 | In this case @code{with-temp-buffer-window} always makes a new parent |
| 1525 | split for showing a temporary buffer (@pxref{Temporary Displays}) only. | 1533 | window when it splits an existing window (@pxref{Temporary Displays}). |
| 1534 | Otherwise, window splitting behaves as for @code{nil}. | ||
| 1526 | 1535 | ||
| 1527 | @item display-buffer | 1536 | @item display-buffer |
| 1528 | This means that when @code{display-buffer} (@pxref{Choosing Window}) | 1537 | This means that when @code{display-buffer} (@pxref{Choosing Window}) |
| 1529 | splits a window it always makes a new parent window. | 1538 | splits a window it always makes a new parent window. Otherwise, window |
| 1539 | splitting behaves as for @code{nil}. | ||
| 1530 | 1540 | ||
| 1531 | @item t | 1541 | @item t |
| 1532 | In this case a new parent window is always created when splitting a | 1542 | This means that splitting a window always creates a new parent window. |
| 1533 | window. Thus, if the value of this variable is at all times @code{t}, | 1543 | Thus, if the value of this variable is at all times @code{t}, then at |
| 1534 | then at all times every window tree is a binary tree (a tree where each | 1544 | all times every window tree is a binary tree (a tree where each window |
| 1535 | window except the root window has exactly one sibling). | 1545 | except the root window has exactly one sibling). |
| 1536 | @end table | 1546 | @end table |
| 1537 | 1547 | ||
| 1538 | The default is @code{nil}. Other values are reserved for future use. | 1548 | The default is @code{window-size}. Other values are reserved for future |
| 1549 | use. | ||
| 1539 | 1550 | ||
| 1540 | If, as a consequence of this variable's setting, @code{split-window} | 1551 | If, as a consequence of this variable's setting, @code{split-window} |
| 1541 | makes a new parent window, it also calls | 1552 | makes a new parent window, it also calls |