bionic (3) Debian::LicenseReconcile::Filter::Rules.3pm.gz

NAME

       Debian::LicenseReconcile::Filter::Rules - applies licensecheck to get data

VERSION

       Version 0.14

SYNOPSIS

           use Debian::LicenseReconcile::Filter::Rules;

           my $filter = Debian::LicenseReconcile::Filter::Rules->new(
               directory=>'.',
               files_remaining=>[....],
               config=>[....],
           );
           my @info = $filter->get_info();

SUBROUTINES/METHODS

   get_info
       Returns a list of hash references describing copyright and license information that should be checked
       against the copyright target. The results returned are those obtained by applying the rules in the config
       file in sequence.  Each rule might have the fields as discussed in Debian::LicenseReconcile::Filter.

       In addition the following fields are supported:

       License (optional) - Specifies the exact license value. If not set the license will be obtained from
       licensecheck.
       Copyright (optional) - Specifies the exact copyright value. If not set the copyright will be obtained
       from licensecheck.
       CopyrightExtract (optional) - Gives a regular expression that is used to get copyright data from the file
       contents. Each captured value will be a line assumed to contain a sequence of years and the copyright
       holder. The regular expression will be enclosed in "m{....}xms". Also it supports an additional shorthand
       "\Y" which represents a year followed by various separators.
       CopyrightClean (optional) - Gives a regular expression that is replaced in the copyright string by a
       single space.

AUTHOR

       Nicholas Bamber, "<nicholas at periapt.co.uk>"

LICENSE AND COPYRIGHT

       Copyright 2012, 2015, Nicholas Bamber "<nicholas at periapt.co.uk>".

       This program is free software; you can redistribute it and/or modify it under the terms of either: the
       GNU General Public License as published by the Free Software Foundation; or the Artistic License.

       See http://dev.perl.org/licenses/ for more information.