On Wed, Sep 26, 2007 at 11:16:46AM -0400, Tres Seaver wrote: > Jim Fulton wrote: > > On Sep 26, 2007, at 10:42 AM, Stephan Richter wrote: > > > >> On Wednesday 26 September 2007 10:40, Jim Fulton wrote: > >>>> What about using CHANGES.txt, which we should be maintaining anyway? > >>> I agree with a change log. CHANGES.txt is difficult to get included > >>> in distributions. Having one requires a more complex setup.py. I'd > >>> rather recommend including a change log in README.txt. > >> -1. I don't like that. We include CHANGES.txt via the long > >> description; that's > >> good enough for me. > > > > Do you think that the change log should be included in the distribution? > > +10. The cheeseshop metadata is not where I would expect to look for a > changelog; having it readable there is only helpful *before* I've > downloaded. > > FWIW, I think that both README.txt and CHANGES.txt should be "package > data", so that they are discoverable after installing an egg. The > top-level README.txt should be boilerplate, and point to those files > (the setup.py process can then stitch them all todgether).
Example from Debian: all packages have a /usr/share/doc/$packagename with the changelog and readme in there, and this is a Very Good Thing. +1 for CHANGES.txt (or NEWS.txt) in a separate file from README.txt +1 for the latest changelog entries visible on the cheeseshop page (see an announcement, go to cheeseshop, see whether you want to upgrade or not) +1 for README.txt and CHANGES.txt available to you after you install an egg. Marius Gedminas -- Despite all appearances, your boss is a thinking, feeling, human being.
Description: Digital signature
_______________________________________________ Zope3-dev mailing list Zope3firstname.lastname@example.org Unsub: http://mail.zope.org/mailman/options/zope3-dev/archive%40mail-archive.com