PERL-MODULE.ECLASS

Section: eclass-manpages (5)
Updated: Apr 2024
Index Return to Main Contents

NAME

perl-module.eclass - eclass for installing Perl module distributions

DESCRIPTION

The perl-module eclass is designed to allow easier installation of Perl module distributions, and their incorporation into the Gentoo Linux system. All exported functions from perl-functions.eclass (inherited here) explicitly also belong to the interface of perl-module.eclass. If your package does not use any Perl-specific build system (as, e.g., ExtUtils::MakeMaker or Module::Build), we recommend to use perl-functions.eclass instead.

SUPPORTED EAPIS

7 8

TRANSITIVELY PROVIDED ECLASSES

perl-functions

FUNCTIONS

perl-module_src_prepare: Get the ebuild sources ready. This function is to be called during the ebuild src_prepare() phase.
perl-module_src_configure: Configure the ebuild sources. This function is to be called during the ebuild src_configure() phase.
perl-module_src_compile: Compile the ebuild sources. This function is to be called during the ebuild src_compile() phase.
perl-module_src_test: This code attempts to work out your threadingness and runs tests according to the settings of DIST_TEST using Test::Harness.
perl-module_src_install: Install a Perl ebuild. This function is to be called during the ebuild src_install() phase.
perl-module_pkg_postinst: This function is to be called during the pkg_postinst() phase. It only does useful things for the perl-core category, where it handles the file renaming and symbolic links that prevent file collisions for dual-life packages installing scripts. In any other category it immediately exits.
perl-module_pkg_postrm: This function is to be called during the pkg_postrm() phase. It only does useful things for the perl-core category, where it handles the file renaming and symbolic links that prevent file collisions for dual-life packages installing scripts. In any other category it immediately exits.

ECLASS VARIABLES

GENTOO_DEPEND_ON_PERL: This variable controls whether a runtime and build time dependency on dev-lang/perl is automatically added by the eclass. It defaults to yes. Set to no to disable, set to noslotop to add a perl dependency without slot operator. All packages installing into the vendor_perl path must use yes here. (EAPI=8 and later) Also adds a test useflag, a use-conditional build time dependency on virtual/perl-Test-Simple, and the required RESTRICT setting.
DIST_NAME: This variable provides a way to override PN for the calculation of S, SRC_URI, and HOMEPAGE. If unset, defaults to PN.
DIST_VERSION: This variable provides a way to override PV for the calculation of S and SRC_URI. Use it to provide the non-normalized, upstream version number. If unset, defaults to PV.
DIST_A_EXT: This variable provides a way to override the distfile extension for the calculation of SRC_URI. If unset, defaults to tar.gz.
DIST_A: This variable provides a way to override the distfile name for the calculation of SRC_URI. If unset, defaults to ${DIST_NAME}-${DIST_VERSION}.${DIST_A_EXT}.
DIST_AUTHOR: This variable sets the module author name for the calculation of SRC_URI.
DIST_SECTION: This variable sets the module section for the calculation of SRC_URI. Only required in rare cases for very special snowflakes.
DIST_EXAMPLES (SET BEFORE INHERIT): This Bash array allows passing a list of example files to be installed in /usr/share/doc/${PF}/examples. If set before inherit, automatically adds a use-flag examples, if not you'll have to add the useflag in your ebuild. Examples are installed only if the useflag examples exists and is activated.
DIST_WIKI: (EAPI=8 and later) This variable can be set to contain space-separated keywords corresponding to article sections in a maintenance notes wiki article. If a keyword is set, an ebuild phase can output a message and a link to the wiki. Current keywords as of EAPI=8 are: * features: Notes about additional dependencies for optional features * tests: Notes about additional dependencies and preparations needed for testing
DIST_MAKE = "* ]]; then: (EAPI=8 and later) This Bash array contains parameters to the make call from ExtUtils::MakeMaker. Replaces mymake in EAPI=7 and earlier. Defaults to ( OPTIMIZE="${CFLAGS}" )
DIST_TEST: Variable that controls if tests are run in the test phase at all, and if yes under which conditions. If unset, defaults to "do parallel" If neither "do" nor "parallel" is recognized, tests are skipped. The following space-separated keywords are recognized:
  do       : run tests
  parallel : run tests in parallel
  verbose  : increase test verbosity
  network  : do not try to disable network tests
DIST_TEST_OVERRIDE (USER VARIABLE): Variable that controls if tests are run in the test phase at all, and if yes under which conditions. It is intended for use in make.conf or the environment by ebuild authors during testing, and accepts the same values as DIST_TEST. If set, it overrides DIST_TEST completely. DO NOT USE THIS IN EBUILDS!

AUTHORS

Seemant Kulleen <seemant@gentoo.org>
Andreas K. Hüttel <dilfridge@gentoo.org>

MAINTAINERS

perl@gentoo.org

REPORTING BUGS

Please report bugs via https://bugs.gentoo.org/

FILES

perl-module.eclass

This document was created by man2html, using the manual pages.
Time: 03:27:01 GMT, April 23, 2024