File: README

package info (click to toggle)
libmodule-versions-report-perl 1.02-1
  • links: PTS
  • area: main
  • in suites: sarge
  • size: 60 kB
  • ctags: 9
  • sloc: perl: 58; makefile: 44
file content (124 lines) | stat: -rw-r--r-- 3,722 bytes parent folder | download | duplicates (5)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
README for Module::Report::Versions
                                       Time-stamp: "2003-06-21 23:18:00 AHDT"

NAME
    Module::Versions::Report -- report versions of all modules in memory

SYNOPSIS
      use Module::Versions::Report;
  
      ...and any code you want...

    This will run all your code normally, but then as the Perl interpreter
    is about to exit, it will print something like:

      Perl v5.6.1 under MSWin32.
       Modules in memory:
        attributes;
        AutoLoader v5.58;
        Carp;
        Config;
        DynaLoader v1.04;
        Exporter v5.562;
        Module::Versions::Report v1.01;
        HTML::Entities v1.22;
        HTML::HeadParser v2.15;
        HTML::Parser v3.25;
        [... and whatever other modules were loaded that session...]

    Consider its use from the command line:

      % perl -MModule::Versions::Report -MLWP -e 1

      Perl v5.6.1 under MSWin32.
       Modules in memory:
        attributes;
        AutoLoader v5.58;
        [...]

DESCRIPTION
    I often get email from someone reporting a bug in a module I've written.
    I email back, asking what version of the module it is, what version of
    Perl on what OS, and sometimes what version of some relevent third
    library (like XML::Parser). They reply, saying "Perl 5". I say "I need
    the exact version, as reported by "perl -v"". They tell me. And I say
    "I, uh, also asked about the version of my module and XML::Parser [or
    whatever]". They say "Oh yeah. It's 2.27". "Is that my module or
    XML::Parser?" "XML::Parser." "OK, and what about my module's version?"
    "Ohyeah. That's 3.11." By this time, days have passed, and what should
    have been a simple operation -- reporting the version of Perl and
    relevent modules, has been needlessly complicated.

    This module is for simplifying that task. If you add "use
    Module::Versions::Report;" to a program (especially handy if your
    program is one that demonstrates a bug in some module), then when the
    program has finished running, you well get a report detailing the all
    modules in memory, and noting the version of each (for modules that
    defined a $VERSION, at least).

COPYRIGHT AND DISCLAIMER
    Copyright 2001-2003 Sean M. Burke. This library is free software; you
    can redistribute it and/or modify it under the same terms as Perl
    itself.

    This program is distributed in the hope that it will be useful, but
    without any warranty; without even the implied warranty of
    merchantability or fitness for a particular purpose.

AUTHOR
    Sean M. Burke, <sburke@cpan.org>



PREREQUISITES

This suite requires Perl 5.


INSTALLATION

You install Module::Versions::Report, as you would install any Perl module
distribution, by running these commands:

   perl Makefile.PL
   make
   make test
   make install

If you want to install a private copy of Module::Versions::Report in
your home directory, then you should try to produce the initial Makefile
with something like this command:

  perl Makefile.PL LIB=~/perl

See perldoc perlmodinstall for more information.


DOCUMENTATION

See the pod in Module::Versions::Report.


SUPPORT

Questions, bug reports, useful code bits, and suggestions for
Worms should be sent to me at sburke@cpan.org


AVAILABILITY

The latest version of Module::Versions::Report is available from the
Comprehensive Perl Archive Network (CPAN).  Visit
<http://www.perl.com/CPAN/> to find a CPAN site near you.


COPYRIGHT

Copyright 2001-2003, Sean M. Burke <sburke@cpan.org>, all rights
reserved.  This program is free software; you can redistribute it
and/or modify it under the same terms as Perl itself.


AUTHOR

Sean M. Burke <sburke@cpan.org>