Update of /cvsroot/module-build/Module-Build/lib/Module/Build
In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv19621/lib/Module/Build
Modified Files:
Authoring.pod
Log Message:
Misc documentation updates: added docs for 'installdirs' parameter to constructor, resorted parameter and method lists, depracated contains_pod() in favor of Module::Build::ModuleInfo.
Index: Authoring.pod
===================================================================
RCS file: /cvsroot/module-build/Module-Build/lib/Module/Build/Authoring.pod,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -d -r1.5 -r1.6
--- Authoring.pod 22 Jan 2005 02:00:21 -0000 1.5
+++ Authoring.pod 24 Jan 2005 21:43:16 -0000 1.6
@@ -154,14 +154,6 @@
harm performance in environments like mod_perl, where as much as
possible of a module's code should be loaded during startup.
-=item build_requires
-
-Modules listed in this section are necessary to build and install the
-given module, but are not necessary for regular usage of it. This is
-actually an important distinction - it allows for tighter control over
-the body of installed modules, and facilitates correct dependency
-checking on binary/packaged distributions of the module.
-
=item build_class
The Module::Build class or subclass to use in the build
@@ -173,6 +165,14 @@
C<build_requires> so that they should be available when C<./Build> is
executed.
+=item build_requires
+
+Modules listed in this section are necessary to build and install the
+given module, but are not necessary for regular usage of it. This is
+actually an important distinction - it allows for tighter control over
+the body of installed modules, and facilitates correct dependency
+checking on binary/packaged distributions of the module.
+
=item c_source
An optional C<c_source> argument specifies a directory which contains
@@ -368,6 +368,13 @@
files. May be given as a string indicating a single directory, or as
a list reference indicating multiple directories.
+=item installdirs
+
+Determines where files are installed within the normal perl hierarchy
+as determined by F<Config.pm>. Valid values are: C<core>, C<site>,
+C<vendor>. The default is C<site>. See
+L<Module::Build/"How Installation Paths are Determined">
+
=item license
Specifies the licensing terms of your distribution. Valid options include:
@@ -647,10 +654,6 @@
=over 4
-=item current_action()
-
-Returns the name of the currently-running action, such as "build" or "test".
-
=item add_build_element($type)
Adds a new type of entry to the build process. Accepts a single
@@ -804,6 +807,8 @@
=item contains_pod($file)
+[Deprecated] Please see L<Module::Build::ModuleInfo> instead.
+
Returns true if the given file appears to contain POD documentation.
Currently this checks whether the file has a line beginning with
'=pod', '=head', or '=item', but the exact semantics may change in the
@@ -833,6 +838,10 @@
data in a directory called C<_build/>. Both of these will be removed
when the C<realclean> action is performed.
+=item current_action()
+
+Returns the name of the currently-running action, such as "build" or "test".
+
=item dispatch($action, %args)
This method is also called from the auto-generated C<Build> script.
@@ -1070,6 +1079,7 @@
=back
+
=head2 Autogenerated Accessors
In addition to the aforementioned methods, there are also some get/set
|
