Geoffrey Young wrote:
> Stas Bekman wrote:
> 
>>[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:
>>
> 
> I have a hacked copy of cvs2cl (somewhere) that does some of those extra things.  it 
>was a royal
> pain, but I might be able to dig it up (I totally forget where it is).

That would be cool, Geoff!

>>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.
>>
> 
> if we want to do that from within the document itself we can use the $Log$ CVS tag.  
>personally, I
> think it's rather ugly, but if it's at the bottom or something...
> 
> here's an example from the formmail.pl nms script
> 
> #!/usr/bin/perl -wT
> #
> # $Id: FormMail.pl,v 1.40 2002/02/22 12:08:30 nickjc Exp $
> #
> # $Log: FormMail.pl,v $
> # Revision 1.40  2002/02/22 12:08:30  nickjc
> # * removed stray ';' from output HTML
> #
> # Revision 1.39  2002/02/21 09:17:29  gellyfish
> # Stylesheet elements will not be added if $style is empty
> #
> # Revision 1.38  2002/02/14 08:45:04  nickjc
> # * fixed silly error in body attribute checking

Nuh, that's ugly especialy considering that this log is going to grow a lot.

Since nobody gave me any other ideas, I've decided to go with the 
guide's Changes file. So each docset will have its own Changes file. 
Manual maintenance will produce the best added value for end users. Even 
if we will have to remind the maintainers to maintain these files.


_____________________________________________________________________
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]

Reply via email to