Re: [Module-build-general] [comments please] module installation paths

[Uri G. <ur...@st...>]

>>>>> "KW" == Ken Williams <ke...@ma...> writes:

  KW> =item script

  KW> Programs written in pure Perl.  Try to make these as small as possible
  KW> - put the code into modules whenever possible.

why do scripts have to be small? is there a real size limit? if not, you
shouldn't editorialize on how to write scripts. some scripts just need
to be long or not use many modules.

  KW> =item bin

  KW> "Architecture-dependent" programs, i.e. compiled C code or something.
  KW> Pretty rare to see this in a perl distribution, but it happens.

xs (or now inline::) code isn't that rare. i would drop the last
line. you could make a comment about these programs use XS or
inline::c/cpp or other cpu architecture dependent stuff. also what
compiler will be chosen for that? i didn't see any override options in
this doc.

  KW> =item bindoc

  KW> Documentation for the stuff in C<script> and C<bin>.  Usually
  KW> generated from the POD in those files.  Under Unix, these are manual
  KW> pages belonging to the 'man1' category.

can the pod be generated from another command? stem will have a stem2pod
command that needs to be run since some of the pod is autogenerated from
attribute specifications.

  KW> The default destinations for these installable things come from
  KW> entries in your system's C<Config.pm>.  You can select from three
  KW> different sets of default locations by setting the C<installdirs>
  KW> parameter as follows:

this needs to be explained a litte more i think. make it clear in the
text that the choices are core/site/vendor and not lib/arch/etc/. the
chart shows that but it could be more explicit. never underestimate the
dumbnitude of people doing cpan installs. :)


  KW>                            'installdirs' set to:
  KW>                     core          site                vendor

  KW>                uses the following defaults from Config.pm:

  KW>   lib     => installprivlib  installsitelib      installvendorlib
  KW>   arch    => installarchlib  installsitearch     installvendorarch
  KW>   script  => installscript   installsitebin      installvendorbin
  KW>   bin     => installbin      installsitebin      installvendorbin
  KW>   libdoc  => installman3dir  installsiteman3dir  installvendorman3dir
  KW>   bindoc  => installman1dir  installsiteman1dir  installvendorman1dir


  KW>   perl Build.PL destdir=/tmp/foo

  KW> or

  KW>   Build install destdir=/tmp/foo


this is the first time you show how these params are set. you should
have an example at the top and examples of each param as you get to
them. when i first read this i was asking 'where do i set these? in the
Build.PL or what? 


overall, i like it a lot. it is the best high level picture of build.pl
i have seen so far.

uri

-- 
Uri Guttman  ------  ur...@st...  -------- http://www.stemsystems.com
--Perl Consulting, Stem Development, Systems Architecture, Design and Coding-
Search or Offer Perl Jobs  ----------------------------  http://jobs.perl.org