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

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

[Christopher Schmidt]

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

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

[Christopher Schmidt]

[-- Attachment #1: Type: text/plain, Size: 490 bytes --]

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.

[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: Type: text/x-diff, Size: 961 bytes --]

--- 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)

[-- Attachment #3: Type: text/plain, Size: 146 bytes --]


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

[Andreas Schwab]

Christopher Schmidt <christopher@ch.ristopher.com> writes:

> +  "Hook run after starting a new compilation process.  The hook

The first line of a doc string should always be a complete sentence,
only.

Andreas.

-- 
Andreas Schwab, schwab@linux-m68k.org
GPG Key fingerprint = 58CA 54C7 6D53 942B 1756  01D3 44D5 214B 8276 4ED5
"And now for something completely different."

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

[Christopher Schmidt]

Andreas Schwab <schwab@linux-m68k.org> writes:
> Christopher Schmidt <christopher@ch.ristopher.com> writes:
>
>> +  "Hook run after starting a new compilation process.  The hook
>
> The first line of a doc string should always be a complete sentence,
> only.

I fixed the fix.

        Christopher