all messages for Emacs-related lists mirrored at yhetil.org
 help / color / mirror / code / Atom feed
From: Jean Louis <bugs@gnu.support>
To: Drew Adams <drew.adams@oracle.com>
Cc: Boruch Baum <boruch_baum@gmx.com>,
	Emacs-Devel List <emacs-devel@gnu.org>
Subject: Re: Changelog message for updating packages
Date: Sun, 8 Nov 2020 20:24:52 +0300	[thread overview]
Message-ID: <X6gp5LGQLNV5Br5J@protected.rcdrun.com> (raw)
In-Reply-To: <297a7ea8-e150-4230-bd0d-c5141f5d5248@default>

* Drew Adams <drew.adams@oracle.com> [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.



  reply	other threads:[~2020-11-08 17:24 UTC|newest]

Thread overview: 6+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-11-08 10:06 Changelog message for updating packages Boruch Baum
2020-11-08 10:31 ` Jean Louis
2020-11-08 15:40   ` Boruch Baum
2020-11-08 16:11   ` Drew Adams
2020-11-08 17:24     ` Jean Louis [this message]
2020-11-08 13:55 ` Stefan Monnier

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=X6gp5LGQLNV5Br5J@protected.rcdrun.com \
    --to=bugs@gnu.support \
    --cc=boruch_baum@gmx.com \
    --cc=drew.adams@oracle.com \
    --cc=emacs-devel@gnu.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body. 
Code repositories for project(s) associated with this external index

	https://git.savannah.gnu.org/cgit/emacs.git
	https://git.savannah.gnu.org/cgit/emacs/org-mode.git

This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.