.\" -*- 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::Processable::Source::Relation 3"
.TH Lintian::Processable::Source::Relation 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::Processable::Source::Relation \- Lintian interface to source package data collection
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 5
\&    my ($name, $type, $dir) = (\*(Aqfoobar\*(Aq, \*(Aqsource\*(Aq, \*(Aq/path/to/lab\-entry\*(Aq);
\&    my $collect = Lintian::Processable::Source::Relation\->new($name);
\&    if ($collect\->native) {
\&        print encode_utf8("Package is native\en");
\&    }
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
Lintian::Processable::Source::Relation provides an interface to package data for source
packages.  It implements data collection methods specific to source
packages.
.PP
This module is in its infancy.  Most of Lintian still reads all data from
files in the laboratory whenever that data is needed and generates that
data via collect scripts.  The goal is to eventually access all data about
source packages via this module so that the module can cache data where
appropriate and possibly retire collect scripts in favor of caching that
data in memory.
.SH "INSTANCE METHODS"
.IX Header "INSTANCE METHODS"
.IP "binary_relation (PACKAGE, FIELD)" 4
.IX Item "binary_relation (PACKAGE, FIELD)"
Returns a Lintian::Relation object for the specified FIELD in the
binary package PACKAGE in the \fIdebian/control\fR file.  FIELD should be
one of the possible relationship fields of a Debian package or one of
the following special values:
.RS 4
.IP All 4
.IX Item "All"
The concatenation of Pre-Depends, Depends, Recommends, and Suggests.
.IP Strong 4
.IX Item "Strong"
The concatenation of Pre-Depends and Depends.
.IP Weak 4
.IX Item "Weak"
The concatenation of Recommends and Suggests.
.RE
.RS 4
.Sp
If FIELD isn't present in the package, the returned Lintian::Relation
object will be empty (present but satisfies nothing).
.Sp
Any substvars in \fIdebian/control\fR will be represented in the returned
relation as packages named after the substvar.
.RE
.IP saved_binary_relations 4
.IX Item "saved_binary_relations"
.PD 0
.IP "relation (FIELD)" 4
.IX Item "relation (FIELD)"
.PD
Returns a Lintian::Relation object for the given build relationship
field FIELD.  In addition to the normal build relationship fields, the
following special field names are supported:
.RS 4
.IP Build-Depends-All 4
.IX Item "Build-Depends-All"
The concatenation of Build-Depends, Build-Depends-Arch and
Build-Depends-Indep.
.IP Build-Conflicts-All 4
.IX Item "Build-Conflicts-All"
The concatenation of Build-Conflicts, Build-Conflicts-Arch and
Build-Conflicts-Indep.
.RE
.RS 4
.Sp
If FIELD isn't present in the package, the returned Lintian::Relation
object will be empty (present but satisfies nothing).
.RE
.IP saved_relation 4
.IX Item "saved_relation"
.PD 0
.IP "relation_norestriction (FIELD)" 4
.IX Item "relation_norestriction (FIELD)"
.PD
The same as "relation (FIELD)", but ignores architecture
restrictions and build profile restrictions in the FIELD field.
.IP saved_relations_norestriction 4
.IX Item "saved_relations_norestriction"
.SH AUTHOR
.IX Header "AUTHOR"
Originally written by Russ Allbery <rra@debian.org> for Lintian.
Amended by Felix Lechner <felix.lechner@lease\-up.com> for Lintian.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fBlintian\fR\|(1)