[crossposting dev list, since it's relevant] one of the issues to be resolved on the new mod_perl site (read: documentation) is to provide a mechanism for generating the Changes and (optionally Contributors) list. With mod_perl 1.x source this has been done manually, and the same with the mod_perl guide. Both, the source code and documentation may benefit from automating this process. Especially since the documentation project's goal is to have many maintainers. So making it easier on them with the Changes by providing an infrastructure would be of a big help.
On the dev list we were talking about automatic generation of the Changes file. Here is an entry from modperl-2.0/todo/utils.txt: - Changes files should be autogenerated from cvs logs. http://www.red-bean.com/cvs2cl/ already does that, but we have an extra wish list: o \n after the list of files o the PR: Obtained from: Submitted by: Reviewed by: could each be on their own line and omitted if there is no value (e.g. none of the current modperl-2.0 changes have a PR) o 2001-09-08 11:00 stas were expanded to the full name 2001-09-08 11:00 Stas Bekman o if we could somehow skip the Apache-Test directory, since that ChangeLog should be in httpd-test/perl-framework The question is whether the autogenerated changes log will be useful for the users, since the logs are full of meaningless to users comments like: fixing typo, reverting a broken fix, etc. So if we have this script running as CGI or pre-run at build time, we could have each page on the website linking to its Changes file. To start with we can simply do: http://cvs.apache.org/viewcvs.cgi/modperl-docs/src/docs/2.0/devel/testing/testing.pod?content-type=text/vnd.viewcvs-markup but unfortunately I cannot figure out how to tell it to always retrieve HEAD :( Another alternative is to maintain a Changes file for each document or docset, like the guide does. This will give a better added value to users but require more work from the maintainers. Please let me know what's the best way to go. _____________________________________________________________________ Stas Bekman JAm_pH -- Just Another mod_perl Hacker http://stason.org/ mod_perl Guide http://perl.apache.org/guide mailto:[EMAIL PROTECTED] http://ticketmaster.com http://apacheweek.com http://singlesheaven.com http://perl.apache.org http://perlmonth.com/ --------------------------------------------------------------------- To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED]
