From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: Jean Louis Newsgroups: gmane.emacs.devel Subject: Re: Changelog message for updating packages Date: Sun, 8 Nov 2020 20:24:52 +0300 Message-ID: References: <20201108100646.vaynfw4fhdiff27m@E15-2016.optimum.net> <297a7ea8-e150-4230-bd0d-c5141f5d5248@default> Mime-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 8bit Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="7198"; mail-complaints-to="usenet@ciao.gmane.io" User-Agent: Mutt/+ (1036f0e) (2020-10-18) Cc: Boruch Baum , Emacs-Devel List To: Drew Adams Original-X-From: emacs-devel-bounces+ged-emacs-devel=m.gmane-mx.org@gnu.org Sun Nov 08 19:17:49 2020 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 1kbpG9-0001mR-6l for ged-emacs-devel@m.gmane-mx.org; Sun, 08 Nov 2020 19:17:49 +0100 Original-Received: from localhost ([::1]:32928 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1kbpG8-0006Oo-8j for ged-emacs-devel@m.gmane-mx.org; Sun, 08 Nov 2020 13:17:48 -0500 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]:33520) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1kbpFa-0005yJ-Be for emacs-devel@gnu.org; Sun, 08 Nov 2020 13:17:14 -0500 Original-Received: from static.rcdrun.com ([95.85.24.50]:48139) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1kbpFY-0000w2-HG for emacs-devel@gnu.org; Sun, 08 Nov 2020 13:17:14 -0500 Original-Received: from localhost ([::ffff:197.157.34.177]) (AUTH: PLAIN admin, TLS: TLS1.2,256bits,ECDHE_RSA_AES_256_GCM_SHA384) by static.rcdrun.com with ESMTPSA id 00000000002C0004.000000005FA83626.0000537D; Sun, 08 Nov 2020 18:17:09 +0000 Content-Disposition: inline In-Reply-To: <297a7ea8-e150-4230-bd0d-c5141f5d5248@default> Received-SPF: pass client-ip=95.85.24.50; envelope-from=bugs@gnu.support; helo=static.rcdrun.com X-detected-operating-system: by eggs.gnu.org: First seen = 2020/11/08 13:17:11 X-ACL-Warn: Detected OS = Linux 3.11 and newer [fuzzy] 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, SPF_HELO_PASS=-0.001, SPF_PASS=-0.001 autolearn=ham autolearn_force=no X-Spam_action: no action X-BeenThere: emacs-devel@gnu.org X-Mailman-Version: 2.1.23 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:258917 Archived-At: * Drew Adams [2020-11-08 19:12]: > > You may find it in Emacs Lisp manual under (elisp) Packaging > > D.8 Conventional Headers for Emacs Libraries > > ============================================ > > ‘;;; Change Log:’ > > This begins an optional log of changes to the file over time. > > FWIW, I use this in each of my Elisp files. I have seen it and it is good practice. When it is too big, then it can be in separate file. Also good practice is that you explain which functions are defined by its groups. Which are interactive functions and so on. That helps greatly when researching the package. I like the Drew's style and I like Pascal Bourguignon's style. You write packages both in very similar fashion with great attention on details and helping those who read it or study. I have not read Emacs main code, it must be useful to learn. What I reviewed are many packages on MELPA as I am discovering those using proprietary software. There I have seen bad styles and what what... For ChangeLog files there is built-in Emacs mode, it works well for external files.