diff options
| author | Chong Yidong | 2012-02-12 13:10:30 +0800 |
|---|---|---|
| committer | Chong Yidong | 2012-02-12 13:10:30 +0800 |
| commit | d4bd55e7aed47124919d022852d48c53d389fe80 (patch) | |
| tree | 12f3a210cfdd41da308fb6082e516ef57ad24924 | |
| parent | 95986d5276c475c84e8de8b8a31296bd2800ea94 (diff) | |
| download | emacs-d4bd55e7aed47124919d022852d48c53d389fe80.tar.gz emacs-d4bd55e7aed47124919d022852d48c53d389fe80.zip | |
* lisp/window.el (display-buffer): Doc fix.
Fixes: debbugs:10785
| -rw-r--r-- | lisp/ChangeLog | 4 | ||||
| -rw-r--r-- | lisp/window.el | 20 |
2 files changed, 16 insertions, 8 deletions
diff --git a/lisp/ChangeLog b/lisp/ChangeLog index 3dabef53ebb..2f830b7447b 100644 --- a/lisp/ChangeLog +++ b/lisp/ChangeLog | |||
| @@ -1,3 +1,7 @@ | |||
| 1 | 2012-02-12 Chong Yidong <cyd@gnu.org> | ||
| 2 | |||
| 3 | * window.el (display-buffer): Doc fix (Bug#10785). | ||
| 4 | |||
| 1 | 2012-02-12 Glenn Morris <rgm@gnu.org> | 5 | 2012-02-12 Glenn Morris <rgm@gnu.org> |
| 2 | 6 | ||
| 3 | * term/pc-win.el (x-selection-owner-p, x-own-selection-internal) | 7 | * term/pc-win.el (x-selection-owner-p, x-own-selection-internal) |
diff --git a/lisp/window.el b/lisp/window.el index 298310418e8..edd8a113876 100644 --- a/lisp/window.el +++ b/lisp/window.el | |||
| @@ -4625,16 +4625,20 @@ buffer. Return the window chosen for displaying BUFFER-OR-NAME, | |||
| 4625 | or nil if no such window is found. | 4625 | or nil if no such window is found. |
| 4626 | 4626 | ||
| 4627 | Optional argument ACTION should have the form (FUNCTION . ALIST). | 4627 | Optional argument ACTION should have the form (FUNCTION . ALIST). |
| 4628 | FUNCTION is either a function or a list of functions. Each such | 4628 | FUNCTION is either a function or a list of functions. |
| 4629 | function is called with two arguments: the buffer to display and | 4629 | ALIST is an arbitrary association list (alist). |
| 4630 | an alist. It should either display the buffer and return the | 4630 | |
| 4631 | window, or return nil if unable to display the buffer. | 4631 | Each such FUNCTION should accept two arguments: the buffer to |
| 4632 | display and an alist. Based on those arguments, it should either | ||
| 4633 | display the buffer and return the window, or return nil if unable | ||
| 4634 | to display the buffer. | ||
| 4632 | 4635 | ||
| 4633 | The `display-buffer' function builds a function list and an alist | 4636 | The `display-buffer' function builds a function list and an alist |
| 4634 | from `display-buffer-overriding-action', `display-buffer-alist', | 4637 | by combining the functions and alists specified in |
| 4635 | the ACTION argument, `display-buffer-base-action', and | 4638 | `display-buffer-overriding-action', `display-buffer-alist', the |
| 4636 | `display-buffer-fallback-action' (in that order). Then it calls | 4639 | ACTION argument, `display-buffer-base-action', and |
| 4637 | each function in the combined function list in turn, passing the | 4640 | `display-buffer-fallback-action' (in order). Then it calls each |
| 4641 | function in the combined function list in turn, passing the | ||
| 4638 | buffer as the first argument and the combined alist as the second | 4642 | buffer as the first argument and the combined alist as the second |
| 4639 | argument, until one of the functions returns non-nil. | 4643 | argument, until one of the functions returns non-nil. |
| 4640 | 4644 | ||