From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: Lars Ingebrigtsen Newsgroups: gmane.emacs.devel Subject: Re: master 9d2f4a8d5a: Add convenience functions for generating Emacs Lisp files Date: Sun, 05 Jun 2022 17:40:26 +0200 Message-ID: <87wndv15lh.fsf@gnus.org> 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="25824"; mail-complaints-to="usenet@ciao.gmane.io" User-Agent: Gnus/5.13 (Gnus v5.13) Emacs/29.0.50 (gnu/linux) Cc: emacs-devel@gnu.org To: Stefan Monnier Original-X-From: emacs-devel-bounces+ged-emacs-devel=m.gmane-mx.org@gnu.org Sun Jun 05 17:42:14 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 1nxsOL-0006V8-Ua for ged-emacs-devel@m.gmane-mx.org; Sun, 05 Jun 2022 17:42:13 +0200 Original-Received: from localhost ([::1]:59702 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1nxsOK-0001ix-Da for ged-emacs-devel@m.gmane-mx.org; Sun, 05 Jun 2022 11:42:12 -0400 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]:42838) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1nxsMs-0000HD-7o for emacs-devel@gnu.org; Sun, 05 Jun 2022 11:40:42 -0400 Original-Received: from quimby.gnus.org ([2a01:4f9:2b:f0f::2]:47880) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1nxsMm-0004Ws-S8 for emacs-devel@gnu.org; Sun, 05 Jun 2022 11:40:41 -0400 DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=gnus.org; s=20200322; h=Content-Type:MIME-Version:Message-ID:In-Reply-To:Date: References:Subject:Cc:To:From:Sender:Reply-To:Content-Transfer-Encoding: Content-ID:Content-Description:Resent-Date:Resent-From:Resent-Sender: Resent-To:Resent-Cc:Resent-Message-ID:List-Id:List-Help:List-Unsubscribe: List-Subscribe:List-Post:List-Owner:List-Archive; bh=Ft7FrlRPcrn3QwevKsRr0XoNy63sVWcZ57ZssalNI3s=; b=JURzLJd9csVzyHlXAONXo/Sbok +/o0kPhy56dWQZXUeeTTy/jeRViR3YHU37LqMGoUqkMxUdmm1+BM8xoml0tQXUeLpLu64UpiO0z4l aHFcJxNdEPwVPRj1U1CWQZRqyPlnOr6Ebr/wbI+eOyVWZtlDQj0epKj6SCaxx+BAQty8=; Original-Received: from [84.212.220.105] (helo=xo) by quimby.gnus.org with esmtpsa (TLS1.3:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.92) (envelope-from ) id 1nxsMg-0002tD-FD; Sun, 05 Jun 2022 17:40:32 +0200 Face: iVBORw0KGgoAAAANSUhEUgAAADAAAAAwBAMAAAClLOS0AAAABGdBTUEAALGPC/xhBQAAACBj SFJNAAB6JgAAgIQAAPoAAACA6AAAdTAAAOpgAAA6mAAAF3CculE8AAAAElBMVEUPDxInHCONbKxO KEOiOy3///9uRwijAAAAAWJLR0QF+G/pxwAAAAd0SU1FB+YGBAw1FyQTjt0AAAGlSURBVDjLpZNh mqMwCIbh6R4AxAOsZA4gkAO0mvufaUk6M9raf8uPqLx8BAkB+G9DZiY6vpl/QaIDYLEkmA40PoOb aiG4/e1axFMqdFUCfN9wWmCO+A07FF6wHXJkW79fdaGGcNryJ0QXvCP4+gmswG7v4KaZCFivCg+T 2q4AoC5Sd71uPredUK4AYvrKDpVrpy0bslzjYX508OFoNkbxxwfQcvnzAcwje7sWuw3XdH/zCzde 8zznB9tJ5CAzZb8ni7oTUJ8RxhXZgTM55TnDfO/eCBZfOY+TmxsHO0sfD9UOTRaE1vwrYtOwaoxf zVjUpoVBS4R6aEQsnL0Jm8oAHl5105yrnsSTh1rk+Eno0zL+Vlt0VckoiAGiuJqI1j3qpsWLQd84 N8j+lmAte6L82hp0l46lKGW0L2WEgfZUuw8Vieoj/zHzOvQ6m0VUcqMMshyw4iFQIr3ELBRMWRAT S+nXKPhpQsYkcUwj/9j7UOPTO4alL3CSjEf22T4oXi7kGfQrzG/kW5ANfSXS0mysO13AHn2NFwkP V9Sk9lIA15OCjuL+AZFuUILiwA2mAAAAJXRFWHRkYXRlOmNyZWF0ZQAyMDIyLTA2LTA0VDEyOjUz OjIzKzAwOjAwf9+2egAAACV0RVh0ZGF0ZTptb2RpZnkAMjAyMi0wNi0wNFQxMjo1MzoyMyswMDow MA6CDsYAAAAASUVORK5CYII= X-Now-Playing: 1CD (2022) - 20 Turn It Around's _Illusion_: "(Illusion Suite #7)" In-Reply-To: (Stefan Monnier's message of "Sun, 05 Jun 2022 11:11:21 -0400") Received-SPF: pass client-ip=2a01:4f9:2b:f0f::2; envelope-from=larsi@gnus.org; helo=quimby.gnus.org X-Spam_score_int: -43 X-Spam_score: -4.4 X-Spam_bar: ---- X-Spam_report: (-4.4 / 5.0 requ) BAYES_00=-1.9, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-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:290725 Archived-At: Stefan Monnier writes: >> +++ 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. I'd hoped that having it in emacs-lisp would be enough, but perhaps that's a too subtle hint? OK, I'll rename. > I suggest to use names that make it more clear which of the two should > be a single line. Maybe `title` and `commentary`? Makes sense. Done. >> +If CODE is non-nil (which is the default), a Code: line is >> +inserted." > > Why would we ever want to not insert `Code:`? miscdic/titdic inserts the Code itself after a whopping comment -- I guess we could require that the callers put all the comments in :comment, though. > 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. Very true. Now adjusted. >> + ";; This file is part of GNU Emacs.\n\n") > > Hmm... this makes the function unusable for third party packages, > doesn't it? Perhaps it should be disablable? (Note that after this adjustment, you may have to say "make bootstrap" unfortunately, because I don't think all the dependencies here are correct in our Makefiles...) -- (domestic pets only, the antidote for overdose, milk.) bloggy blog: http://lars.ingebrigtsen.no