From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!not-for-mail From: =?UTF-8?Q?Cl=c3=a9ment_Pit--Claudel?= Newsgroups: gmane.emacs.devel Subject: Re: ChangeLog API Date: Wed, 23 Mar 2016 14:53:13 -0400 Message-ID: <56F2E619.30807@gmail.com> References: NNTP-Posting-Host: plane.gmane.org Mime-Version: 1.0 Content-Type: multipart/signed; micalg=pgp-sha1; protocol="application/pgp-signature"; boundary="awDcMo88CQ6OP8H9JcE9dOO6TvgWBNoGk" X-Trace: ger.gmane.org 1458759228 26384 80.91.229.3 (23 Mar 2016 18:53:48 GMT) X-Complaints-To: usenet@ger.gmane.org NNTP-Posting-Date: Wed, 23 Mar 2016 18:53:48 +0000 (UTC) To: emacs-devel@gnu.org Original-X-From: emacs-devel-bounces+ged-emacs-devel=m.gmane.org@gnu.org Wed Mar 23 19:53:39 2016 Return-path: Envelope-to: ged-emacs-devel@m.gmane.org Original-Received: from lists.gnu.org ([208.118.235.17]) by plane.gmane.org with esmtp (Exim 4.69) (envelope-from ) id 1ainuV-0006b1-5v for ged-emacs-devel@m.gmane.org; Wed, 23 Mar 2016 19:53:39 +0100 Original-Received: from localhost ([::1]:45473 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1ainuU-0003QM-5E for ged-emacs-devel@m.gmane.org; Wed, 23 Mar 2016 14:53:38 -0400 Original-Received: from eggs.gnu.org ([2001:4830:134:3::10]:38523) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1ainuC-0003Pp-Lj for emacs-devel@gnu.org; Wed, 23 Mar 2016 14:53:21 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1ainu9-0003mN-F9 for emacs-devel@gnu.org; Wed, 23 Mar 2016 14:53:20 -0400 Original-Received: from mout.kundenserver.de ([217.72.192.75]:51649) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1ainu9-0003mB-5r for emacs-devel@gnu.org; Wed, 23 Mar 2016 14:53:17 -0400 Original-Received: from [18.26.2.123] ([18.26.2.123]) by mrelayeu.kundenserver.de (mreue102) with ESMTPSA (Nemesis) id 0Lx6wD-1Zh4PD2REv-016j4t for ; Wed, 23 Mar 2016 19:53:14 +0100 User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:38.0) Gecko/20100101 Thunderbird/38.6.0 In-Reply-To: X-Provags-ID: V03:K0:GwSabjZT2UActbyN0yZdzbSD1Do9fXOPu9W1CNGq2PDG7n9UQQ6 j7l21Jmx4wcofWA6fE5xy5yz8YmiNfAHt7zjpa6FjHYd36vm7YEEiq6G8vShp2k43b4snSD ObrFWSuchoDxWAyewGIqjWXbsCwJSjJ0WWegGrpCk1kWqatRGxUPlQA66YPD9Huprq92WGo BHoy33KGj/yg4hPxK46FQ== X-UI-Out-Filterresults: notjunk:1;V01:K0:ImEhkZQ3Z/g=:jaSf0jqz0UYmVYVXhUt665 zg4/7lhc4UUQuVVqEelYRxit4F+OXTmQcYul+7g+iAHKTKSgh2vl4Dw2erBygcwMhb9jcpaCe qXFA3riCEtxQxBMZP/bC1angPRrZufp6PblxbfayczSTJdhMhgd3tDjmWHmUuNy7WiNLUVBNE 02wGtYgvwW0BAzy5fhP3XHv8gvAKvwTy+q9UXe8BualH4ATVyaRUXMd7KewYDjehGS8JdKKeT 8Zxaoq28MfpGWBwH9KHBj+pkXQNOsa3f0BUZhVDZQMfTeu4+teqrZzBtZZq8l1BVwYZyLTolJ U8ICrdKMnvqHpq3LDGv/s8ASDP1J46t3ceJA+Z7KPT9va6Oye48wdVtQRD/zJc+9Ku2JS55UI YBqQMoWMIzNFIkXIdOUQ+nlyH9AjFqJ3/nRe+OswsHYfbPoeCQMNj/3oU2CFpX3Sd6N5RQyOT HpWVsqSLCb1Y+u+Nng0Pch6ZIOW9jaa1w1zRzYuHwFDxMqEEPXs1woDiyBGp98EyQJWBJea3v Tt3ZoX69eAJVMAKP7Kneq6qMGG23yGqzy/0zHWStVur3qEzr48IC45NhVPo2mh+wzkxaBRshK Dv3guyTUNSR557oRRJ9xkPzdHNNqUBRwaMUE52KB8r07MWFJ1753+zF4+ZHR25dISqJqwR6TH O/sOBgUbP3LbPZ06Noncvm3dxVYCyX+yKjGxSUI0a+M+vqdRQdSug3DYm3yp3uUA1BZI= X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.2.x-3.x [generic] X-Received-From: 217.72.192.75 X-BeenThere: emacs-devel@gnu.org X-Mailman-Version: 2.1.14 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.org@gnu.org Original-Sender: emacs-devel-bounces+ged-emacs-devel=m.gmane.org@gnu.org Xref: news.gmane.org gmane.emacs.devel:202145 Archived-At: This is an OpenPGP/MIME signed message (RFC 4880 and 3156) --awDcMo88CQ6OP8H9JcE9dOO6TvgWBNoGk Content-Type: multipart/mixed; boundary="c1I42EVbp8LJeMf6RJnjW6CRgaWQKrJH2" From: =?UTF-8?Q?Cl=c3=a9ment_Pit--Claudel?= To: emacs-devel@gnu.org Message-ID: <56F2E619.30807@gmail.com> Subject: Re: ChangeLog API References: In-Reply-To: --c1I42EVbp8LJeMf6RJnjW6CRgaWQKrJH2 Content-Type: text/plain; charset=windows-1252 Content-Transfer-Encoding: quoted-printable On 03/23/2016 02:34 PM, John Wiegley wrote: >>>>>> Edward Knyshov writes: > > Even if we had such an API, enforcing it as a requirement for a package= 's > inclusion in GNU ELPA -- otherwise, most packages would probably ignore= it -- > would be rather heavy-weight. Further, the result would likely be a lar= ge > volume of information for you to ingest. I don't see the cost/benefit r= atio > adding up for an API like this. We already have a notion of per-file change logs, though: `;;; Change Log:' This begins change log information stored in the library file (i= f you store the change history there). For Lisp files distributed with Em= acs, the change history is kept in the file `ChangeLog' and not in the so= urce file at all; these files generally do not have a `;;; Change Log:' l= ine. `History' is an alternative to `Change Log'. Many packages are already using it (to some extent), but since it isn't r= eally displayed anywhere there are little incentives to keep it up to dat= e. One common format seems to be ;; [date] [some sort of separator] [some message] For example: (json.el) ;;; History: ;; 2006-03-11 - Initial version. ;; 2006-03-13 - Added JSON generation in addition to parsing. Various= ;; other cleanups, bugfixes, and improvements. ;; 2006-12-29 - XEmacs support, from Aidan Kehoe . ;; 2008-02-21 - Installed in GNU Emacs. ;; 2011-10-17 - Patch `json-alist-p' and `json-plist-p' to avoid recu= rsion -tzz ;; 2012-10-25 - Added pretty-printed reformatting -Ryan Crum (ryan@ry= ancrum.org) (rfc2104.el) ;;; History: ;; (...) ;; 2000-05-12 added sha-1 example, added test case reference ;; 2003-11-13 change rfc2104-hexstring-to-bitstring to ...-byte-list ;; 2008-04-25 rewrite rfc2104-hash for speed (company-coq.el) ;;; History: ;; 2016-02-28 =97 Show input hints for Unicode and prettified symbols= ;; 2016-02-28 =97 Prettify symbols in notation strings and code block= s ;; 2016-02-07 =97 Support for changing [Require]s to use fully qualif= ied names ;; 2016-02-02 =97 Preserve names by inserting intros when extracting = a lemma That being said, some packages also put historical notes in there. Others= use different conventions, such as the following (cl-lib.el) ;;; Change Log: ;; Version 2.02 (30 Jul 93): ;; * Added "cl-compat.el" file, extra compatibility with old package.= ;; * Added `lexical-let' and `lexical-let*'. ;; * Added `define-modify-macro', `callf', and `callf2'. ;; * Added `ignore-errors'. (uniquify.el) ;;; Change Log: ;; Originally by Dick King 15 May 86 ;; Converted for Emacs 18 by Stephen Gildea ;; Make uniquify-min-dir-content 0 truly non-invasive. gildea 23 May = 89 ;; Some cleanup. uniquify-min-dir-content default 0. gildea 01 Jun 89= As a user, it would be nice to get a short summary of new features when I= update; as a package maintainer, I'd love a way to show that information= to users. It could be through a unified NEWS file, too. And we could take a hands-o= ff approach to it by displaying the information if we have it; then maybe= users would push package maintainers to include that information, if the= y do want it. Cl=E9ment. --c1I42EVbp8LJeMf6RJnjW6CRgaWQKrJH2-- --awDcMo88CQ6OP8H9JcE9dOO6TvgWBNoGk Content-Type: application/pgp-signature; name="signature.asc" Content-Description: OpenPGP digital signature Content-Disposition: attachment; filename="signature.asc" -----BEGIN PGP SIGNATURE----- Version: GnuPG v2.0.22 (GNU/Linux) iQIcBAEBAgAGBQJW8uYZAAoJEPqg+cTm90wjbc4QAKhLQNrlUFK8xe8rd+dcgCy2 cervuKuuiOGOp05vFocccnkYPt7xG9KKQvV579nf8M2LH9zF6nonVkdMEI7SRpKd rmw8y9bfktvMN8f4YVIij5GqYNHUaDKOrG6rCJ/AnrcYRxSX3MLM4QtKfiYZLVar Xslx4GUq7XFKMcJ24vQP5P/zeV9rw7xpCDvHdIE9lKXIjNNJbhRFBj04jJZMmBU+ nA+/f5JptydvjWD3tk8wJseOI6PrQFa8Fri9hBFkyNb72BdcJ3GdF3yggRMCRUOz W7a3BBBKwBsSqQ5PBcNh9AYhA4RTXkdXHXsx7nI1sQZmc+Ba5wSBhNk20TXtM0Vb ZqIzyZb5tAGfp+cgkrAfXs2HwjmakFN6oZHXpGPQIIQuI+MVu52RC5iO2umpPdrH h/UuF8WPtYRofPKuquWK2MB7huuRekwXCwcL6nlM1GM8jrfYZwjsvEmv1S3oZC8H C+8dqqlu7EuUZY1cOzFMQgRjh5yDM00F7wJxqt+ltDTTWAD62OUcBahnSNNn3W0C 3XtUkuTA3pfjPcJLXGp3y/JademPhrfQY3SPZ1+NHfi8Z4lJsR2QG5UL4mOkUwXi zTgYOnLYDYHIdNtS0kWarIZ7nMPyDszaTowfkgXfZrzRI9EDGUcrQj7ephYA5VJc 3cH4ZSk1YfLVlGzNdSr7 =EVZC -----END PGP SIGNATURE----- --awDcMo88CQ6OP8H9JcE9dOO6TvgWBNoGk--