conda-forge.github.io icon indicating copy to clipboard operation
conda-forge.github.io copied to clipboard

Add documentation on Perl packages.

Open ssurbhi560 opened this issue 2 years ago • 5 comments

Closes #1536

PR Checklist:

  • [x] make all edits to the docs in the src directory, not in docs or in the html files
  • [x] note any issues closed by this PR with closing keywords
  • [x] put any other relevant information below

ssurbhi560 avatar Jun 27 '22 11:06 ssurbhi560

Thanks for taking the time to review the PR @jmarshall and @nsoranzo! :) I will update it as you suggested.

ssurbhi560 avatar Jun 29 '22 10:06 ssurbhi560

This is good as far as it goes, and IMHO would usefully be merged as such.

Currently in bioconda there are 315 Perl packages using ExtUtils::MakeMaker and 119 using Module::Build. If the statistics for conda-forge are similar, it would be useful to add the corresponding advice for configuring Module::Build as well.

jmarshall avatar Jun 29 '22 10:06 jmarshall

With respect, the information that has been added about Module::Build is entirely not what this document's audience needs to know. The reader is packaging an existing Perl module that has already chosen between the two systems, so they already know what they are and don't need to know the pros and cons of each.

What this audience does need from this document is to be told the Module::Build equivalent of the recommended perl Makefile.PL INSTALLDIRS=vendor NO_PERLLOCAL=1 NO_PACKLIST=1 ExtUtils::MakeMaker incantation.

jmarshall avatar Jul 07 '22 21:07 jmarshall

Thanks John for letting me know about this. I am still quite new to this and all this was something I didn't know, so I ended up adding everything I found useful. But as you said this documentation would be used by someone already well versed with Perl packages so it would probably be irrelevant for them.

So, now, @kathatherine and @jmarshall what would you suggest - should I remove the all the information about Module::Build or may keep a sentence describing what Module::Build is and examples of recipes using perl-module-build?

ssurbhi560 avatar Jul 11 '22 10:07 ssurbhi560

@ssurbhi560 At least one link to some information on Module::Build would be good, in my opinion, just for people who are newer to it. It could be useful to someone, even if the audience for this section is people who are more experienced in Purl. But as @jmarshall says, the most important thing is explaining how users can use Module::Build in the build section of their yaml instead of ExtUtils::MakeMaker. So a section like lines 1561 - 1574, just below that section, with the necessary Module::Build information instead. Am I correct, John?

kathatherine avatar Jul 11 '22 15:07 kathatherine