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

Previous Next

To add a comment to this bug, you must first unarchive it, by sending
a message to control AT debbugs.gnu.org, with unarchive 13379 in the body.
You can then email your comments to 13379 AT debbugs.gnu.org in the normal way.

Toggle the display of automated, internal messages from the tracker.

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

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

Message #10 received at 13379-done <at> debbugs.gnu.org (full text, mbox):

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 1 (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 2 (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 3 (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 #13 received at 13379 <at> debbugs.gnu.org (full text, mbox):

From: Andreas Schwab <schwab <at> linux-m68k.org>
To: 13379 <at> debbugs.gnu.org
Cc: christopher <at> ch.ristopher.com
Subject: Re: bug#13379: 24.3.50; compilation-start-hook: misleading docstring
Date: Sat, 02 Feb 2013 08:39:19 +0100

Christopher Schmidt <christopher <at> 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 <at> linux-m68k.org
GPG Key fingerprint = 58CA 54C7 6D53 942B 1756  01D3 44D5 214B 8276 4ED5
"And now for something completely different."

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

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

Andreas Schwab <schwab <at> linux-m68k.org> writes:
> Christopher Schmidt <christopher <at> 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

Previous Next

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