Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

Where to put non-essential .pl files in a distribution?

Tags:

perl

I would like to include a few additional .pl files in my CPAN module. These files are not essential to use the module, but are provide useful functionality/glue when the module is used in some common frameworks and applications.

Currently, I just include the .pl files in a "extras" directory of the distribution. This has the drawback that the files are not installed on make install. Is there a way to include them in the installation and where should they go? (They aren't executables and don't belong in "bin".) Would "share" make sense? Or are these kinds of files usually just not installed and it is left to the user to get them out of the .tgz archive and use as needed?

I use Dist::Zilla to manage my distribution.

like image 213
Davor Cubranic Avatar asked Apr 03 '14 19:04

Davor Cubranic


1 Answers

I would suggest the following:

  • If they're actual complete programs or are almost complete, polish then up and make them standalone items that could go into /bin with POD of their own.
  • If they're utility glue, make a ::Utils module for them to live in and document their usage.
  • If these are useful code snippets but not something you can install somewhere or are sample usages or handy idioms, create a ::Cookbook all-POD module and include them there with the appropriate illuminating explanation for each one.
like image 69
Joe McMahon Avatar answered Nov 15 '22 06:11

Joe McMahon