/usr/share/doc/lintian/api.html/Lintian/Processable.html is in lintian 2.5.43.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html><head><title>Lintian::Processable</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<link rel="stylesheet" title="blkbluw" type="text/css" href="../_blkbluw.css" media="all" >
<link rel="alternate stylesheet" title="blkmagw" type="text/css" href="../_blkmagw.css" media="all" >
<link rel="alternate stylesheet" title="blkcynw" type="text/css" href="../_blkcynw.css" media="all" >
<link rel="alternate stylesheet" title="whtprpk" type="text/css" href="../_whtprpk.css" media="all" >
<link rel="alternate stylesheet" title="whtnavk" type="text/css" href="../_whtnavk.css" media="all" >
<link rel="alternate stylesheet" title="grygrnk" type="text/css" href="../_grygrnk.css" media="all" >
<link rel="alternate stylesheet" title="whtgrng" type="text/css" href="../_whtgrng.css" media="all" >
<link rel="alternate stylesheet" title="blkgrng" type="text/css" href="../_blkgrng.css" media="all" >
<link rel="alternate stylesheet" title="grygrnw" type="text/css" href="../_grygrnw.css" media="all" >
<link rel="alternate stylesheet" title="blkbluw" type="text/css" href="../_blkbluw.css" media="all" >
<link rel="alternate stylesheet" title="whtpurk" type="text/css" href="../_whtpurk.css" media="all" >
<link rel="alternate stylesheet" title="whtgrng" type="text/css" href="../_whtgrng.css" media="all" >
<link rel="alternate stylesheet" title="grygrnw" type="text/css" href="../_grygrnw.css" media="all" >
<script type="text/javascript" src="../_podly.js"></script>
</head>
<body class='pod'>
<!-- start doc -->
<p class="backlinktop"><b><a name="___top" href="../index.html" accesskey="1" title="All Documents"><<</a></b></p>
<div class='indexgroup'>
<ul class='indexList indexList1'>
<li class='indexItem indexItem1'><a href='#NAME'>NAME</a>
<li class='indexItem indexItem1'><a href='#SYNOPSIS'>SYNOPSIS</a>
<li class='indexItem indexItem1'><a href='#DESCRIPTION'>DESCRIPTION</a>
<li class='indexItem indexItem1'><a href='#CLASS_METHODS'>CLASS METHODS</a>
<li class='indexItem indexItem1'><a href='#INSTANCE_METHODS'>INSTANCE METHODS</a>
<li class='indexItem indexItem1'><a href='#AUTHOR'>AUTHOR</a>
<li class='indexItem indexItem1'><a href='#SEE_ALSO'>SEE ALSO</a>
</ul>
</div>
<h1><a class='u' href='#___top' title='click to go to top of document'
name="NAME"
>NAME</a></h1>
<p>Lintian::Processable -- An (abstract) object that Lintian can process</p>
<h1><a class='u' href='#___top' title='click to go to top of document'
name="SYNOPSIS"
>SYNOPSIS</a></h1>
<pre> use Lintian::Processable::Package;
# Instantiate via Lintian::Processable::Package
my $proc = Lintian::Processable::Package->new ('lintian_2.5.0_all.deb');
my $pkg_name = $proc->pkg_name;
my $pkg_version = $proc->pkg_version;
# etc.</pre>
<h1><a class='u' href='#___top' title='click to go to top of document'
name="DESCRIPTION"
>DESCRIPTION</a></h1>
<p>Instances of this perl class are objects that Lintian can process (e.g. deb files). Multiple objects can then be combined into <a href="../Lintian/ProcessableGroup.html" class="podlinkpod"
>groups</a>, which Lintian will process together.</p>
<h1><a class='u' href='#___top' title='click to go to top of document'
name="CLASS_METHODS"
>CLASS METHODS</a></h1>
<dl>
<dt><a name="new_from_metadata_(TYPE,_PARAGRAPH[,_BASEPATH])"
>new_from_metadata (TYPE, PARAGRAPH[, BASEPATH])</a></dt>
<dd>
<p>Returns a Lintian::Processable from a PARAGRAPH in a Sources or a Packages file with the following exception.</p>
<p>If the PARAGRAPH has a field named "pkg_path", then that is used instead of creating the path from BASEPATH path concatenated with the TYPE specific field(s). Hench BASEPATH is optional if and only if, the paragraph has a field called "pkg_path".</p>
<p>The TYPE parameter determines the type of the processable and is required.</p>
<p>NB: Optional fields (e.g. "Source" for binaries) may be omitted in PARAGRAPH as usual. In this case, the respective values are computed from the required fields according to the Policy Manual.</p>
</dd>
</dl>
<h1><a class='u' href='#___top' title='click to go to top of document'
name="INSTANCE_METHODS"
>INSTANCE METHODS</a></h1>
<dl>
<dt><a name="$proc->pkg_name()"
>$proc->pkg_name()</a></dt>
<dd>
<p>Returns the package name.</p>
<dt><a name="$proc->pkg_version()"
>$proc->pkg_version()</a></dt>
<dd>
<p>Returns the version of the package.</p>
<dt><a name="$proc->pkg_path()"
>$proc->pkg_path()</a></dt>
<dd>
<p>Returns the path to the packaged version of actual package. This path is used in case the data needs to be extracted from the package.</p>
<p>Note: This may return the path to a symlink to the package.</p>
<dt><a name="$proc->pkg_type()"
>$proc->pkg_type()</a></dt>
<dd>
<p>Returns the type of package (e.g. binary, source, udeb ...)</p>
<dt><a name="$proc->pkg_arch()"
>$proc->pkg_arch()</a></dt>
<dd>
<p>Returns the architecture(s) of the package. May return multiple values from changes processables. For source processables it is "source".</p>
<dt><a name="$proc->pkg_src()"
>$proc->pkg_src()</a></dt>
<dd>
<p>Returns the name of the source package.</p>
<dt><a name="$proc->pkg_src_version()"
>$proc->pkg_src_version()</a></dt>
<dd>
<p>Returns the version of the source package.</p>
<dt><a name="$proc->tainted()"
>$proc->tainted()</a></dt>
<dd>
<p>Returns a truth value if one or more fields in this Processable is tainted. On a best effort basis tainted fields will be sanitized to less dangerous (but possibly invalid) values.</p>
<dt><a name="$proc->identifier"
>$proc->identifier</a></dt>
<dd>
<p>Produces an identifier for this processable. The identifier is based on the type, name, version and architecture of the package.</p>
<dt><a name="$proc->group([$group])"
>$proc->group([$group])</a></dt>
<dd>
<p>Returns the <a href="../Lintian/ProcessableGroup.html" class="podlinkpod"
>group</a> $proc is in, if any. If the processable is not in a group, this returns <code>undef</code>.</p>
<p>Can also be used to set the group of this processable.</p>
<dt><a name="$proc->info"
>$proc->info</a></dt>
<dd>
<p>Returns <a href="../Lintian/Collect.html" class="podlinkpod"
>$info</a> element for this processable.</p>
<p>Note: This method must be implemented by sub-classes unless they provide an "info" field.</p>
<dt><a name="$proc->clear_cache"
>$proc->clear_cache</a></dt>
<dd>
<p>Discard the info element, so the memory used by it can be reclaimed. Mostly useful when checking a lot of packages (e.g. on lintian.d.o).</p>
<p>Note: By default this does nothing, but it may (and should) be overridden by sub-classes.</p>
<dt><a name="$proc->get_field_($field[,_$def])"
>$proc->get_field ($field[, $def])</a></dt>
<dd>
<p>Optional method to access a field in the underlying data set.</p>
<p>Returns $def if the field is not present or the implementation does not have (or want to expose) it. This method is <i>not</i> guaranteed to return the same value as "$proc->info->field ($field, $def)".</p>
<p>If <code>$def</code> is omitted is defaults to <code>undef</code>.</p>
<p>Default implementation accesses them via the hashref stored in "extra-fields" if present. If the field is present, but not defined $def is returned instead.</p>
<p>NB: This is mostly an optimization used by <a href="../Lintian/Lab.html" class="podlinkpod"
>Lintian::Lab</a> to avoid (re-)reading the underlying package data.</p>
</dd>
</dl>
<h1><a class='u' href='#___top' title='click to go to top of document'
name="AUTHOR"
>AUTHOR</a></h1>
<p>Originally written by Niels Thykier <niels@thykier.net> for Lintian.</p>
<h1><a class='u' href='#___top' title='click to go to top of document'
name="SEE_ALSO"
>SEE ALSO</a></h1>
<p>lintian(1)</p>
<p><a href="../Lintian/ProcessableGroup.html" class="podlinkpod"
>Lintian::ProcessableGroup</a></p>
<p class="backlinkbottom"><b><a name="___bottom" href="../index.html" title="All Documents"><<</a></b></p>
<!-- end doc -->
</body></html>
|