Section 3: library functions
Lintian::Util – Lintian utility functions Synopsis use Lintian::Util qw(normalize_pkg_path); my $path = normalize_pkg_path(‘usr/bin/’, ‘../lib/git-core/git-pull’); if (defined $path) { # … }DescriptionThis module contains a number of utility subs that are nice to have, but on their own did not warrant their own module. Most subs are imported only on request. Variables$PKGNAME_REGEX Regular expression that matches…
Lintian::Unpacker — Job handler to unpack collections Synopsis use Lintian::DepMap::Properties; use Lintian::Unpacker; my $done = 1; my $joblimit = 4; my $collmap = Lintian::DepMap::Properties->new; my %requested = ( ‘debfiles’ => 1 ); # Initialise $collmap with the collections and their relations # – Each node in $collmap should an instance of L::CollScript # as property….
Lintian::Tutorial::WritingTests — Short tutorial on writing tests SynopsisWarning: This document may be out of date. This document attempts to be a short / quick tutorial to the Lintian test suite from a test-writer’s perspective. As such, it will only cover the standard type of tests (from the “tests” suite). The guide will involve writing a…
Lintian::Tutorial::WritingChecks — Writing checks for Lintian SynopsisWarning: This tutorial may be outdated. This guide will quickly guide you through the basics of writing a Lintian check. Most of the work is in writing the two files: checks/<my-check>.pm checks/<my-check>.descAnd then either adding a Lintian profile or extending an existing one. DescriptionThe basics of writing a check…
Lintian::Tutorial::TestSuite — Quick intro to running the Lintian testsuite SynopsisWarning: This document may be out of date. This guide will quickly introduce you to running the Lintian test suite and some tricks. The Lintian test suite is fairly large and accordingly it can take a substantial amount of time to run. To speed up development,…
Lintian::Tutorial — The newcomer’s guide to Lintian SynopsisGetting started with lintian in 5 minutes… maybe 10. DescriptionDepending on what you want to work with there are different ways to approach Lintian and its code. • Writing a Lintian check • Running (parts of) the Lintian test suite • Writing new Lintian tests • Understanding Lintian…
Lintian::Tags – Manipulate and output Lintian tags Synopsis my $tags = Lintian::Tags->new; my $proc = Lintian::Processable::Package->new (‘/path/to/file’); $tags->file_start ($proc); $tags->file_overrides (‘/path/to/an/overrides-file’); $tags->tag (‘lintian-tag’, ‘extra tag information’); tag (‘other-lintian-tag’, ‘with some extra data’); tag (‘third-lintian-tag’); # with no extra). my %overrides = $tags->overrides ($proc); my %stats = $tags->statistics; if ($tags->displayed (‘lintian-tag’)) { # do something if…
Lintian::Tag::Standard – standard tag with arguments concatenated by space Synopsis use Lintian::Tag::Standard;DescriptionProvides a standard tag whose arguments are concatenated by a space. Instance Methods
Lintian::Tag::Override — Representation of a Lintian Override Synopsis use Lintian::Tag::Override; my $data = { ‘comments’ => [‘some’, ‘multi-line’, ‘comments’] }; my $override = Lintian::Tag::Override->new(‘unused-override’, $data); my $comments = $override->comments; if ($override->overrides("some extra") ) { # do something }DescriptionRepresents a Lintian Override. MethodsLintian::Tag::Override->new($tag, $data) Creates a new override for $tag. $data should be a hashref with…
Lintian::Tag::Info – Lintian interface to tag metadata Synopsis my $taginfo = Lintian::Tag::Info->new;DescriptionThis module provides an interface to tag metadata as gleaned from the *.desc files describing the checks. It can be used to retrieve specific metadata elements or to format the tag description. Instance Methodstag original_severity effective_severity check check_type experimental info references aliases load(PATH) Loads…
Lintian::Tag::Bearer — Facilities for objects receiving Lintian tags Synopsis use Moo; use namespace::clean; with(‘Lintian::Tag::Bearer’);DescriptionA class for collecting Lintian tags as they are found Instance Methodstag (ARGS) Store found tags for later processing. tags AuthorOriginally written by Felix Lechner <felix.lechner [at] lease-up.com> for Lintian. See Alsolintian(1)
Lintian::Tag — Common facilities for Lintian tags found and to be issued Synopsis use Moo; use namespace::clean; with ‘Lintian::Tag’;DescriptionCommon facilities for Lintian tags found and to be issued Instance Methodsarguments =item info =item name =item override =item processable hint Calculate the string representation commonly referred to as ‘hint’.AuthorOriginally written by Felix Lechner <felix.lechner [at] lease-up.com>…
Lintian::Spelling — Lintian spell checks shared between multiple scripts Synopsis use Lintian::Spelling qw(check_spelling);DescriptionThis module provides functions to do some Lintian checks that need to be done in multiple places. There are certain low-level checks, such as validating a maintainer name and e-mail address or checking spelling, which apply in multiple situations and should be done…
Lintian::SlidingWindow – Lintian interface to sliding window match Synopsis use Lintian::SlidingWindow; my $sfd = Lintian::SlidingWindow->new(‘<‘,’someevilfile.c’, sub { $_ = lc($_); }); my $window; while ($window = $sfd->readwindow) { if (index($window, ‘evil’) > -1) { if($window =~ m/software \s++ shall \s++ be \s++ used \s++ for \s++ good \s*+ ,?+ \s*+ not \s++ evil/xsim) { #…
Lintian::Reporting::Util – Lintian utility functions Synopsis use Lintian::Reporting::Util qw(load_state_cache find_backlog); my $cache = load_state_cache(‘path/to/state-dir’); my @backlog = find_backlog(‘2.12’, $cache);DescriptionThis module contains a number of utility subs that are nice to have for the reporting framework, but on their own did not warrant their own module. Most subs are imported only on request. Functionsload_state_cache(STATE_DIR) [Reporting tools…
Lintian::Reporting::ResourceManager — A simple resource manager for html_reports Synopsis use Lintian::Reporting::ResourceManager; my $resMan = Lintian::Reporting::ResourceManager->new( ‘html_dir’ => ‘path/to/HTML-root’, ); # Copy the resource $resMan->install_resource(‘path/to/my-image.png’, { install_method => ‘copy’} ); # Move the resource $resMan->install_resource(‘path/to/generated-styles.css’); print ‘Image: ‘ . $resMan->resource_URL(‘my-image.png’), "\n"; print ‘CSS: ‘ . $resMan->resource_URL(‘generated-styles.css’), "\n";DescriptionA simple resource manager for Lintian’s reporting tool, html_reports. Class…
Lintian::Relation::Version – Comparison operators on Debian versions Synopsis print "yes\n" if versions_equal(‘1.0’, ‘1.00’); print "yes\n" if versions_gte(‘1.1’, ‘1.0’); print "no\n" if versions_lte(‘1.1’, ‘1.0’); print "yes\n" if versions_gt(‘1.1’, ‘1.0’); print "no\n" if versions_lt(‘1.1’, ‘1.1’); print "yes\n" if versions_compare(‘1.1’, ‘<=’, ‘1.1’);DescriptionThis module provides five functions for comparing version numbers. The underlying implementation uses "libapt-pkg-perl" to ensure that…
Lintian::Relation – Lintian operations on dependencies and relationships Synopsis my $depends = Lintian::Relation->new(‘foo | bar, baz’); print "yes\n" if $depends->implies(‘baz’); print "no\n" if $depends->implies(‘foo’);DescriptionThis module provides functions for parsing and evaluating package relationship fields such as Depends and Recommends for binary packages and Build-Depends for source packages. It parses a relationship into an internal format…
Lintian::Profile – Profile parser for Lintian Synopsis my $profile = Lintian::Profile->new (‘debian’);DescriptionLintian::Profile handles finding, parsing and implementation of Lintian Profiles as well as loading the relevant Lintian checks. Instance Methods$prof->known_aliases() Returns a hash with old names that have new names. $prof->profile_list Returns a list ref of the (normalized) names of the profile and its parents….
Lintian::ProcessablePool — Pool of processables Synopsis use Lintian::ProcessablePool; my $pool = Lintian::ProcessablePool->new; $pool->add_file(‘foo.changes’); $pool->add_file(‘bar.dsc’); $pool->add_file(‘baz.deb’); $pool->add_file(‘qux.buildinfo’); foreach my $gname ($pool->get_group_names){ my $group = $pool->get_group($gname); process($gname, $group); }MethodsLintian::ProcessablePool->new ([LAB]) Creates a new empty pool. If LAB is given, it is assumed to be a Lintian::Lab. In this case, any processable added to this pool will be…