Skip to content

Commit

Permalink
Added USAGE notes to Devel::CheckLib and Devel::CheckOS modules
Browse files Browse the repository at this point in the history
  • Loading branch information
drhyde committed Jun 2, 2008
1 parent dc74ade commit 51c4574
Showing 1 changed file with 8 additions and 3 deletions.
11 changes: 8 additions & 3 deletions lib/Devel/CheckLib.pm
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# $Id: CheckLib.pm,v 1.23 2008/05/23 19:06:04 drhyde Exp $
# $Id: CheckLib.pm,v 1.24 2008/06/02 12:49:50 drhyde Exp $

package Devel::CheckLib;

Expand Down Expand Up @@ -30,8 +30,6 @@ library and its headers are available.
=head1 SYNOPSIS
# in a Makefile.PL or Build.PL
use lib qw(inc);
use Devel::CheckLib;
check_lib_or_exit( lib => 'jpeg', header => 'jpeglib.h' );
Expand All @@ -40,6 +38,13 @@ library and its headers are available.
# or prompt for path to library and then do this:
check_lib_or_exit( lib => 'jpeg', libpath => $additional_path );
=head1 USING IT IN Makefile.PL or Build.PL
If you want to use this from Makefile.PL or Build.PL, do
not simply copy the module into your distribution as this may cause
problems when PAUSE and search.cpan.org index the distro. Instead, use
the use-devel-checklib script.
=head1 HOW IT WORKS
You pass named parameters to a function, describing to it how to build
Expand Down

0 comments on commit 51c4574

Please sign in to comment.