aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorEli Zaretskii2025-11-30 09:08:12 +0200
committerEli Zaretskii2025-11-30 09:08:12 +0200
commit8a6b84dbcbcc5f37c082db9e1283fca2d50712cb (patch)
tree5cf1d086beac588ee21b8a2f5b820f0419d68229
parenta74b69368353f644c245cd8e9ff443eaa3db4e6c (diff)
downloademacs-8a6b84dbcbcc5f37c082db9e1283fca2d50712cb.tar.gz
emacs-8a6b84dbcbcc5f37c082db9e1283fca2d50712cb.zip
Fix doc string of 'display-buffer'
* lisp/window.el (display-buffer): Add missing actions and fix quoting to avoid showing hyper-links to non-existent or irrelevant symbols. (Bug#79912)
-rw-r--r--lisp/window.el49
1 files changed, 44 insertions, 5 deletions
diff --git a/lisp/window.el b/lisp/window.el
index 0145cf98eca..025f62e26fa 100644
--- a/lisp/window.el
+++ b/lisp/window.el
@@ -7801,11 +7801,19 @@ perform.
7801Action alist entries are: 7801Action alist entries are:
7802 `inhibit-same-window' -- A non-nil value prevents the same 7802 `inhibit-same-window' -- A non-nil value prevents the same
7803 window from being used for display. 7803 window from being used for display.
7804 \\+`previous-window' -- The value specifies a window which may
7805 have previously displayed the buffer, and that should be
7806 preferred for displaying the buffer.
7807 `mode' -- A major mode or a list of modes; `display-buffer' may
7808 reuse a window if its current buffer is under one of those modes.
7804 `inhibit-switch-frame' -- A non-nil value prevents any frame 7809 `inhibit-switch-frame' -- A non-nil value prevents any frame
7805 used for showing the buffer from being raised or selected. 7810 used for showing the buffer from being raised or selected.
7806 Note that a window manager may still raise a new frame and 7811 Note that a window manager may still raise a new frame and
7807 give it focus, effectively overriding the value specified 7812 give it focus, effectively overriding the value specified
7808 here. 7813 here.
7814 `frame-predicate' -- The value should be a function of one argument,
7815 a frame, and should return non-nil if the frame is a candidate
7816 for displaying the buffer.
7809 `reusable-frames' -- The value specifies the set of frames to 7817 `reusable-frames' -- The value specifies the set of frames to
7810 search for a window that already displays the buffer. 7818 search for a window that already displays the buffer.
7811 Possible values are nil (the selected frame), t (any live 7819 Possible values are nil (the selected frame), t (any live
@@ -7815,7 +7823,11 @@ Action alist entries are:
7815 Takes precedence over the variable. 7823 Takes precedence over the variable.
7816 `pop-up-frame-parameters' -- The value specifies an alist of 7824 `pop-up-frame-parameters' -- The value specifies an alist of
7817 frame parameters to give a new frame, if one is created. 7825 frame parameters to give a new frame, if one is created.
7818 `window-height' -- The value specifies the desired height of the 7826 `parent-frame' -- The value specifies the parent frame to be used
7827 when the buffer is displayed on a child frame.
7828 `child-frame-parameters' -- The value specifies an alist of frame
7829 parameters to use when displaying a buffer on a child frame.
7830 \\+`window-height' -- The value specifies the desired height of the
7819 window chosen and is either an integer (the total height of 7831 window chosen and is either an integer (the total height of
7820 the window specified in frame lines), a floating point 7832 the window specified in frame lines), a floating point
7821 number (the fraction of its total height with respect to the 7833 number (the fraction of its total height with respect to the
@@ -7826,7 +7838,7 @@ Action alist entries are:
7826 window. That function is supposed to adjust the height of 7838 window. That function is supposed to adjust the height of
7827 the window. Suitable functions are `fit-window-to-buffer' 7839 the window. Suitable functions are `fit-window-to-buffer'
7828 and `shrink-window-if-larger-than-buffer'. 7840 and `shrink-window-if-larger-than-buffer'.
7829 `window-width' -- The value specifies the desired width of the 7841 \\+`window-width' -- The value specifies the desired width of the
7830 window chosen and is either an integer (the total width of 7842 window chosen and is either an integer (the total width of
7831 the window specified in frame lines), a floating point 7843 the window specified in frame lines), a floating point
7832 number (the fraction of its total width with respect to the 7844 number (the fraction of its total width with respect to the
@@ -7835,7 +7847,7 @@ Action alist entries are:
7835 width of the window's body in frame columns, or a function to 7847 width of the window's body in frame columns, or a function to
7836 be called with one argument - the chosen window. That 7848 be called with one argument - the chosen window. That
7837 function is supposed to adjust the width of the window. 7849 function is supposed to adjust the width of the window.
7838 `window-size' -- This entry is only useful for windows appearing 7850 \\+`window-size' -- This entry is only useful for windows appearing
7839 alone on their frame and specifies the desired size of that 7851 alone on their frame and specifies the desired size of that
7840 window either as a cons of integers (the total width and 7852 window either as a cons of integers (the total width and
7841 height of the window on that frame), a cons cell whose car is 7853 height of the window on that frame), a cons cell whose car is
@@ -7844,15 +7856,42 @@ Action alist entries are:
7844 its frame), or a function to be called with one argument - 7856 its frame), or a function to be called with one argument -
7845 the chosen window. That function is supposed to adjust the 7857 the chosen window. That function is supposed to adjust the
7846 size of the frame. 7858 size of the frame.
7859 \\+`window-min-width' -- The minimum width of the window to be
7860 used, in canonical frame columns. The value could also be
7861 the symbol `full-width', which means the window to be used should
7862 be a full-width window on its frame.
7863 \\+`window-min-height' -- The minimum height of the window to be
7864 used, in frame's canonical lines. The value could also be the
7865 symbol `full-height', which means the window to be used should
7866 be a full-height window on its frame.
7847 `preserve-size' -- The value should be either (t . nil) to 7867 `preserve-size' -- The value should be either (t . nil) to
7848 preserve the width of the chosen window, (nil . t) to 7868 preserve the width of the chosen window, (nil . t) to
7849 preserve its height or (t . t) to preserve its height and 7869 preserve its height or (t . t) to preserve its height and
7850 width in future changes of the window configuration. 7870 width in future changes of the window configuration.
7851 `window-parameters' -- The value specifies an alist of window 7871 \\+`window-parameters' -- The value specifies an alist of window
7852 parameters to give the chosen window. 7872 parameters to give the chosen window.
7873 `dedicated' -- If the value is non-nil, `display-buffer' will make
7874 the window it uses dedicated (see `set-window-dedicated-p') to the
7875 buffer.
7876 `lru-frames' -- The value specifies the set of frames to search for
7877 a window that can be used to display the buffer.
7878 `lru-time' -- The value specifies the maximum window use time (see
7879 `window-use-time') to consider a window as a candidate for
7880 displaying the buffer.
7881 `bump-use-time' -- A non-nil value means bump the use time of the
7882 window to use (see `window-bump-use-time').
7883 `side' -- The value specifies the side of a frame where to create a
7884 new window displaying the buffer. See `display-buffer-in-side-window'.
7885 `slot' -- If non-nil, specifies the side-window slot where to display
7886 the buffer, see `display-buffer-in-side-window'.
7887 \\+`window' -- The value specifies the window related to the window
7888 to be used for displaying the buffer.
7889 `direction' -- Together with a `window' entry, the value determines
7890 the location of the window (see `display-buffer-in-direction') to
7891 display the buffer.
7853 `allow-no-window' -- A non-nil value means that `display-buffer' 7892 `allow-no-window' -- A non-nil value means that `display-buffer'
7854 may not display the buffer and return nil immediately. 7893 may not display the buffer and return nil immediately.
7855 `some-window' -- This entry defines which window 7894 \\+`some-window' -- This entry defines which window
7856 `display-buffer-use-some-window' should choose. The possible choices 7895 `display-buffer-use-some-window' should choose. The possible choices
7857 are `lru' or nil (the default) to select the least recently used window, 7896 are `lru' or nil (the default) to select the least recently used window,
7858 and `mru' to select the most recently used window. It can also be a 7897 and `mru' to select the most recently used window. It can also be a