From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: Thibault Polge Newsgroups: gmane.emacs.bugs Subject: bug#52018: 28.0.60; Improve documentation for compilation-finish-functions Date: Sun, 21 Nov 2021 11:48:00 +0100 Message-ID: <871r39hjj3.fsf@thb.lt> Mime-Version: 1.0 Content-Type: multipart/mixed; boundary="=-=-=" Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="17208"; mail-complaints-to="usenet@ciao.gmane.io" To: 52018@debbugs.gnu.org Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Sun Nov 21 11:49:27 2021 Return-path: Envelope-to: geb-bug-gnu-emacs@m.gmane-mx.org Original-Received: from lists.gnu.org ([209.51.188.17]) by ciao.gmane.io with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.92) (envelope-from ) id 1mokPX-0004EV-Mr for geb-bug-gnu-emacs@m.gmane-mx.org; Sun, 21 Nov 2021 11:49:27 +0100 Original-Received: from localhost ([::1]:50044 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1mokPW-0004ao-8z for geb-bug-gnu-emacs@m.gmane-mx.org; Sun, 21 Nov 2021 05:49:26 -0500 Original-Received: from eggs.gnu.org ([209.51.188.92]:34622) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1mokPC-0004aP-8I for bug-gnu-emacs@gnu.org; Sun, 21 Nov 2021 05:49:06 -0500 Original-Received: from debbugs.gnu.org ([209.51.188.43]:32769) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1mokP8-00035M-CO for bug-gnu-emacs@gnu.org; Sun, 21 Nov 2021 05:49:06 -0500 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1mokP8-0003F4-6g for bug-gnu-emacs@gnu.org; Sun, 21 Nov 2021 05:49:02 -0500 X-Loop: help-debbugs@gnu.org Resent-From: Thibault Polge Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Sun, 21 Nov 2021 10:49:01 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: report 52018 X-GNU-PR-Package: emacs X-Debbugs-Original-To: bug-gnu-emacs@gnu.org Original-Received: via spool by submit@debbugs.gnu.org id=B.163749169612403 (code B ref -1); Sun, 21 Nov 2021 10:49:01 +0000 Original-Received: (at submit) by debbugs.gnu.org; 21 Nov 2021 10:48:16 +0000 Original-Received: from localhost ([127.0.0.1]:44315 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1mokON-0003Dx-ON for submit@debbugs.gnu.org; Sun, 21 Nov 2021 05:48:15 -0500 Original-Received: from lists.gnu.org ([209.51.188.17]:51560) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1mokOM-0003Dp-2a for submit@debbugs.gnu.org; Sun, 21 Nov 2021 05:48:14 -0500 Original-Received: from eggs.gnu.org ([209.51.188.92]:34324) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1mokOL-0004Rd-S8 for bug-gnu-emacs@gnu.org; Sun, 21 Nov 2021 05:48:13 -0500 Original-Received: from 4.mo550.mail-out.ovh.net ([46.105.76.26]:35223) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1mokOJ-0002yx-V2 for bug-gnu-emacs@gnu.org; Sun, 21 Nov 2021 05:48:13 -0500 Original-Received: from player799.ha.ovh.net (unknown [10.109.143.220]) by mo550.mail-out.ovh.net (Postfix) with ESMTP id 53ED02231E for ; Sun, 21 Nov 2021 10:48:01 +0000 (UTC) Original-Received: from thb.lt (lfbn-idf3-1-453-168.w83-114.abo.wanadoo.fr [83.114.45.168]) (Authenticated sender: thibault@thb.lt) by player799.ha.ovh.net (Postfix) with ESMTPSA id C5FB52478A991 for ; Sun, 21 Nov 2021 10:48:00 +0000 (UTC) Authentication-Results: garm.ovh; auth=pass (GARM-98R002af71fab5-9b96-4440-b84d-9e1aa55af810, 37E86EF0AD8AE98073E93484345A05460300FD84) smtp.auth=thibault@thb.lt X-OVh-ClientIp: 83.114.45.168 X-Ovh-Tracer-Id: 2585066186778788772 X-VR-SPAMSTATE: OK X-VR-SPAMSCORE: 0 X-VR-SPAMCAUSE: gggruggvucftvghtrhhoucdtuddrgedvuddrgedvgddvudcutefuodetggdotefrodftvfcurfhrohhfihhlvgemucfqggfjpdevjffgvefmvefgnecuuegrihhlohhuthemucehtddtnecunecujfgurhephffvufffkfggtgesmhdtreertddttdenucfhrhhomhepvfhhihgsrghulhhtucfrohhlghgvuceothhhihgsrghulhhtsehthhgsrdhltheqnecuggftrfgrthhtvghrnhepieehheeikeejieejhfeffeethfdtteevvdevfeegvdeiieefleegteegtdegvddunecukfhppedtrddtrddtrddtpdekfedruddugedrgeehrdduieeknecuvehluhhsthgvrhfuihiivgeptdenucfrrghrrghmpehmohguvgepshhmthhpohhuthdphhgvlhhopehplhgrhigvrhejleelrdhhrgdrohhvhhdrnhgvthdpihhnvghtpedtrddtrddtrddtpdhmrghilhhfrhhomhepthhhihgsrghulhhtsehthhgsrdhlthdprhgtphhtthhopegsuhhgqdhgnhhuqdgvmhgrtghssehgnhhurdhorhhg Received-SPF: pass client-ip=46.105.76.26; envelope-from=thibault@thb.lt; helo=4.mo550.mail-out.ovh.net X-Spam_score_int: -18 X-Spam_score: -1.9 X-Spam_bar: - X-Spam_report: (-1.9 / 5.0 requ) BAYES_00=-1.9, RCVD_IN_DNSWL_NONE=-0.0001, RCVD_IN_MSPIKE_H3=-0.01, RCVD_IN_MSPIKE_WL=-0.01, SPF_HELO_NONE=0.001, SPF_PASS=-0.001 autolearn=ham autolearn_force=no X-Spam_action: no action X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list X-BeenThere: bug-gnu-emacs@gnu.org List-Id: "Bug reports for GNU Emacs, the Swiss army knife of text editors" List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Original-Sender: "bug-gnu-emacs" Xref: news.gmane.io gmane.emacs.bugs:220553 Archived-At: --=-=-= Content-Type: text/plain The attached patch links the docstring of `compilation-finish-functions` to the info manual page documenting the string argument those functions receive. --=-=-= Content-Type: text/x-patch Content-Disposition: inline; filename=0001-Clarify-documentation-of-compilation-finish-function.patch >From ff48c17796acb3d6a77c893bd2b58bff62d43b03 Mon Sep 17 00:00:00 2001 From: Thibault Polge Date: Sun, 21 Nov 2021 11:41:51 +0100 Subject: [PATCH] Clarify documentation of `compilation-finish-functions` Link to reference on the possible values of the string argument. --- lisp/progmodes/compile.el | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/lisp/progmodes/compile.el b/lisp/progmodes/compile.el index ac26f5e934..b71ee410bb 100644 --- a/lisp/progmodes/compile.el +++ b/lisp/progmodes/compile.el @@ -114,7 +114,10 @@ compilation-buffer-name-function (defvar compilation-finish-functions nil "Functions to call when a compilation process finishes. Each function is called with two arguments: the compilation buffer, -and a string describing how the process finished.") +and a string describing how the process finished. + +That string is the sentinel's event type string, see info +node `(elisp) Sentinels' for more details.") (defvar compilation-in-progress nil "List of compilation processes now running.") -- 2.33.1 --=-=-= Content-Type: text/plain Best regards, Thibault --=-=-=--