Permalink
Browse files

document the env/package variables in API

  • Loading branch information...
jberger committed Mar 16, 2012
1 parent 4dab278 commit 5ca2f99a28698a07655719749067df79f8e5f04b
Showing with 22 additions and 2 deletions.
  1. +22 −2 lib/Alien/Base/ModuleBuild/API.pod
@@ -69,7 +69,7 @@ A hashref or arrayref of hashrefs defining the repositories used to find and fet
=item protocol
-One of C<ftp> or C<http> or C<local>.
+One of C<ftp> or C<http> or C<local>. The first two are obvious, C<local> allows packaging a tarball with the Alien:: module.
=item protocol_class
@@ -81,7 +81,7 @@ This is either the root server address for the FTP and HTTP classes (i.e. C<my.s
=item location
-This key is protocol specific. For FTP this contains the name of the folder to search. For HTTP this is the page to be searched for links; this is specified as a path relative to the C<host>.
+This key is protocol specific. For FTP this contains the name of the folder to search. For HTTP this is the page to be searched for links; this is specified as a path relative to the C<host>. For a local file, this specifies the folder containing the tarball relative to the C<base_dir>.
=item pattern
@@ -114,6 +114,26 @@ Unlike most L<Module::Build> parameters, authors may specify only those keys whi
=back
+=head2 PACKAGE AND ENVIRONMENT VARIABLES
+
+A few global variables are used to set gross behavior. For each pair of variables, if both are set, the environment variable takes precedence.
+
+=over
+
+=item $Verbose
+
+=item $ENV{ALIEN_VERBOSE}
+
+Setting the either to a true value will output a little more info from within the module itself, plus is will not suppress the messages from the library-build phase (i.e. make etc.).
+
+=item $Force
+
+=item $ENV{ALIEN_FORCE}
+
+Setting either to a true value will cause the builder to ignore a system-wide installation and build a local version of the library.
+
+=back
+
=begin comment
our $Verbose ||= $ENV{ALIEN_VERBOSE};

0 comments on commit 5ca2f99

Please sign in to comment.