GNU bug report logs - #13379
24.3.50; compilation-start-hook: misleading docstring

Previous Next

Full log

View this message in rfc822 format

From: help-debbugs <at> gnu.org (GNU bug Tracking System)
To: Christopher Schmidt <christopher <at> ch.ristopher.com>
Subject: bug#13379: closed (Re: bug#13379: 24.3.50; compilation-start-hook:
 misleading docstring)
Date: Sat, 02 Feb 2013 06:34:02 +0000

[Message part 1 (text/plain, inline)]

Your bug report

#13379: 24.3.50; compilation-start-hook: misleading docstring

which was filed against the emacs package, has been closed.

The explanation is attached below, along with your original report.
If you require more details, please reply to 13379 <at> debbugs.gnu.org.

-- 
13379: http://debbugs.gnu.org/cgi/bugreport.cgi?bug=13379
GNU Bug Tracking System
Contact help-debbugs <at> gnu.org with problems

[Message part 2 (message/rfc822, inline)]

From: Christopher Schmidt <christopher <at> ch.ristopher.com>
To: 13379-done <at> debbugs.gnu.org
Subject: Re: bug#13379: 24.3.50; compilation-start-hook: misleading docstring
Date: Sat,  2 Feb 2013 06:32:04 +0000 (GMT)

[Message part 3 (text/plain, inline)]

Christopher Schmidt <christopher <at> ch.ristopher.com> writes:
> The docstring of compilation-start-hook is misleading.
>
> The reference to run-hook-with-args is superfluous, so is the
> reference to omake.  I do not think set-process-query-on-exit-flag
> should be used in compilation-start-hook - compilation-always-kill is
> the way to go, or it should be explained why the lambda is added
> buffer locally and where this form should be evaled.

I went ahead and committed this in r111661.

[Message part 4 (text/x-diff, inline)]

--- lisp/ChangeLog
+++ lisp/ChangeLog
@@ -2,6 +2,7 @@
 
 	* progmodes/compile.el (compilation-error-regexp-alist-alist):
 	Identify g++ template instantiation trace.  (Bug#12287)
+	(compilation-start-hook): Simplify docstring.  (Bug#13379)
 
 2013-02-02  Stefan Monnier  <monnier <at> iro.umontreal.ca>
 
--- lisp/progmodes/compile.el
+++ lisp/progmodes/compile.el
@@ -48,12 +48,8 @@
 
 ;;;###autoload
 (defcustom compilation-start-hook nil
-  "List of hook functions run by `compilation-start' on the compilation process.
-\(See `run-hook-with-args').
-If you use \"omake -P\" and do not want \\[save-buffers-kill-terminal] to ask whether you want
-the compilation to be killed, you can use this hook:
-  (add-hook 'compilation-start-hook
-    (lambda (process) (set-process-query-on-exit-flag process nil)) nil t)"
+  "Hook run after starting a new compilation process.  The hook
+is run with one argument, the new process."
   :type 'hook
   :group 'compilation)

[Message part 5 (text/plain, inline)]

If there is any doubt whatsoever regarding what I have just done, please
revert immediately and reopen the bug.  Thank you!

        Christopher

[Message part 6 (message/rfc822, inline)]

From: Christopher Schmidt <christopher <at> ch.ristopher.com>
To: bug-gnu-emacs <at> gnu.org
Subject: 24.3.50; compilation-start-hook: misleading docstring
Date: Mon,  7 Jan 2013 20:12:51 +0000 (GMT)

Severity: minor

The docstring of compilation-start-hook is misleading.

The reference to run-hook-with-args is superfluous, so is the reference
to omake.  I do not think set-process-query-on-exit-flag should be used
in compilation-start-hook - compilation-always-kill is the way to go, or
it should be explained why the lambda is added buffer locally and where
this form should be evaled.

        Christopher

Previous Next

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