Bio/Root/Version.pm

   1 # $Id$
   2 #
   3 # BioPerl module for Bio::Root::Version
   4 #
   5 # Cared for by Aaron Mackey <amackey@virginia.edu>
   6 #
   7 # Copyright Aaron Mackey
   8 #
   9 # You may distribute this module under the same terms as perl itself
  10
  11 # POD documentation - main docs before the code
  12
  13 =head1 NAME
  14
  15 Bio::Root::Version - provide global, distribution-level versioning
  16
  17 =head1 SYNOPSIS
  18
  19   package Bio::Tools::NiftyFeature;
  20   require Bio::Root::RootI;
  21
  22
  23   # later, in client code:
  24   package main;
  25   use Bio::Tools::NiftyFeature 3.14;
  26
  27
  28   ## alternative usage: NiftyFeature defines own $VERSION:
  29   package Bio::Tools::NiftyFeature;
  30   my $VERSION = 9.8;
  31
  32   # later in client code:
  33   package main;
  34
  35   # ensure we're using an up-to-date BioPerl distribution
  36   use Bio::Perl 3.14;
  37
  38   # NiftyFeature has its own versioning scheme:
  39   use Bio::Tools::NiftyFeature 9.8;
  40
  41 =head1 DESCRIPTION
  42
  43 This module provides a mechanism by which all other BioPerl modules
  44 can share the same $VERSION, without manually synchronizing each file.
  45
  46 Bio::Root::RootI itself uses this module, so any module that directly
  47 (or indirectly) uses Bio::Root::RootI will get a global $VERSION
  48 variable set if it's not already.
  49
  50
  51 =head1 FEEDBACK
  52
  53 =head2 Mailing Lists
  54
  55 User feedback is an integral part of the evolution of this and other
  56 Bioperl modules. Send your comments and suggestions preferably to one
  57 of the Bioperl mailing lists.  Your participation is much appreciated.
  58
  59   bioperl-l@bioperl.org                  - General discussion
  60   http://bioperl.org/wiki/Mailing_lists  - About the mailing lists
  61
  62 =head2 Reporting Bugs
  63
  64 Report bugs to the Bioperl bug tracking system to help us keep track
  65 the bugs and their resolution.  Bug reports can be submitted via the
  66 web:
  67
  68   http://bugzilla.open-bio.org/
  69
  70 =head1 AUTHOR - Aaron Mackey
  71
  72 Email amackey@virginia.edu
  73
  74 =head1 APPENDIX
  75
  76 The rest of the documentation details each of the object
  77 methods. Internal methods are usually preceded with a _
  78
  79 =cut
  80
  81
  82 # Let the code begin...
  83
  84
  85 package Bio::Root::Version;
  86 use strict;
  87
  88 our $VERSION = '1.006000';
  89 $VERSION = eval $VERSION;
  90
  91 sub import {
  92     # try to handle multiple levels of inheritance:
  93     my $i = 0;
  94     my $pkg = caller($i);
  95     no strict 'refs';
  96     while ($pkg) {
  97         if ($pkg =~ m/^Bio::/o &&
  98             not defined ${$pkg . "::VERSION"}) {
  99             ${$pkg . "::VERSION"} = $VERSION;
 100         }
 101         $pkg = caller(++$i);
 102     }
 103 }
 104
 105 1;
 106 __END__