Update ExtUtils-MakeMaker to CPAN version 7.28
[perl.git] / cpan / ExtUtils-MakeMaker / lib / ExtUtils / MakeMaker / Tutorial.pod
1 package ExtUtils::MakeMaker::Tutorial;
2
3 our $VERSION = '7.28';
4 $VERSION = eval $VERSION;
5
6
7 =head1 NAME
8
9 ExtUtils::MakeMaker::Tutorial - Writing a module with MakeMaker
10
11 =head1 SYNOPSIS
12
13     use ExtUtils::MakeMaker;
14
15     WriteMakefile(
16         NAME            => 'Your::Module',
17         VERSION_FROM    => 'lib/Your/Module.pm'
18     );
19
20 =head1 DESCRIPTION
21
22 This is a short tutorial on writing a simple module with MakeMaker.
23 It's really not that hard.
24
25
26 =head2 The Mantra
27
28 MakeMaker modules are installed using this simple mantra
29
30         perl Makefile.PL
31         make
32         make test
33         make install
34
35 There are lots more commands and options, but the above will do it.
36
37
38 =head2 The Layout
39
40 The basic files in a module look something like this.
41
42         Makefile.PL
43         MANIFEST
44         lib/Your/Module.pm
45
46 That's all that's strictly necessary.  There's additional files you might
47 want:
48
49         lib/Your/Other/Module.pm
50         t/some_test.t
51         t/some_other_test.t
52         Changes
53         README
54         INSTALL
55         MANIFEST.SKIP
56         bin/some_program
57
58 =over 4
59
60 =item Makefile.PL
61
62 When you run Makefile.PL, it makes a Makefile.  That's the whole point of
63 MakeMaker.  The Makefile.PL is a simple program which loads
64 ExtUtils::MakeMaker and runs the WriteMakefile() function to generate a
65 Makefile.
66
67 Here's an example of what you need for a simple module:
68
69     use ExtUtils::MakeMaker;
70
71     WriteMakefile(
72         NAME            => 'Your::Module',
73         VERSION_FROM    => 'lib/Your/Module.pm'
74     );
75
76 NAME is the top-level namespace of your module.  VERSION_FROM is the file
77 which contains the $VERSION variable for the entire distribution.  Typically
78 this is the same as your top-level module.
79
80
81 =item MANIFEST
82
83 A simple listing of all the files in your distribution.
84
85         Makefile.PL
86         MANIFEST
87         lib/Your/Module.pm
88
89 File paths in a MANIFEST always use Unix conventions (ie. /) even if you're
90 not on Unix.
91
92 You can write this by hand or generate it with 'make manifest'.
93
94 See L<ExtUtils::Manifest> for more details.
95
96
97 =item lib/
98
99 This is the directory where the .pm and .pod files you wish to have
100 installed go.  They are laid out according to namespace.  So Foo::Bar
101 is F<lib/Foo/Bar.pm>.
102
103
104 =item t/
105
106 Tests for your modules go here.  Each test filename ends with a .t.
107 So F<t/foo.t>  'make test' will run these tests.
108
109 Typically, the F<t/> test directory is flat, with all test files located
110 directly within it. However, you can nest tests within subdirectories, for
111 example:
112
113     t/foo/subdir_test.t
114
115 To do this, you need to inform C<WriteMakeFile()> in your I<Makefile.PL> file
116 in the following fashion:
117
118     test => {TESTS => 't/*.t t/*/*.t'}
119
120 That will run all tests in F<t/>, as well as all tests in all subdirectories
121 that reside under F<t/>. You can nest as deeply as makes sense for your project. 
122 Simply add another entry in the test location string. For example, to test:
123
124     t/foo/bar/subdir_test.t
125
126 You would use the following C<test> directive:
127
128     test => {TESTS => 't/*.t t/*/*/*.t'}
129
130 Note that in the above example, tests in the first subdirectory will not be
131 run. To run all tests in the intermediary subdirectory preceeding the one
132 the test files are in, you need to explicitly note it:
133
134     test => {TESTS => 't/*.t t/*/*.t t/*/*/*.t'}
135
136 You don't need to specify wildcards if you only want to test within specific
137 subdirectories. The following example will only run tests in F<t/foo>:
138
139     test => {TESTS => 't/foo/*.t'}
140
141 Tests are run from the top level of your distribution.  So inside a test
142 you would refer to ./lib to enter the lib directory, for example.
143
144
145 =item Changes
146
147 A log of changes you've made to this module.  The layout is free-form.
148 Here's an example:
149
150     1.01 Fri Apr 11 00:21:25 PDT 2003
151         - thing() does some stuff now
152         - fixed the wiggy bug in withit()
153
154     1.00 Mon Apr  7 00:57:15 PDT 2003
155         - "Rain of Frogs" now supported
156
157
158 =item README
159
160 A short description of your module, what it does, why someone would use it
161 and its limitations.  CPAN automatically pulls your README file out of
162 the archive and makes it available to CPAN users, it is the first thing
163 they will read to decide if your module is right for them.
164
165
166 =item INSTALL
167
168 Instructions on how to install your module along with any dependencies.
169 Suggested information to include here:
170
171     any extra modules required for use
172     the minimum version of Perl required
173     if only works on certain operating systems
174
175
176 =item MANIFEST.SKIP
177
178 A file full of regular expressions to exclude when using 'make
179 manifest' to generate the MANIFEST.  These regular expressions
180 are checked against each file path found in the distribution (so
181 you're matching against "t/foo.t" not "foo.t").
182
183 Here's a sample:
184
185     ~$          # ignore emacs and vim backup files
186     .bak$       # ignore manual backups
187     \#          # ignore CVS old revision files and emacs temp files
188
189 Since # can be used for comments, # must be escaped.
190
191 MakeMaker comes with a default MANIFEST.SKIP to avoid things like
192 version control directories and backup files.  Specifying your own
193 will override this default.
194
195
196 =item bin/
197
198
199 =back
200
201 =head1 SEE ALSO
202
203 L<perlmodstyle> gives stylistic help writing a module.
204
205 L<perlnewmod> gives more information about how to write a module.
206
207 There are modules to help you through the process of writing a module:
208 L<ExtUtils::ModuleMaker>, L<Module::Install>, L<PAR>
209
210 =cut
211
212 1;