From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: Stefan Monnier Newsgroups: gmane.emacs.devel Subject: Re: master 9d2f4a8d5a: Add convenience functions for generating Emacs Lisp files Date: Sun, 05 Jun 2022 11:11:21 -0400 Message-ID: References: <165443980067.10742.1255334855562523988@vcs2.savannah.gnu.org> <20220605143641.51EE9C009A8@vcs2.savannah.gnu.org> Mime-Version: 1.0 Content-Type: text/plain Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="4445"; mail-complaints-to="usenet@ciao.gmane.io" User-Agent: Gnus/5.13 (Gnus v5.13) Emacs/29.0.50 (gnu/linux) Cc: Lars Ingebrigtsen To: emacs-devel@gnu.org Original-X-From: emacs-devel-bounces+ged-emacs-devel=m.gmane-mx.org@gnu.org Sun Jun 05 17:12:41 2022 Return-path: Envelope-to: ged-emacs-devel@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 1nxrvl-0000vW-1M for ged-emacs-devel@m.gmane-mx.org; Sun, 05 Jun 2022 17:12:41 +0200 Original-Received: from localhost ([::1]:40234 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1nxrvj-0003Rr-Px for ged-emacs-devel@m.gmane-mx.org; Sun, 05 Jun 2022 11:12:39 -0400 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]:38144) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1nxruc-0002l0-FO for emacs-devel@gnu.org; Sun, 05 Jun 2022 11:11:30 -0400 Original-Received: from mailscanner.iro.umontreal.ca ([132.204.25.50]:34166) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1nxruY-0000DW-SE for emacs-devel@gnu.org; Sun, 05 Jun 2022 11:11:29 -0400 Original-Received: from pmg1.iro.umontreal.ca (localhost.localdomain [127.0.0.1]) by pmg1.iro.umontreal.ca (Proxmox) with ESMTP id B56C3100796; Sun, 5 Jun 2022 11:11:24 -0400 (EDT) Original-Received: from mail01.iro.umontreal.ca (unknown [172.31.2.1]) by pmg1.iro.umontreal.ca (Proxmox) with ESMTP id 3604B100171; Sun, 5 Jun 2022 11:11:23 -0400 (EDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=iro.umontreal.ca; s=mail; t=1654441883; bh=PAX5Zg7r3K7WKHE/XbJvgLpgGK1BN0QbZUzI+1vRX2k=; h=From:To:Cc:Subject:References:Date:In-Reply-To:From; b=hdSToxV2oaa0+rHe6l1mwx5/WulwZIGJrN4bDJV+ujKuk/Tf28giNStCo7cutESvh OYvx8VKCBgr467ST/t5kAfxuKA4JqYaxLKyZRErdbCuT2K6oieUD/GQJ7SESvzBCHo aQ002HoxRrCXxT4sjg/es+KYvj6GC+yIudep5IpktRMAKN3r7DxDKIUaiQcj1WafKN jn8E8zplBDSPpqAxmEJuU8OfkSif/0LZGMUNPshD9SIs57zc1/brcsqSqGPh8PXBeI OcThTt+4aXlnWp88uYwn+/enwdWTKIXzHf6guKGfQiGqqTmGc5CfcaojXpXseXI+HA 3/jjznPhkWRvA== Original-Received: from pastel (unknown [45.72.221.51]) by mail01.iro.umontreal.ca (Postfix) with ESMTPSA id 03F08120180; Sun, 5 Jun 2022 11:11:22 -0400 (EDT) In-Reply-To: <20220605143641.51EE9C009A8@vcs2.savannah.gnu.org> (Lars Ingebrigtsen's message of "Sun, 5 Jun 2022 10:36:40 -0400 (EDT)") Received-SPF: pass client-ip=132.204.25.50; envelope-from=monnier@iro.umontreal.ca; helo=mailscanner.iro.umontreal.ca X-Spam_score_int: -42 X-Spam_score: -4.3 X-Spam_bar: ---- X-Spam_report: (-4.3 / 5.0 requ) BAYES_00=-1.9, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, RCVD_IN_DNSWL_MED=-2.3, SPF_HELO_NONE=0.001, SPF_PASS=-0.001, T_SCC_BODY_TEXT_LINE=-0.01 autolearn=ham autolearn_force=no X-Spam_action: no action X-BeenThere: emacs-devel@gnu.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: "Emacs development discussions." List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: emacs-devel-bounces+ged-emacs-devel=m.gmane-mx.org@gnu.org Original-Sender: "Emacs-devel" Xref: news.gmane.io gmane.emacs.devel:290720 Archived-At: Thank you, Lars. I can't believe it didn't occur to me earlier. > +++ b/lisp/emacs-lisp/generate-file.el I'd put "elisp" or somesuch in the name, to make it clear it's about generation of ELisp files rather than generation of any other kinds of files. > +(cl-defun generate-file-heading (file &key description text (code t)) > + "Insert a standard header for FILE. > +This header will specify that this is a generated file that > +should not be edited. > + > +If `standard-output' is bound to a buffer, insert in that buffer. > +If no, insert at point in the current buffer. > + > +DESCRIPTION (if any) will be used in the first line. > +TEXT (if given) will be inserted as a comment. I suggest to use names that make it more clear which of the two should be a single line. Maybe `title` and `commentary`? > +If CODE is non-nil (which is the default), a Code: line is > +inserted." Why would we ever want to not insert `Code:`? More importantly, I think this function needs an additional (and mandatory!) argument, which specifies which function generated it. I've too often wasted time locating the code responsible for a bug in the generated file just because that file failed to tell me where this generated file comes from, so we should make it "harder" to generate a file without that origin information. > + ";; This file is part of GNU Emacs.\n\n") Hmm... this makes the function unusable for third party packages, doesn't it? Stefan