Good log messages for git commits will clarify the Changes file (e.g., explanations, context, examples where relevant).
As for what most folks use for Changes, that would best fit our Release_Notes (although I find them much more useful than the change logs from other projects that hand edit them. The idea for git generated Changes is to make the development process more accessible to PDL users and potential new developers and not perfection in documentation... :-) --Chris On Tue, May 15, 2012 at 12:35 PM, David Mertens <[email protected]> wrote: > I just realized that I hadn't been updating the Changes file! What sort of > stuff needs to go into that? Obviously the git log is too verbose. > > David > > On Tue, May 15, 2012 at 11:22 AM, Chris Marshall <[email protected]> > wrote: >> >> A.k.a. PDL-2.4.11 release candidate 2. >> >> This is a quick point release with support for perl 5.16 which >> is to be released within a week or so. Assuming that tests >> go well, this will become the official PDL-2.4.11 release this >> weekend. >> >> Please report any problems or successes so that we can >> ensure Release_Notes and Known_problems are complete >> and up to date. >> >> --Chris >> >> Release Notes for PDL 2.4.10_005 -------------------------- >> >> General Notes: >> >> +---------------------------------------------------------------+ >> | BE WARNED: This release includes an update to the internal, | >> | C-level PDL API and will require that you re-build all the | >> | PP modules. Do not install over an existing PDL installation | >> | unless you are prepared to do so!!! | >> +---------------------------------------------------------------+ >> >> * A.k.a. PDL-2.4.11 release candidate 2 with support for >> perl 5.16.0. Please test! >> >> - It is a snapshot of the current git development tree >> and everything may not work correctly or have complete >> documentation. >> >> - These release notes may not be fully complete. Please >> see Changes (from the git log) for full details. >> >> - All tests may not pass, especially ones corresponding >> to issues in Known_problems. >> >> - Manual build/install is recommended although the >> cpan shell may be used by specifying the distribution >> path rather than just the module name, e.g.: >> >> cpan> get CHM/PDL-2.4.10_005.tar.gz >> cpan> make CHM/PDL-2.4.10_005.tar.gz >> cpan> test CHM/PDL-2.4.10_005.tar.gz >> cpan> look CHM/PDL-2.4.10_005.tar.gz >> >> Highlights: >> >> * A new implementation mapflex and mapfraw routines provides >> memory-mapped IO for all platforms including win32 systems. >> >> * The new memory mapped IO support is implemented using File::Map >> so version 0.47 has been added as a required dependency to >> force automated testing so an automated build will need >> this dependency installed. >> >> However, or systems having POSIX mmap, a manual build >> will automatically use the legacy implementation. >> >> * Various cleanup to existing code to fix warnings generated >> by perl versions 5.15.x and higher. >> >> Remove deprecation warning in PGPLOT/Window/Window.pm >> complex.pd - fix attempts to overload '<=>=' and '=>' >> >> * Sf.net bugs fixed: >> >> 3487569 PDL::IO::Misc : rcols problem (thanks bperret!) >> 3518253 Make PDL::flat work under perl 5.16 (thanks sprout!) >> 3476648 PDL build of HTML docs fails on recent bleed Perl >> >> * Other bugs fixed: >> >> Fixed pdl-from-string handling of inf/nan >> Fix check for glutRunning logic for imag2d >> Fixed a bug in cat's error reporting. >> Added lvalue awareness to whereND >> >> * Test suite improvements: >> >> skip t/gd_oo_tests.t on BSD OS to avoid sf.net #3518190 >> skip t/inline-comment-test.t on BSD to avoid sf.net #3524081 >> Force $eps for approx() in t/limits_round.t >> Updated tests for t/pdl-from-string.t for inf/nan handling >> Avoid the fork() call in t/plplot.t for win32 only. >> Made t/pp_line_numbers.t more robust >> Added lvalue whereND tests to t/primitive.t >> >> * New support for multiline comments in PP code. See docs for >> PDL::PP for details (e.g., pdldoc PP). >> >> * Various enhancements to barf/croak output and messages to make >> error reports and stack traces more useful and readable. >> >> * There is a new changes (or Changes) target for the PDL Makefile >> which is a convenience target that allows one to regenerat the >> Changes file from git. >> >> _______________________________________________ >> Perldl mailing list >> [email protected] >> http://mailman.jach.hawaii.edu/mailman/listinfo/perldl > > > > > -- > "Debugging is twice as hard as writing the code in the first place. > Therefore, if you write the code as cleverly as possible, you are, > by definition, not smart enough to debug it." -- Brian Kernighan > _______________________________________________ Perldl mailing list [email protected] http://mailman.jach.hawaii.edu/mailman/listinfo/perldl
