Gentoo Development Guide

PERL-MODULE.ECLASS

Section: portage (5)
Updated: Mar 2015
Index Return to Main Contents

NAME

perl-module.eclass - eclass for perl modules

DESCRIPTION

The perl-module eclass is designed to allow easier installation of perl modules, and their incorporation into the Gentoo Linux system.

FUNCTIONS

perl-module_src_unpack perl-module_src_unpack

Unpack the ebuild tarball(s). This function is to be called during the ebuild src_unpack() phase.

perl-module_src_prepare 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 perl-module_src_configure

Configure the ebuild sources. This function is to be called during the ebuild src_configure() phase.

perl-module_src_prep perl-module_src_prep

Configure the ebuild sources (bis).

This function is still around for historical reasons and will be soon deprecated.

Please use the function above instead, perl-module_src_configure().

perl-module_src_compile perl-module_src_compile

Compile the ebuild sources. This function is to be called during the ebuild src_compile() phase.

perl-module_src-test perl-module_src_test()

This code attempts to work out your threadingness from MAKEOPTS and apply them to Test::Harness.

If you want more verbose testing, set TEST_VERBOSE=1 in your bashrc | /etc/portage/make.conf | ENV

or ebuild writers: If you wish to enable default tests w/ 'make test' ,

SRC_TEST="do"

If you wish to have threads run in parallel ( using the users makeopts ) all of the following have been tested to work.

SRC_TEST="do parallel"
SRC_TEST="parallel"
SRC_TEST="parallel do"
SRC_TEST=parallel

perl-module_src_install perl-module_src_install

Install a Perl ebuild. This function is to be called during the ebuild src_install() phase.

perl-module_pkg_setup perl-module_pkg_setup

This function was to be called during the pkg_setup() phase. Deprecated, to be removed. Where it is called, place a call to perl_set_version instead.

perl-module_pkg_preinst perl-module_pkg_preinst

This function was to be called during the pkg_preinst() phase. Deprecated, to be removed. Where it is called, place a call to perl_set_version instead.

perl-module_pkg_postinst 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_prerm perl-module_pkg_prerm

This function was to be called during the pkg_prerm() phase. It does not do anything. Deprecated, to be removed.

perl-module_pkg_postrm 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.

perl_set_version perl_set_version

Extract version information and installation paths from the current Perl interpreter.

This sets the following variables: PERL_VERSION, SITE_ARCH, SITE_LIB, ARCH_LIB, VENDOR_LIB, VENDOR_ARCH

This function used to be called perlinfo as well.

perlinfo perlinfo

This function is deprecated.

Please use the function above instead, perl_set_version().

perl_delete_localpod perl_delete_localpod

Remove stray perllocal.pod files in the temporary install directory D.

This function used to be called fixlocalpod as well.

fixlocalpod fixlocalpod

This function is deprecated.

Please use the function above instead, perl_delete_localpod().

perl_fix_osx_extra perl_fix_osx_extra

Look through ${S} for AppleDouble encoded files and get rid of them.

perl_delete_module_manpages perl_delete_module_manpages

Bump off manpages installed by the current module such as *.3pm files as well as empty directories.

perl_delete_packlist perl_delete_packlist

Look through ${D} for .packlist files, empty .bs files and empty directories, and get rid of items found.

perl_remove_temppath perl_remove_temppath

Look through ${D} for text files containing the temporary installation folder (i.e. ${D}). If the pattern is found (i.e. " text"), replace it with `/'.

perl_rm_files perl_rm_files "file_1" "file_2"

Remove certain files from a Perl release and remove them from the MANIFEST while we're there.

Most useful in src_prepare for nuking bad tests, and is highly recommended for any tests like 'pod.t', 'pod-coverage.t' or 'kwalitee.t', as what they test is completely irrelevant to end users, and frequently fail simply because the authors of Test::Pod... changed their recommendations, and thus failures are only useful feedback to Authors, not users.

Removing from MANIFEST also avoids needless log messages warning users about files "missing from their kit".

perl_link_duallife_scripts perl_link_duallife_scripts

Moves files and generates symlinks so dual-life packages installing scripts do not lead to file collisions. Mainly for use in pkg_postinst and pkg_postrm, and makes only sense for perl-core packages.

AUTHORS

Seemant Kulleen <seemant@gentoo.org>

MAINTAINERS

perl@gentoo.org

REPORTING BUGS

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

FILES

/usr/portage/eclass/perl-module.eclass

This document was created by man2html, using the manual pages.
Time: 03:25:05 GMT, March 06, 2015