[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
bug#13379: 24.3.50; compilation-start-hook: misleading docstring
From: |
Christopher Schmidt |
Subject: |
bug#13379: 24.3.50; compilation-start-hook: misleading docstring |
Date: |
Sat, 2 Feb 2013 06:32:04 +0000 (GMT) |
Christopher Schmidt <christopher@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.
--- 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@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)
If there is any doubt whatsoever regarding what I have just done, please
revert immediately and reopen the bug. Thank you!
Christopher
- bug#13379: 24.3.50; compilation-start-hook: misleading docstring,
Christopher Schmidt <=