Spelling fixes.
[bpt/emacs.git] / lisp / help.el
index 0c8d671..36d49aa 100644 (file)
 (add-hook 'temp-buffer-setup-hook 'help-mode-setup)
 (add-hook 'temp-buffer-show-hook 'help-mode-finish)
 
-;; The variable `help-window' below is used by `help-mode-finish' to
-;; communicate the window displaying help (the "help window") to the
-;; macro `with-help-window'.  The latter sets `help-window' to t before
-;; invoking `with-output-to-temp-buffer'.  If and only if `help-window'
-;; is eq to t, `help-mode-finish' (called by `temp-buffer-setup-hook')
-;; sets `help-window' to the window selected by `display-buffer'.
-;; Exiting `with-help-window' and calling `help-print-return-message'
-;; reset `help-window' to nil.
-(defvar help-window nil
-  "Window chosen for displaying help.")
-
 ;; `help-window-point-marker' is a marker you can move to a valid
 ;; position of the buffer shown in the help window in order to override
 ;; the standard positioning mechanism (`point-min') chosen by
@@ -980,7 +969,7 @@ This is effective only when Temp Buffer Resize mode is enabled.
 The value is the maximum height (in lines) which
 `resize-temp-buffer-window' will give to a window displaying a
 temporary buffer.  It can also be a function to be called to
-choose the height for such a buffer.  It gets one argumemt, the
+choose the height for such a buffer.  It gets one argument, the
 buffer, and should return a positive integer.  At the time the
 function is called, the window to be resized is selected."
   :type '(choice integer function)
@@ -988,13 +977,15 @@ function is called, the window to be resized is selected."
   :version "20.4")
 
 (define-minor-mode temp-buffer-resize-mode
-  "Toggle mode which makes windows smaller for temporary buffers.
-With prefix argument ARG, turn the resizing of windows displaying
-temporary buffers on if ARG is positive or off otherwise.
+  "Toggle auto-shrinking temp buffer windows (Temp Buffer Resize mode).
+With a prefix argument ARG, enable Temp Buffer Resize mode if ARG
+is positive, and disable it otherwise.  If called from Lisp,
+enable the mode if ARG is omitted or nil.
 
-This mode makes a window the right height for its contents, but
-never more than `temp-buffer-max-height' nor less than
-`window-min-height'.
+When Temp Buffer Resize mode is enabled, the windows in which we
+show a temporary buffer are automatically reduced in height to
+fit the buffer's contents, but never more than
+`temp-buffer-max-height' nor less than `window-min-height'.
 
 This mode is used by `help', `apropos' and `completion' buffers,
 and some others."
@@ -1012,7 +1003,7 @@ than `window-min-height'.  Do nothing if the selected window is
 not vertically combined or some of its contents are scrolled out
 of view."
   (when (and (pos-visible-in-window-p (point-min))
-            (window-iso-combined-p))
+            (window-combined-p))
     (fit-window-to-buffer
      nil
      (if (functionp temp-buffer-max-height)
@@ -1066,7 +1057,7 @@ HELP-WINDOW is the window used for displaying the help buffer."
   (let* ((help-buffer (when (window-live-p help-window)
                        (window-buffer help-window)))
         (help-setup (when (window-live-p help-window)
-                      (window-parameter help-window 'help-setup))))
+                      (car (window-parameter help-window 'quit-restore)))))
     (when help-buffer
       ;; Handle `help-window-point-marker'.
       (when (eq (marker-buffer help-window-point-marker) help-buffer)
@@ -1077,7 +1068,7 @@ HELP-WINDOW is the window used for displaying the help buffer."
       (cond
        ((or (eq help-window (selected-window))
            (and (or (eq help-window-select t)
-                    (eq help-setup 'new-frame)
+                    (eq help-setup 'frame)
                     (and (eq help-window-select 'other)
                          (eq (window-frame help-window) (selected-frame))
                          (> (length (window-list nil 'no-mini)) 2)))
@@ -1085,12 +1076,12 @@ HELP-WINDOW is the window used for displaying the help buffer."
        ;; The help window is or gets selected ...
        (help-window-display-message
         (cond
-         ((eq help-setup 'new-window)
+         ((eq help-setup 'window)
           ;; ... and is new, ...
           "Type \"q\" to delete help window")
-         ((eq help-setup 'new-frame)
+         ((eq help-setup 'frame)
           "Type \"q\" to delete help frame")
-         ((eq help-setup 'reuse-other)
+         ((eq help-setup 'other)
           ;; ... or displayed some other buffer before.
           "Type \"q\" to restore previous buffer"))
         help-window t))
@@ -1100,19 +1091,19 @@ HELP-WINDOW is the window used for displaying the help buffer."
        ;; other one is the selected one.
        (help-window-display-message
         (cond
-         ((eq help-setup 'new-window)
+         ((eq help-setup 'window)
           "Type \\[delete-other-windows] to delete the help window")
-         ((eq help-setup 'reuse-other)
+         ((eq help-setup 'other)
           "Type \"q\" in help window to restore its previous buffer"))
         help-window 'other))
        (t
        ;; The help window is not selected ...
        (help-window-display-message
         (cond
-         ((eq help-setup 'new-window)
+         ((eq help-setup 'window)
           ;; ... and is new, ...
           "Type \"q\" in help window to delete it")
-         ((eq help-setup 'reuse-other)
+         ((eq help-setup 'other)
           ;; ... or displayed some other buffer before.
           "Type \"q\" in help window to restore previous buffer"))
         help-window))))))
@@ -1134,10 +1125,7 @@ HELP-WINDOW is the window used for displaying the help buffer."
 (defmacro with-help-window (buffer-name &rest body)
   "Display buffer with name BUFFER-NAME in a help window evaluating BODY.
 Select help window if the actual value of the user option
-`help-window-select' says so.  Return last value in BODY.
-
-You can specify where and how to show the buffer by binding the
-variable `temp-buffer-show-specifiers' to an appropriate value."
+`help-window-select' says so.  Return last value in BODY."
   (declare (indent 1) (debug t))
   `(progn
      ;; Make `help-window-point-marker' point nowhere.  The only place