Section 3: library functions
Lintian::Tutorial::WritingTests — Short tutorial on writing tests Synopsis Warning: 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…
Lintian::Tutorial::WritingChecks — Writing checks for Lintian Synopsis Warning: 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>.desc And then either adding a Lintian profile or extending an existing one. Description The basics of…
Lintian::Tutorial::TestSuite — Quick intro to running the Lintian testsuite Synopsis Warning: 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…
Lintian::Tutorial — The newcomer’s guide to Lintian Synopsis Getting started with lintian in 5 minutes… maybe 10. Description Depending 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 •…
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; Description Provides 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 } Description Represents a Lintian Override. Methods Lintian::Tag::Override->new($tag, $data) Creates a new override for $tag. $data should be…
Lintian::Tag::Info – Lintian interface to tag metadata Synopsis my $taginfo = Lintian::Tag::Info->new; Description This 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 Methods tag original_severity effective_severity check check_type experimental info references…
Lintian::Tag::Bearer — Facilities for objects receiving Lintian tags Synopsis use Moo; use namespace::clean; with(‘Lintian::Tag::Bearer’); Description A class for collecting Lintian tags as they are found Instance Methods tag (ARGS) Store found tags for later processing. tags Author Originally written by Felix Lechner <felix.lechner [at] lease-up.com> for Lintian. See Also lintian(1)
Lintian::Tag — Common facilities for Lintian tags found and to be issued Synopsis use Moo; use namespace::clean; with ‘Lintian::Tag’; Description Common facilities for Lintian tags found and to be issued Instance Methods arguments =item info =item name =item override =item processable hint Calculate the string representation commonly referred to as ‘hint’. Author Originally written by…
Lintian::Spelling — Lintian spell checks shared between multiple scripts Synopsis use Lintian::Spelling qw(check_spelling); Description This 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…
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); Description This 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. Functions…
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’), " "; print ‘CSS: ‘ . $resMan->resource_URL(‘generated-styles.css’), " "; Description A simple resource manager for Lintian’s…
Lintian::Relation::Version – Comparison operators on Debian versions Synopsis print "yes " if versions_equal(‘1.0’, ‘1.00’); print "yes " if versions_gte(‘1.1’, ‘1.0’); print "no " if versions_lte(‘1.1’, ‘1.0’); print "yes " if versions_gt(‘1.1’, ‘1.0’); print "no " if versions_lt(‘1.1’, ‘1.1’); print "yes " if versions_compare(‘1.1’, ‘<=’, ‘1.1’); Description This module provides five functions for comparing version numbers….
Lintian::Relation – Lintian operations on dependencies and relationships Synopsis my $depends = Lintian::Relation->new(‘foo | bar, baz’); print "yes " if $depends->implies(‘baz’); print "no " if $depends->implies(‘foo’); Description This 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…
Lintian::Profile – Profile parser for Lintian Synopsis my $profile = Lintian::Profile->new (‘debian’); Description Lintian::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…
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); } Methods Lintian::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…
Lintian::ProcessableGroup — A group of objects that Lintian can process Synopsis use Lintian::ProcessableGroup; my $group = Lintian::ProcessableGroup->new(‘lintian_2.5.0_i386.changes’); foreach my $proc ($group->get_processables){ printf "%s %s (%s)\n", $proc->pkg_name, $proc->pkg_version, $proc->pkg_type; } # etc. Description Instances of this perl class are sets of processables. It allows at most one source and one changes or buildinfo package per set,…
Lintian::Processable::Udeb — A udeb installation package Lintian can process Synopsis use Lintian::Processable::Udeb; my $processable = Lintian::Processable::Udeb->new; $processable->init(‘path’); Description This class represents a ‘udeb’ file that Lintian can process. Objects of this kind are often part of a Lintian::Group, which represents all the files in a changes or buildinfo file. Instance Methods init (FILE) Initializes a…