[Bioperl-l] which version is installed (and links to documentation projects)

[Allen Day]

yes, i found this file last night when i started working on this.  my idea 
is to put a wrapper around bioperl.pod so that it contains the version 
number, and also reads in the AUTHORS file and tacks that onto the end of 
the pod.

i'll commit later today and you can have a look.

-allen


On Wed, 11 Dec 2002, Jason Stajich wrote:

> we already have a a file bioperl.pod - can it fit in here?
> 
> On Tue, 10 Dec 2002, Allen Day wrote:
> 
> > bioperl.pm is a good name?  then you can do "perldoc bioperl" or "man
> > bioperl".
> >
> > i'll set up the logic to have the document generated, along with a
> > template document that people involved in the various bioperl
> > documentation efforts can fill in with references to where their docs can
> > be found.
> >
> > i should be able to set this up tonight or tomorrow... will post again to
> > the list where there files are when it's ready.
> >
> > -allen
> >
> >
> > On Tue, 10 Dec 2002, Hilmar Lapp wrote:
> >
> > > Sounds very useful to me. I vote for it. -hilmar
> > >
> > > On Tuesday, December 10, 2002, at 09:55 PM, Allen Day wrote:
> > >
> > > > There could be a functionless .pm file that just has general bioperl
> > > > documentation.  I like they way "perldoc perl" works, to direct the
> > > > reader
> > > > to the other perl documentation.  Are we to the point yet that we have
> > > > several readme and install docs yet?  I know Peter Schattner is working
> > > > on a tutorial, and... aren't there some people at the Pasteur Institute
> > > > doing some work along these lines as well?
> > > >
> > > > Anyway, this dummy .pm could be generated during the make, with the
> > > > version encoded in a configuration file (possibly generated by
> > > > Makefile.PL.  You can set source files to be grokked into install files
> > > > using the PL_FILES hashref, like:
> > > >
> > > > WriteMakefile(
> > > >   PL_FILES => { 'bioperl.PLS' => 'bioperl.pm' }
> > > > )
> > > >
> > > > Inside bioperl.PLS you do something like this:
> > > >
> > > > #!perl
> > > > use LocalConf; #a module i wrote for generating pl/pm files from PLS
> > > >                #files, it exports a hash, similar to Config, see
> > > >                #L<Config>.
> > > >
> > > > print OUT <<"!GROK!THIS!";
> > > > =pod
> > > >
> > > > =head2 Bioperl v$Local{version} - blah blah blah
> > > >
> > > > blah blah blah
> > > > !GROK!THIS!
> > > >
> > > >
> > > > I can do this if people feel it's worthwhile.
> > > >
> > > > -Allen
> > > >
> > > >
> > > > On Tue, 10 Dec 2002, Hilmar Lapp wrote:
> > > >
> > > >> I think what jason was also referring to is who do you tell which
> > > >> version you are running if all you have is an installed bioperl.
> > > >> Would configuring the makefile help here? -hilmar
> > > >>
> > > >>> -----Original Message-----
> > > >>> From: Allen Day [mailto:allenday@ucla.edu]
> > > >>> Sent: Tuesday, December 10, 2002 9:35 PM
> > > >>> To: Jason Stajich
> > > >>> Cc: Bioperl
> > > >>> Subject: Re: [Bioperl-l] which version is installed
> > > >>>
> > > >>>
> > > >>> You can set the value of VERSION in WriteMakefile(), or set
> > > >>> VERSION_FROM
> > > >>> to the filename where the version can be found.  This is all
> > > >>> documented in
> > > >>> ExtUtils::MakeMaker.
> > > >>>
> > > >>> I think it makes sense to set the release version in
> > > >>> Makefile.PL, and to
> > > >>> let individual modules have their own versions.
> > > >>>
> > > >>> -Allen
> > > >>>
> > > >>>
> > > >>> On Tue, 10 Dec 2002, Jason Stajich wrote:
> > > >>>
> > > >>>> This is a common question:
> > > >>>>
> > > >>>>> it (I do not know what Version of bioperl it is. Is
> > > >>>>> there a way to find out the bioperl version easily?).
> > > >>>>
> > > >>>> At one point we were tagging the Bio::Seq module with the
> > > >>> correct version.
> > > >>>> Another option is to globally apply a VERSION tag through
> > > >>> CVS magic in
> > > >>>> either all the $Id$ or through some finagling and actually setting a
> > > >>>> $VERSION variable in all modules and have the value set through cvs
> > > >>>> tagging magic.
> > > >>>>
> > > >>>> What is the best and most CPAN friendly way this should be done?
> > > >>>>
> > > >>>> -jason
> > > >>>> _______________________________________________
> > > >>>> Bioperl-l mailing list
> > > >>>> Bioperl-l@bioperl.org
> > > >>>> http://bioperl.org/mailman/listinfo/bioperl-l
> > > >>>>
> > > >>>
> > > >>> _______________________________________________
> > > >>> Bioperl-l mailing list
> > > >>> Bioperl-l@bioperl.org
> > > >>> http://bioperl.org/mailman/listinfo/bioperl-l
> > > >>>
> > > >>
> > > >
> > > >
> > > --
> > > -------------------------------------------------------------
> > > Hilmar Lapp                            email: lapp at gnf.org
> > > GNF, San Diego, Ca. 92121              phone: +1-858-812-1757
> > > -------------------------------------------------------------
> > >
> >
> 
> --
> Jason Stajich
> Duke University
> jason at cgt.mc.duke.edu
>