GNU bug report logs - #8368
24.0.50; "temp" means "help" - rename or at least document

Previous Next

Full log

Message #8 received at 8368 <at> debbugs.gnu.org (full text, mbox):

From: Lars Magne Ingebrigtsen <larsi <at> gnus.org>
To: "Drew Adams" <drew.adams <at> oracle.com>
Cc: 8368 <at> debbugs.gnu.org, rms <at> gnu.org
Subject: Re: 24.0.50; "temp" means "help" - rename or at least document
Date: Thu, 14 Jul 2011 21:26:01 +0200

"Drew Adams" <drew.adams <at> oracle.com> writes:

> And based on its doc, `with-output-to-temp-buffer', for example, is not
> about a help buffer.  There is NOTHING in its doc that gives the
> slightest suggestion that the temporary buffer is a help buffer, is in
> `help-mode', etc.  Nada.  Please take a moment to read the doc string.
>
> But in help.el we do this, at top level:
>
> ;; This makes `with-output-to-temp-buffer' buffers use `help-mode'.
> (add-hook 'temp-buffer-setup-hook 'help-mode-setup)
> (add-hook 'temp-buffer-show-hook 'help-mode-finish)

That's pretty odd.

Digging through the ChangeLogs, this is apparently the commit that
added them, but it doesn't say why.

1999-01-11  Richard Stallman  <rms <at> psilocin.ai.mit.edu>

	* help.el (help-mode-finish): Renamed from help-mode-maybe.
	Don't switch to Help mode here.
	(temp-buffer-setup-hook): Use help-mode-finish.
	(help-mode-setup): New function.
	(temp-buffer-setup-hook): Use help-mode-setup.

Richard, why is `help-mode-setup' run in absolutely all
`with-output-to-temp-buffer' buffers?  This seems rather un-optimal,
since that macro is used for many other things than showing help
buffers.

-- 
(domestic pets only, the antidote for overdose, milk.)
  bloggy blog http://lars.ingebrigtsen.no/

Previous Next

GNU bug tracking system
Copyright (C) 1999 Darren O. Benham, 1997,2003 nCipher Corporation Ltd, 1994-97 Ian Jackson.