Implement multicharacter case mappings where a single
[p5sagit/p5-mst-13.2.git] / lib / ExtUtils / Liblist.pm
index 6c2fef8..09421e3 100644 (file)
@@ -1,8 +1,30 @@
 package ExtUtils::Liblist;
-use vars qw($VERSION);
+
+@ISA = qw(ExtUtils::Liblist::Kid File::Spec);
+
+sub lsdir {
+  shift;
+  my $rex = qr/$_[1]/;
+  opendir my $dir, $_[0];
+  grep /$rex/, readdir $dir;
+}
+
+sub file_name_is_absolute {
+  require File::Spec;
+  shift;
+  'File::Spec'->file_name_is_absolute(@_);
+}
+
+
+package ExtUtils::Liblist::Kid;
+
+# This kid package is to be used by MakeMaker.  It will not work if
+# $self is not a Makemaker.
+
+use 5.006_001;
 # Broken out of MakeMaker from version 4.11
 
-$VERSION = substr q$Revision: 1.25 $, 10;
+our $VERSION = substr q$Revision: 1.27 $, 10;
 
 use Config;
 use Cwd 'cwd';
@@ -15,19 +37,19 @@ sub ext {
 }
 
 sub _unix_os2_ext {
-    my($self,$potential_libs, $verbose) = @_;
-    if ($^O =~ 'os2' and $Config{libs}) { 
+    my($self,$potential_libs, $verbose, $give_libs) = @_;
+    if ($^O =~ 'os2' and $Config{perllibs}) { 
        # Dynamic libraries are not transitive, so we may need including
        # the libraries linked against perl.dll again.
 
        $potential_libs .= " " if $potential_libs;
-       $potential_libs .= $Config{libs};
+       $potential_libs .= $Config{perllibs};
     }
-    return ("", "", "", "") unless $potential_libs;
+    return ("", "", "", "", ($give_libs ? [] : ())) unless $potential_libs;
     warn "Potential libraries are '$potential_libs':\n" if $verbose;
 
     my($so)   = $Config{'so'};
-    my($libs) = $Config{'libs'};
+    my($libs) = $Config{'perllibs'};
     my $Config_libext = $Config{lib_ext} || ".a";
 
 
@@ -38,6 +60,7 @@ sub _unix_os2_ext {
     my(@searchpath); # from "-L/path" entries in $potential_libs
     my(@libpath) = split " ", $Config{'libpth'};
     my(@ldloadlibs, @bsloadlibs, @extralibs, @ld_run_path, %ld_run_path_seen);
+    my(@libs, %libs_seen);
     my($fullname, $thislib, $thispth, @fullname);
     my($pwd) = cwd(); # from Cwd.pm
     my($found) = 0;
@@ -108,13 +131,14 @@ sub _unix_os2_ext {
            } elsif (-f ($fullname="$thispth/lib$thislib.$so")
                 && (($Config{'dlsrc'} ne "dl_dld.xs") || ($thislib eq "m"))){
            } elsif (-f ($fullname="$thispth/lib${thislib}_s$Config_libext")
+                 && (! $Config{'archname'} =~ /RM\d\d\d-svr4/)
                 && ($thislib .= "_s") ){ # we must explicitly use _s version
            } elsif (-f ($fullname="$thispth/lib$thislib$Config_libext")){
            } elsif (-f ($fullname="$thispth/$thislib$Config_libext")){
            } elsif (-f ($fullname="$thispth/Slib$thislib$Config_libext")){
            } elsif ($^O eq 'dgux'
                 && -l ($fullname="$thispth/lib$thislib$Config_libext")
-                && readlink($fullname) =~ /^elink:/) {
+                && readlink($fullname) =~ /^elink:/s) {
                 # Some of DG's libraries look like misconnected symbolic
                 # links, but development tools can follow them.  (They
                 # look like this:
@@ -130,13 +154,14 @@ sub _unix_os2_ext {
            warn "'-l$thislib' found at $fullname\n" if $verbose;
            my($fullnamedir) = dirname($fullname);
            push @ld_run_path, $fullnamedir unless $ld_run_path_seen{$fullnamedir}++;
+           push @libs, $fullname unless $libs_seen{$fullname}++;
            $found++;
            $found_lib++;
 
            # Now update library lists
 
            # what do we know about this library...
-           my $is_dyna = ($fullname !~ /\Q$Config_libext\E$/);
+           my $is_dyna = ($fullname !~ /\Q$Config_libext\E\z/);
            my $in_perl = ($libs =~ /\B-l\Q$ {thislib}\E\b/s);
 
            # Do not add it into the list if it is already linked in
@@ -177,24 +202,29 @@ sub _unix_os2_ext {
                     ."No library found for -l$thislib\n"
            unless $found_lib>0;
     }
-    return ('','','','') unless $found;
-    ("@extralibs", "@bsloadlibs", "@ldloadlibs",join(":",@ld_run_path));
+    return ('','','','', ($give_libs ? \@libs : ())) unless $found;
+    ("@extralibs", "@bsloadlibs", "@ldloadlibs",join(":",@ld_run_path), ($give_libs ? \@libs : ()));
 }
 
 sub _win32_ext {
 
     require Text::ParseWords;
 
-    my($self, $potential_libs, $verbose) = @_;
+    my($self, $potential_libs, $verbose, $give_libs) = @_;
 
     # If user did not supply a list, we punt.
     # (caller should probably use the list in $Config{libs})
-    return ("", "", "", "") unless $potential_libs;
-
-    my($so)   = $Config{'so'};
-    my($libs) = $Config{'libs'};
-    my($libpth) = $Config{'libpth'};
-    my($libext) = $Config{'lib_ext'} || ".lib";
+    return ("", "", "", "", ($give_libs ? [] : ())) unless $potential_libs;
+
+    my $cc             = $Config{cc};
+    my $VC             = 1 if $cc =~ /^cl/i;
+    my $BC             = 1 if $cc =~ /^bcc/i;
+    my $GC             = 1 if $cc =~ /^gcc/i;
+    my $so             = $Config{'so'};
+    my $libs           = $Config{'perllibs'};
+    my $libpth         = $Config{'libpth'};
+    my $libext         = $Config{'lib_ext'} || ".lib";
+    my(@libs, %libs_seen);
 
     if ($libs and $potential_libs !~ /:nodefault/i) { 
        # If Config.pm defines a set of default libs, we always
@@ -212,57 +242,113 @@ sub _win32_ext {
 
     # compute $extralibs from $potential_libs
 
-    my(@searchpath); # from "-L/path" entries in $potential_libs
-    my(@libpath) = Text::ParseWords::quotewords('\s+', 0, $libpth);
-    my(@extralibs);
+    my @searchpath;                # from "-L/path" in $potential_libs
+    my @libpath                = Text::ParseWords::quotewords('\s+', 0, $libpth);
+    my @extralibs;
+    my $pwd            = cwd();    # from Cwd.pm
+    my $lib            = '';
+    my $found          = 0;
+    my $search         = 1;
     my($fullname, $thislib, $thispth);
-    my($pwd) = cwd(); # from Cwd.pm
-    my($lib) = '';
-    my($found) = 0;
 
-    foreach $thislib (Text::ParseWords::quotewords('\s+', 0, $potential_libs)){
+    # add "$Config{installarchlib}/CORE" to default search path
+    push @libpath, "$Config{installarchlib}/CORE";
 
-       # Handle possible linker path arguments.
-       if ($thislib =~ s/^-L// and not -d $thislib) {
-           warn "-L$thislib ignored, directory does not exist\n"
+    if ($VC and exists $ENV{LIB} and $ENV{LIB}) {
+        push @libpath, split /;/, $ENV{LIB};
+    }
+
+    foreach (Text::ParseWords::quotewords('\s+', 0, $potential_libs)){
+
+       $thislib = $_;
+
+        # see if entry is a flag
+       if (/^:\w+$/) {
+           $search     = 0 if lc eq ':nosearch';
+           $search     = 1 if lc eq ':search';
+           warn "Ignoring unknown flag '$thislib'\n"
+               if $verbose and !/^:(no)?(search|default)$/i;
+           next;
+       }
+
+       # if searching is disabled, do compiler-specific translations
+       unless ($search) {
+           s/^-l(.+)$/$1.lib/ unless $GC;
+           s/^-L/-libpath:/ if $VC;
+           push(@extralibs, $_);
+           $found++;
+           next;
+       }
+
+       # handle possible linker path arguments
+       if (s/^-L// and not -d) {
+           warn "$thislib ignored, directory does not exist\n"
                if $verbose;
            next;
        }
-       elsif (-d $thislib) {
-           unless ($self->file_name_is_absolute($thislib)) {
-             warn "Warning: '-L$thislib' changed to '-L$pwd/$thislib'\n";
-             $thislib = $self->catdir($pwd,$thislib);
+       elsif (-d) {
+           unless ($self->file_name_is_absolute($_)) {
+             warn "Warning: '$thislib' changed to '-L$pwd/$_'\n";
+             $_ = $self->catdir($pwd,$_);
            }
-           push(@searchpath, $thislib);
+           push(@searchpath, $_);
            next;
        }
 
-       # Handle possible library arguments.
-       if ($thislib =~ s/^-l// and $thislib !~ /^lib/i) {
-           $thislib = "lib$thislib";
+       # handle possible library arguments
+       if (s/^-l// and $GC and !/^lib/i) {
+           $_ = "lib$_";
        }
-       $thislib .= $libext if $thislib !~ /\Q$libext\E$/i;
+       $_ .= $libext if !/\Q$libext\E$/i;
 
-       my($found_lib)=0;
+       my $secondpass = 0;
+    LOOKAGAIN:
+
+        # look for the file itself
+       if (-f) {
+           warn "'$thislib' found as '$_'\n" if $verbose;
+           $found++;
+           push(@extralibs, $_);
+           next;
+       }
+
+       my $found_lib = 0;
        foreach $thispth (@searchpath, @libpath){
-           unless (-f ($fullname="$thispth\\$thislib")) {
-               warn "$thislib not found in $thispth\n" if $verbose;
+           unless (-f ($fullname="$thispth\\$_")) {
+               warn "'$thislib' not found as '$fullname'\n" if $verbose;
                next;
            }
-           warn "'$thislib' found at $fullname\n" if $verbose;
+           warn "'$thislib' found as '$fullname'\n" if $verbose;
            $found++;
            $found_lib++;
            push(@extralibs, $fullname);
+           push @libs, $fullname unless $libs_seen{$fullname}++;
            last;
        }
+
+       # do another pass with (or without) leading 'lib' if they used -l
+       if (!$found_lib and $thislib =~ /^-l/ and !$secondpass++) {
+           if ($GC) {
+               goto LOOKAGAIN if s/^lib//i;
+           }
+           elsif (!/^lib/i) {
+               $_ = "lib$_";
+               goto LOOKAGAIN;
+           }
+       }
+
+       # give up
        warn "Note (probably harmless): "
                     ."No library found for '$thislib'\n"
            unless $found_lib>0;
+
     }
-    return ('','','','') unless $found;
+
+    return ('','','','', ($give_libs ? \@libs : ())) unless $found;
 
     # make sure paths with spaces are properly quoted
     @extralibs = map { (/\s/ && !/^".*"$/) ? qq["$_"] : $_ } @extralibs;
+    @libs = map { (/\s/ && !/^".*"$/) ? qq["$_"] : $_ } @libs;
     $lib = join(' ',@extralibs);
 
     # normalize back to backward slashes (to help braindead tools)
@@ -271,18 +357,18 @@ sub _win32_ext {
     $lib =~ s,/,\\,g;
 
     warn "Result: $lib\n" if $verbose;
-    wantarray ? ($lib, '', $lib, '') : $lib;
+    wantarray ? ($lib, '', $lib, '', ($give_libs ? \@libs : ())) : $lib;
 }
 
 
 sub _vms_ext {
-  my($self, $potential_libs,$verbose) = @_;
+  my($self, $potential_libs,$verbose,$give_libs) = @_;
   my(@crtls,$crtlstr);
   my($dbgqual) = $self->{OPTIMIZE} || $Config{'optimize'} ||
                  $self->{CCFLAS}   || $Config{'ccflags'};
   @crtls = ( ($dbgqual =~ m-/Debug-i ? $Config{'dbgprefix'} : '')
               . 'PerlShr/Share' );
-  push(@crtls, grep { not /\(/ } split /\s+/, $Config{'libs'});
+  push(@crtls, grep { not /\(/ } split /\s+/, $Config{'perllibs'});
   push(@crtls, grep { not /\(/ } split /\s+/, $Config{'libc'});
   # In general, we pass through the basic libraries from %Config unchanged.
   # The one exception is that if we're building in the Perl source tree, and
@@ -305,15 +391,16 @@ sub _vms_ext {
 
   unless ($potential_libs) {
     warn "Result:\n\tEXTRALIBS: \n\tLDLOADLIBS: $crtlstr\n" if $verbose;
-    return ('', '', $crtlstr, '');
+    return ('', '', $crtlstr, '', ($give_libs ? [] : ()));
   }
 
-  my(@dirs,@libs,$dir,$lib,%sh,%olb,%obj,$ldlib);
+  my(@dirs,@libs,$dir,$lib,%found,@fndlibs,$ldlib);
   my $cwd = cwd();
   my($so,$lib_ext,$obj_ext) = @Config{'so','lib_ext','obj_ext'};
   # List of common Unix library names and there VMS equivalents
   # (VMS equivalent of '' indicates that the library is automatially
   # searched by the linker, and should be skipped here.)
+  my(@flibs, %libs_seen);
   my %libmap = ( 'm' => '', 'f77' => '', 'F77' => '', 'V77' => '', 'c' => '',
                  'malloc' => '', 'crypt' => '', 'resolv' => '', 'c_s' => '',
                  'socket' => '', 'X11' => 'DECW$XLIBSHR',
@@ -376,28 +463,28 @@ sub _vms_ext {
         warn "\tChecking $name\n" if $verbose > 2;
         if (-f ($test = VMS::Filespec::rmsexpand($name))) {
           # It's got its own suffix, so we'll have to figure out the type
-          if    ($test =~ /(?:$so|exe)$/i)      { $type = 'sh'; }
-          elsif ($test =~ /(?:$lib_ext|olb)$/i) { $type = 'olb'; }
+          if    ($test =~ /(?:$so|exe)$/i)      { $type = 'SHR'; }
+          elsif ($test =~ /(?:$lib_ext|olb)$/i) { $type = 'OLB'; }
           elsif ($test =~ /(?:$obj_ext|obj)$/i) {
             warn "Note (probably harmless): "
                         ."Plain object file $test found in library list\n";
-            $type = 'obj';
+            $type = 'OBJ';
           }
           else {
             warn "Note (probably harmless): "
                         ."Unknown library type for $test; assuming shared\n";
-            $type = 'sh';
+            $type = 'SHR';
           }
         }
         elsif (-f ($test = VMS::Filespec::rmsexpand($name,$so))      or
                -f ($test = VMS::Filespec::rmsexpand($name,'.exe')))     {
-          $type = 'sh';
+          $type = 'SHR';
           $name = $test unless $test =~ /exe;?\d*$/i;
         }
         elsif (not length($ctype) and  # If we've got a lib already, don't bother
                ( -f ($test = VMS::Filespec::rmsexpand($name,$lib_ext)) or
                  -f ($test = VMS::Filespec::rmsexpand($name,'.olb'))))  {
-          $type = 'olb';
+          $type = 'OLB';
           $name = $test unless $test =~ /olb;?\d*$/i;
         }
         elsif (not length($ctype) and  # If we've got a lib already, don't bother
@@ -405,18 +492,20 @@ sub _vms_ext {
                  -f ($test = VMS::Filespec::rmsexpand($name,'.obj'))))  {
           warn "Note (probably harmless): "
                       ."Plain object file $test found in library list\n";
-          $type = 'obj';
+          $type = 'OBJ';
           $name = $test unless $test =~ /obj;?\d*$/i;
         }
         if (defined $type) {
           $ctype = $type; $cand = $name;
-          last if $ctype eq 'sh';
+          last if $ctype eq 'SHR';
         }
       }
       if ($ctype) { 
-        eval '$' . $ctype . "{'$cand'}++";
-        die "Error recording library: $@" if $@;
+        # This has to precede any other CRTLs, so just make it first
+        if ($cand eq 'VAXCCURSE') { unshift @{$found{$ctype}}, $cand; }  
+        else                      { push    @{$found{$ctype}}, $cand; }
         warn "\tFound as $cand (really $test), type $ctype\n" if $verbose > 1;
+       push @flibs, $name unless $libs_seen{$fullname}++;
         next LIB;
       }
     }
@@ -424,19 +513,14 @@ sub _vms_ext {
                 ."No library found for $lib\n";
   }
 
-  @libs = sort keys %obj;
-  # This has to precede any other CRTLs, so just make it first
-  if ($olb{VAXCCURSE}) {
-    push(@libs,"$olb{VAXCCURSE}/Library");
-    delete $olb{VAXCCURSE};
-  }
-  push(@libs, map { "$_/Library" } sort keys %olb);
-  push(@libs, map { "$_/Share"   } sort keys %sh);
-  $lib = join(' ',@libs);
+  push @fndlibs, @{$found{OBJ}}                      if exists $found{OBJ};
+  push @fndlibs, map { "$_/Library" } @{$found{OLB}} if exists $found{OLB};
+  push @fndlibs, map { "$_/Share"   } @{$found{SHR}} if exists $found{SHR};
+  $lib = join(' ',@fndlibs);
 
   $ldlib = $crtlstr ? "$lib $crtlstr" : $lib;
   warn "Result:\n\tEXTRALIBS: $lib\n\tLDLOADLIBS: $ldlib\n" if $verbose;
-  wantarray ? ($lib, '', $ldlib, '') : $lib;
+  wantarray ? ($lib, '', $ldlib, '', ($give_libs ? \@flibs : ())) : $lib;
 }
 
 1;
@@ -451,20 +535,22 @@ ExtUtils::Liblist - determine libraries to use and how to use them
 
 C<require ExtUtils::Liblist;>
 
-C<ExtUtils::Liblist::ext($self, $potential_libs, $verbose);>
+C<ExtUtils::Liblist::ext($self, $potential_libs, $verbose, $need_names);>
 
 =head1 DESCRIPTION
 
 This utility takes a list of libraries in the form C<-llib1 -llib2
--llib3> and prints out lines suitable for inclusion in an extension
+-llib3> and returns lines suitable for inclusion in an extension
 Makefile.  Extra library paths may be included with the form
 C<-L/another/path> this will affect the searches for all subsequent
 libraries.
 
-It returns an array of four scalar values: EXTRALIBS, BSLOADLIBS,
-LDLOADLIBS, and LD_RUN_PATH.  Some of these don't mean anything
-on VMS and Win32.  See the details about those platform specifics
-below.
+It returns an array of four or five scalar values: EXTRALIBS,
+BSLOADLIBS, LDLOADLIBS, LD_RUN_PATH, and, optionally, a reference to
+the array of the filenames of actual libraries.  Some of these don't
+mean anything unless on Unix.  See the details about those platform
+specifics below.  The list of the filenames is returned only if
+$need_names argument is true.
 
 Dependent libraries can be linked in one of three ways:
 
@@ -490,7 +576,7 @@ below.
 =head2 EXTRALIBS
 
 List of libraries that need to be linked with when linking a perl
-binary which includes this extension Only those libraries that
+binary which includes this extension. Only those libraries that
 actually exist are included.  These are written to a file and used
 when linking perl.
 
@@ -512,7 +598,7 @@ object file.  This list is used to create a .bs (bootstrap) file.
 =head1 PORTABILITY
 
 This module deals with a lot of system dependencies and has quite a
-few architecture specific B<if>s in the code.
+few architecture specific C<if>s in the code.
 
 =head2 VMS implementation
 
@@ -524,7 +610,7 @@ Unix-OS/2 version in several respects:
 =item *
 
 Input library and path specifications are accepted with or without the
-C<-l> and C<-L> prefices used by Unix linkers.  If neither prefix is
+C<-l> and C<-L> prefixes used by Unix linkers.  If neither prefix is
 present, a token is considered a directory to search if it is in fact
 a directory, and a library to search for otherwise.  Authors who wish
 their extensions to be portable to Unix or OS/2 should use the Unix
@@ -535,7 +621,7 @@ prefixes, since the Unix-OS/2 version of ext() requires them.
 Wherever possible, shareable images are preferred to object libraries,
 and object libraries to plain object files.  In accordance with VMS
 naming conventions, ext() looks for files named I<lib>shr and I<lib>rtl;
-it also looks for I<lib>lib and libI<lib> to accomodate Unix conventions
+it also looks for I<lib>lib and libI<lib> to accommodate Unix conventions
 used in some ported software.
 
 =item *
@@ -571,16 +657,39 @@ Unix-OS/2 version in several respects:
 
 =item *
 
+If C<$potential_libs> is empty, the return value will be empty.
+Otherwise, the libraries specified by C<$Config{perllibs}> (see Config.pm)
+will be appended to the list of C<$potential_libs>.  The libraries
+will be searched for in the directories specified in C<$potential_libs>,
+C<$Config{libpth}>, and in C<$Config{installarchlib}/CORE>.
+For each library that is found,  a space-separated list of fully qualified
+library pathnames is generated.
+
+=item *
+
 Input library and path specifications are accepted with or without the
-C<-l> and C<-L> prefices used by Unix linkers.  C<-lfoo> specifies the
-library C<libfoo.lib> (unless C<foo> already starts with C<lib>), and
-C<-Ls:ome\dir> specifies a directory to look for the libraries that follow.
-If neither prefix is present, a token is considered a directory to search
-if it is in fact a directory, and a library to search for otherwise.  The
-C<$Config{lib_ext}> suffix will be appended to any entries that are not
-directories and don't already have the suffix.  Authors who wish their
-extensions to be portable to Unix or OS/2 should use the Unix prefixes,
-since the Unix-OS/2 version of ext() requires them.
+C<-l> and C<-L> prefixes used by Unix linkers.
+
+An entry of the form C<-La:\foo> specifies the C<a:\foo> directory to look
+for the libraries that follow.
+
+An entry of the form C<-lfoo> specifies the library C<foo>, which may be
+spelled differently depending on what kind of compiler you are using.  If
+you are using GCC, it gets translated to C<libfoo.a>, but for other win32
+compilers, it becomes C<foo.lib>.  If no files are found by those translated
+names, one more attempt is made to find them using either C<foo.a> or
+C<libfoo.lib>, depending on whether GCC or some other win32 compiler is
+being used, respectively.
+
+If neither the C<-L> or C<-l> prefix is present in an entry, the entry is
+considered a directory to search if it is in fact a directory, and a
+library to search for otherwise.  The C<$Config{lib_ext}> suffix will
+be appended to any entries that are not directories and don't already have
+the suffix.
+
+Note that the C<-L> and C<-l> prefixes are B<not required>, but authors
+who wish their extensions to be portable to Unix or OS/2 should use the
+prefixes, since the Unix-OS/2 version of ext() requires them.
 
 =item *
 
@@ -589,21 +698,27 @@ not handle object files in the place of libraries.
 
 =item *
 
-If C<$potential_libs> is empty, the return value will be empty.
-Otherwise, the libraries specified by C<$Config{libs}> (see Config.pm)
-will be appended to the list of C<$potential_libs>.  The libraries
-will be searched for in the directories specified in C<$potential_libs>
-as well as in C<$Config{libpth}>. For each library that is found,  a
-space-separated list of fully qualified library pathnames is generated.
-You may specify an entry that matches C</:nodefault/i> in
-C<$potential_libs> to disable the appending of default libraries
-found in C<$Config{libs}> (this should be only needed very rarely).
+Entries in C<$potential_libs> beginning with a colon and followed by
+alphanumeric characters are treated as flags.  Unknown flags will be ignored.
+
+An entry that matches C</:nodefault/i> disables the appending of default
+libraries found in C<$Config{perllibs}> (this should be only needed very rarely).
+
+An entry that matches C</:nosearch/i> disables all searching for
+the libraries specified after it.  Translation of C<-Lfoo> and
+C<-lfoo> still happens as appropriate (depending on compiler being used,
+as reflected by C<$Config{cc}>), but the entries are not verified to be
+valid files or directories.
+
+An entry that matches C</:search/i> reenables searching for
+the libraries specified after it.  You can put it at the end to
+enable searching for default libraries specified by C<$Config{perllibs}>.
 
 =item *
 
 The libraries specified may be a mixture of static libraries and
 import libraries (to link with DLLs).  Since both kinds are used
-pretty transparently on the win32 platform, we do not attempt to
+pretty transparently on the Win32 platform, we do not attempt to
 distinguish between them.
 
 =item *
@@ -622,6 +737,44 @@ C<$potential_libs> could be (literally):
 Note how the first and last entries are protected by quotes in order
 to protect the spaces.
 
+=item *
+
+Since this module is most often used only indirectly from extension
+C<Makefile.PL> files, here is an example C<Makefile.PL> entry to add
+a library to the build process for an extension:
+
+        LIBS => ['-lgl']
+
+When using GCC, that entry specifies that MakeMaker should first look
+for C<libgl.a> (followed by C<gl.a>) in all the locations specified by
+C<$Config{libpth}>.
+
+When using a compiler other than GCC, the above entry will search for
+C<gl.lib> (followed by C<libgl.lib>).
+
+If the library happens to be in a location not in C<$Config{libpth}>,
+you need:
+
+        LIBS => ['-Lc:\gllibs -lgl']
+
+Here is a less often used example:
+
+        LIBS => ['-lgl', ':nosearch -Ld:\mesalibs -lmesa -luser32']
+
+This specifies a search for library C<gl> as before.  If that search
+fails to find the library, it looks at the next item in the list. The
+C<:nosearch> flag will prevent searching for the libraries that follow,
+so it simply returns the value as C<-Ld:\mesalibs -lmesa -luser32>,
+since GCC can use that value as is with its linker.
+
+When using the Visual C compiler, the second item is returned as
+C<-libpath:d:\mesalibs mesa.lib user32.lib>.
+
+When using the Borland compiler, the second item is returned as
+C<-Ld:\mesalibs mesa.lib user32.lib>, and MakeMaker takes care of
+moving the C<-Ld:\mesalibs> to the correct place in the linker
+command line.
+
 =back