From 650e4e5229150567be5667fbee3109a917e2297d Mon Sep 17 00:00:00 2001
From: Ken Williams <kwilliams@cpan.org>
Date: Wed, 20 Feb 2008 04:23:40 +0000
Subject: [PATCH] Document the fix_shebang_line() method

git-svn-id: http://svn.perl.org/modules/Module-Build/trunk@10807 50811bd7-b8ce-0310-adc1-d9db26280581
---
 Changes                  |  2 ++
 lib/Module/Build/API.pod | 13 +++++++++++++
 2 files changed, 15 insertions(+)

diff --git a/Changes b/Changes
index 029a9264..e783d11d 100644
--- a/Changes
+++ b/Changes
@@ -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]
 
diff --git a/lib/Module/Build/API.pod b/lib/Module/Build/API.pod
index 2c271b72..099adb14 100644
--- a/lib/Module/Build/API.pod
+++ b/lib/Module/Build/API.pod
@@ -1175,6 +1175,19 @@ The C<feature()> and C<config_data()> methods represent
 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]