File Coverage

blib/lib/CPAN/Porters.pm

Criterion	Covered	Total	%
statement	6	6	100.0
branch			n/a
condition			n/a
subroutine	2	2	100.0
pod			n/a
total	8	8	100.0

line	stmt	sub	time	code
1				package CPAN::Porters;
2	1	1	668	use strict;
	1		2
	1		28
3	1	1	5	use warnings;
	1		2
	1		61
4
5				our $VERSION = '0.04';
6
7				1;
8
9
10				=head1 NAME
11
12				CPAN::Porters - resource for people maintaining packages of CPAN modules in various distributions
13
14				=head1 SYNOPSIS
15
16				CPAN modules can be either installed from source (downloaded directly from CPAN)
17				or they can be installed with the package mangement system of your distribution.
18
19				CPAN::Porters is a resource for people who are maintaining those packages in the
20				various distributions.
21
22				=head1 Reasoning
23
24				When developing an application we usually don't want to build our own machine. Neither
25				compile our own kernel. In most of the cases we won't want to compile and install
26				our own version of a database engine nor Apache or any other 3rd party tool.
27				So my assumption is that we won't want to install our CPAN dependencies either.
28				Again - in the standard case.
29
30				For people just using an application written in Perl it is even more important that they
31				should not deal with all these packages. Most of us know how much people suffer when they
32				need to install 10s of modules and their dependencies from CPAN. Especially for modules
33				with dependencies outside of CPAN.
34
35				While CPAN.pm, CPANPLUS.pm have improved a lot they still cannot deal with cases when one
36				of the dependencies fails to install cleanly.
37
38				In addition while we usually want to work with recent versions of modules from CPAN,
39				we usually don't want to get the bleeding edge. Espcially not in applications.
40
41				=head1 General resources
42
43				L Statistics about CPAN modules in the various distributions
44
45				=head2 Related mailing lists
46
47				Module Authors: L
48
49				Perl QA L and the mailing list L
50
51				CPAN Testers L
52
53				CPAN Discuss L
54
55
56				=head1 Guidelines for inclusion
57
58				In addition to the guidelines of each distribution on which module to include,
59				when to upgrade etc. we would like to setup our own guidelines to help people
60				decide what to include, what would be the priorites, when to upgrade a module
61				etc.
62
63				A few guidelines on how to select and prioritize modules:
64
65				=over 4
66
67				=item * Modules that are dependencies of another module by a different module author.
68
69				=item * Modules that require compilation
70
71				=item * Modules that require files not on CPAN
72
73				Such modules are especially difficult to install with CPAN.pm or CPANPLUS as they require
74				files outside the scope of CPAN. Making sure such modules and their dependencies can be
75				installed with the standard packaging system gets extra points.
76
77				=item * Web development frameworks
78
79				=item * Modules required by some of the big open source Perl applications.
80
81				For a good listing see the journal entry of brian d foy
82				L
83
84				=back
85
86				Requirements for inclusion or upgrade
87
88				=over 4
89
90				=item * The module already has all its prereq in the system
91
92				=item * The module passes all its tests with its prereqs currently in the system on the system
93
94				=item * The tests of all the currently available dependent modules in the system pass with this new version
95
96				=item * A broader requirement would be that the version has no failing test reports on any other system,
97				though this requirement might be too harsh and unnecessary
98
99
100				=back
101
102				=head1 TODO
103
104				=over 4
105
106				=item * Collect the basic information for the main distributions
107
108				=back
109
110				=head1 SEE ALSO
111
112				L
113
114				PIG has moved here: L
115
116				cpan2dist is a script from L
117
118				=head1 AUTHOR
119
120				This document is maintained by Gabor Szabo
121
122				=cut
123