.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "Lintian::Reporting::Util 3"
.TH Lintian::Reporting::Util 3 2024-02-05 "Lintian v2.117.0" "Debian Package Checker"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
Lintian::Reporting::Util \- Lintian utility functions
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 1
\& use Lintian::Reporting::Util qw(load_state_cache find_backlog);
\&
\& my $cache = load_state_cache(\*(Aqpath/to/state\-dir\*(Aq);
\& my @backlog = find_backlog(\*(Aq2.12\*(Aq, $cache);
.Ve
.SH DESCRIPTION
.IX Header "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.
.PP
Most subs are imported only on request.
.SH FUNCTIONS
.IX Header "FUNCTIONS"
.IP load_state_cache(STATE_DIR) 4
.IX Item "load_state_cache(STATE_DIR)"
[Reporting tools only] Load the state cache from STATE_DIR.
.IP "save_state_cache(STATE_DIR, STATE)" 4
.IX Item "save_state_cache(STATE_DIR, STATE)"
[Reporting tools only] Save the STATE cache to STATE_DIR.
.IP "find_backlog(LINTIAN_VERSION, STATE)" 4
.IX Item "find_backlog(LINTIAN_VERSION, STATE)"
[Reporting tools only] Given the current lintian version and the
harness state, return a list of group ids that are part of the
backlog.  The list is sorted based on what version of Lintian
processed the package.
.Sp
Note the result is by design not deterministic to reduce the
risk of all large packages being in the same run (e.g. like
gcc\-5 + gcc\-5\-cross + gcc\-6 + gcc\-6\-cross).
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fBlintian\fR\|(1)