Function: help-insert-string

help-insert-string is a byte-compiled function defined in help-mode.el.gz.

Signature

(help-insert-string STRING)

Documentation

Insert STRING to the help buffer and install xref info for it.

This function can be used to restore the old contents of the help buffer when going back to the previous topic in the xref stack. It is needed in case when it is impossible to recompute the old contents of the help buffer by other means.

Source Code

;; Defined in /usr/src/emacs/lisp/help-mode.el.gz
(defun help-insert-string (string)
  "Insert STRING to the help buffer and install xref info for it.
This function can be used to restore the old contents of the help buffer
when going back to the previous topic in the xref stack.  It is needed
in case when it is impossible to recompute the old contents of the
help buffer by other means."
  (setq help-xref-stack-item (list #'help-insert-string string))
  (with-output-to-temp-buffer (help-buffer)
    (insert string)))