NAME

       Debian::Debhelper::Dh_components - Data for Debian components handling

VERSION

       This document describes Debian::Debhelper::Dh_components version 0.3

SYNOPSIS

           use Debian::Debhelper::Dh_components;
           my $components = Debian::Debhelper::Dh_components->new;

DESCRIPTION

       Back-end for "dh_components" command. The module has three tasks:

       merging of documents (not implemented);
       merging of "substvar" merging (not implemented);
       cascading implementation of component build process (not implemented).

INTERFACE

   new
       This is a constructor which takes a number of named arguments.

       "dir"
           This  is  the  path  to a components directory. Typically this will just be "debian/components". This
           argument is mandatory.

       "package"
           This is the package name and is mandatory.

       "build_stages"
           If this argument, an array reference, is given it will override the normal sequence of build stages.

       "component"
           If this parameter, an array reference, is set only those components listed will be considered.

       "rules_locations"
           If this parameter, an array reference, is given it will override the normal location of  build  stage
           scripts.

   build_stages
       This  returns the build stages in the order in which they should occur: copy, patch, config, build, test,
       install.

   directory
       This returns the directory name that was passed to the constructor.

   package
       This returns the package name that was passed to the constructor.

   components
       This returns an array listing the components found in that component directory.

   script
       This method takes two arguments, the component and the build stage, and returns the script that needs  to
       be run.

   build_copyright
       If  this  method  finds  a  file  "copyright.in"  in the components directory, it merges in any component
       copyright files in the component directories and writes the result to the specified location.

   substvars
       This method returns the appropriate "substvar" variables parsed from "control" files  in  each  component
       sub-directory as a hash reference.

CONFIGURATION AND ENVIRONMENT

       Debian::Debhelper::Dh_components requires no configuration files or environment variables.

DEPENDENCIES

       None.

BUGS AND LIMITATIONS

       This module is only really intended for Debian and related systems.

       No bugs have been reported.

       Please  report  any  bugs  or  feature  requests  to "bug-debian-debhelper-dh_components@rt.cpan.org", or
       through the web interface at <http://rt.cpan.org>.

AUTHOR

       Nicholas Bamber  "<nicholas@periapt.co.uk>"

LICENCE AND COPYRIGHT

       Copyright (c) 2010, Nicholas Bamber "<nicholas@periapt.co.uk>". All rights reserved.

       This module is free software; you can redistribute it and/or modify it  under  the  same  terms  as  Perl
       itself. See perlartistic.

DISCLAIMER OF WARRANTY

       BECAUSE  THIS  SOFTWARE  IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR THE SOFTWARE, TO THE EXTENT
       PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS  AND/OR  OTHER
       PARTIES  PROVIDE  THE  SOFTWARE  "AS  IS"  WITHOUT  WARRANTY  OF  ANY  KIND, EITHER EXPRESSED OR IMPLIED,
       INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND  FITNESS  FOR  A  PARTICULAR
       PURPOSE.  THE  ENTIRE  RISK  AS  TO  THE  QUALITY AND PERFORMANCE OF THE SOFTWARE IS WITH YOU. SHOULD THE
       SOFTWARE PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR, OR CORRECTION.

       IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER,  OR  ANY
       OTHER  PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE THE SOFTWARE AS PERMITTED BY THE ABOVE LICENCE, BE LIABLE
       TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING  OUT  OF
       THE  USE  OR  INABILITY  TO  USE  THE  SOFTWARE  (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING
       RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE SOFTWARE  TO  OPERATE
       WITH  ANY OTHER SOFTWARE), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH
       DAMAGES.

perl v5.20.2                                       2015-06-07              Debian::Debhelper::Dh_components(3pm)