1Module::Starter::BuildeUrsSeert(C3o)ntributed Perl DocumMeondtualtei:o:nStarter::BuilderSet(3)
2
3
4

NAME

6       Module::Starter::BuilderSet - determine builder metadata
7

VERSION

9       Version 1.54
10

SYNOPSIS

12           use Module::Starter::BuilderSet;
13
14           my $builder_set = Module::Starter::BuilderSet->new;
15           my @supported_builders = $builder_set->supported_builders();
16           my $default_builder = $builder_set->default_builder();
17           my $output_file = $builder_set->file_for_builder($default_builder);
18
19           my $create_method = $builder_set->method_for_builder($default_builder);
20           Module::Starter::Simple->$create_method($default_builder); # eeew.
21
22           my @build_commands = $builder_set->instructions_for_builder($default_builder);
23           my @builder_dependencies = $builder_set->deps_for_builder($default_builder);
24           my @compatible_builders = $builder_set->check_compatibility(@builder_list);
25

DESCRIPTION

27       Module::Starter::BuilderSet is a collection of utility methods used to
28       provide metadata about builders supported by Module::Starter.
29

CLASS METHODS

31   "new()"
32       This method initializes and returns an object representing the set of
33       Builders supported by Module::Starter
34
35   "supported_builders()"
36       This method returns a list of builders supported by Module::Starter
37
38   "file_for_builder($builder)"
39       This method returns the name of the file generated by Module::Starter
40       that will be used to build the generated module
41
42   "method_for_builder($builder)"
43       This method returns the name of the method in the
44       "Module::Starter::Simple" package that is called to create the file
45       returned by "file_for_builder($builder)"
46
47   "instructions_for_builder($builder)"
48       This method returns a list of commands that, when run from the command
49       line (or with "system()"), will cause the generated module to be built,
50       tested and installed.
51
52   "deps_for_builder($builder)"
53       This method returns a list of dependencies in the following format: "(
54       { command => "make",
55           aliases => [ 'make', 'gmake' ],
56          },
57         { command => "another_command",
58           aliases => [ 'alias0', 'alias1', '...' ],
59          }, )"
60
61   "check_compatibility(@builders)"
62       This method accepts a list of builders and filters out the ones that
63       are unsupported or mutually exclusive, returning the builders that
64       passed the filter.  If none pass the filter, the default builder is
65       returned.
66
67   "default_builder()"
68       This method returns the module name of the default builder.
69

BUGS

71       Please report any bugs or feature requests to "bug-module-starter at
72       rt.cpan.org", or through the web interface at <http://rt.cpan.org>.  I
73       will be notified, and then you'll automatically be notified of progress
74       on your bug as I make changes.
75

AUTHOR

77       C.J. Adams-Collier, "<cjac@colliertech.org>"
78

80       Copyright 2007 C.J. Adams-Collier, All Rights Reserved.
81
82       This program is free software; you can redistribute it and/or modify it
83       under the same terms as Perl itself.
84
85       Please note that these modules are not products of or supported by the
86       employers of the various contributors to the code.
87
88
89
90perl v5.12.0                      2009-12-08    Module::Starter::BuilderSet(3)
Impressum