Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse code

Improve POD, bump version to 0.030_001 for dev release.

  • Loading branch information...
commit be9c2712d094868a4fbe26996a8174f325087c8b 1 parent 1f81def
Joel Berger authored October 18, 2011
1  Build.PL
@@ -49,6 +49,7 @@ my $builder = $builder_class->new(
49 49
     'Force'    => {default => 0},
50 50
     'ShareDir' => {default => 0},
51 51
     'Version'  => {type => '=s', default => 0},
  52
+    #'GSLCheck' => {default => 0},
52 53
   },
53 54
   share_dir   => 'share_dir',
54 55
   meta_merge => {
3  Changes
@@ -2,6 +2,9 @@ Revision history for Perl extension Alien::GSL.
2 2
 
3 3
 0.03 
4 4
 	- uses Module::Build
  5
+	- has platform specific instruction
  6
+		- download and compile when possible
  7
+		- download precompiled library on MSWindows
5 8
 
6 9
 0.02  Mon Aug 1
7 10
 	- version incremented as upload to PAUSE wasn't complete
61  lib/Alien/GSL.pm
@@ -3,7 +3,7 @@ package Alien::GSL;
3 3
 use strict;
4 4
 use warnings;
5 5
 
6  
-our $VERSION = 0.03;
  6
+our $VERSION = 0.030_001;
7 7
 $VERSION = eval $VERSION;
8 8
 
9 9
 use Carp;
@@ -42,18 +42,35 @@ L<Alien::GSL> uses the L<Module::Build> system for installation. Therefore the u
42 42
 
43 43
 It will try (at a minimum) to detect if the GSL library is installed on the local system. If not it will attempt, if possible, to download/build/install it. This build process will likely require the C<Build> script to be run with root privaledges. Future versions of L<Alien::GSL> may try to avoid this problem. This is not necessary if the library is already installed on the system.
44 44
 
45  
-=head2 PerlBrew/CPANminus
  45
+=head2 Build Flags
46 46
 
47  
-If using L<perlbrew> to manage local installations of the Perl interpreter, I believe that 
  47
+When running C<./Build>, certain command line flags may be passed, i.e. C<./Build --ShareDir>.
48 48
 
49  
- cpanm --sudo Alien::GSL
  49
+=over
  50
+
  51
+=item C<--Version 1.15>
  52
+
  53
+Specify a version of the GSL library to be installed (here C<1.15>). Without this flag, the highest (read: newest) version available will be used. If a supplied version cannot be found, the install will croak.
  54
+
  55
+=item C<--ShareDir>
  56
+
  57
+When this flag is given, C<File::ShareDir> will be used, even if a system install was possible (i.e. on Linux as root).
  58
+
  59
+=item C<--Force>
50 60
 
51  
-will work more correctly than either of
  61
+When this flad is given, action will be taken, even if a system install of GSL is found. Note that this flag is not needed if C<--ShareDir> is used.
52 62
 
53  
- sudo cpanm Alien::GSL
54  
- sudo cpan Alien::GSL
  63
+=item C<--Dir dir>
  64
+
  65
+Specify a directory (here C<dir>) to download and build the library. This directory will not be removed later.
  66
+
  67
+=item C<--TempDir /dev/shm>
  68
+
  69
+Specify a location for the temporary (here C</dev/shm/>, the ramdisk on Ubuntu Linux).
  70
+
  71
+=back
55 72
 
56  
-=head1 EXPORTS
  73
+=head1 NO EXPORTS
57 74
 
58 75
 Currently this module does not export any functions or variables. Use instead the fully qualified symbol name, i.e. C<Alien::GSL::gsl_version()>.
59 76
 
@@ -65,7 +82,7 @@ This module is in an alpha state. The author hopes that major functionality will
65 82
 
66 83
 These functions are basically a functional interface to the C<gsl-config> utility command.
67 84
 
68  
-=head2 gsl_version
  85
+=head2 C<gsl_version>
69 86
 
70 87
 Takes no options, returns the version number of the installed GSL library.
71 88
 
@@ -89,7 +106,7 @@ sub gsl_version {
89 106
   return $version;
90 107
 }
91 108
 
92  
-=head2 require_gsl_version( [$version] );
  109
+=head2 C<require_gsl_version( [$version] )>
93 110
 
94 111
 A wrapper around C<gsl_version()> which (optionally) takes a number specifying a minimum GSL version, returns the GSL version if it is greater than or equal to that specified. Returns zero otherwise. May also be called with zero as the version parameter, or no parameter at all, in which case the behavior is the same as C<gsl_version()>.
95 112
 
@@ -114,7 +131,7 @@ sub require_gsl_version {
114 131
 
115 132
 }
116 133
 
117  
-=head2 gsl_prefix
  134
+=head2 C<gsl_prefix>
118 135
 
119 136
 Takes no options, returns the "GSL installation prefix".
120 137
 
@@ -138,7 +155,7 @@ sub gsl_prefix {
138 155
   return $prefix;
139 156
 }
140 157
 
141  
-=head2 gsl_libs( [opts hash or hash reference] )
  158
+=head2 C<gsl_libs( [opts hash or hash reference] )>
142 159
 
143 160
 Takes an optional hash or hash reference, returns "library linking information". A hash key C<cblas>, whose value is false will return the "library linking information, without cblas", though by default the cblas information is included.
144 161
 
@@ -186,7 +203,7 @@ sub gsl_libs {
186 203
   return $libs;
187 204
 }
188 205
 
189  
-=head2 gsl_cflags
  206
+=head2 C<gsl_cflags>
190 207
 
191 208
 Takes no options, returns the "pre-processor and compiler flags".
192 209
 
@@ -214,6 +231,24 @@ sub gsl_cflags {
214 231
   return $cflags;
215 232
 }
216 233
 
  234
+=head1 TODO
  235
+
  236
+=over
  237
+
  238
+=item *
  239
+
  240
+Implement C<--GSLCheck> flag to run C<make check> during build.
  241
+
  242
+=item *
  243
+
  244
+Improve tests for C<Alien::GSL>
  245
+
  246
+=item *
  247
+
  248
+Are tests possible for C<Module::Build> subclasses?
  249
+
  250
+=back
  251
+
217 252
 =head1 SEE ALSO
218 253
 
219 254
 =over

0 notes on commit be9c271

Please sign in to comment.
Something went wrong with that request. Please try again.