Author: kwilliams
Date: Tue Feb 19 20:23:40 2008
New Revision: 10807
Modified:
Module-Build/trunk/Changes
Module-Build/trunk/lib/Module/Build/API.pod
Log:
Document the fix_shebang_line() method
Modified: Module-Build/trunk/Changes
==============================================================================
--- Module-Build/trunk/Changes (original)
+++ Module-Build/trunk/Changes Tue Feb 19 20:23:40 2008
@@ -1,5 +1,7 @@
Revision history for Perl extension Module::Build.
+ - Documented the fix_shebang_line() method. [Elliot Shank]
+
- Applied the 'const' modifier to version() and xs_version() XS
functions we use during testing. [Robin Barker]
Modified: Module-Build/trunk/lib/Module/Build/API.pod
==============================================================================
--- Module-Build/trunk/lib/Module/Build/API.pod (original)
+++ Module-Build/trunk/lib/Module/Build/API.pod Tue Feb 19 20:23:40 2008
@@ -1175,6 +1175,19 @@
Module::Build's main support for configuration of installed modules.
See also L<Module::Build::Authoring/"SAVING CONFIGURATION INFORMATION">.
+=item fix_shebang_line(@files)
+
+[version 0.??]
+
+Modify any "shebang" line in the specified files to use the path to the
+perl executable being used for the current build. Files are modified
+in-place. The existing shebang line must have a command that contains
+"C<perl>"; arguments to the command do not count. In particular, this
+means that the use of C<#!/usr/bin/env perl> will not be changed.
+
+For an explanation of shebang lines, see
+L<http://en.wikipedia.org/wiki/Shebang_%28Unix%29>.
+
=item have_c_compiler()
[version 0.21]
