Bio/Root/Version.pm

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