/usr/share/doc/lintian/api.html/Lintian/Collect.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 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html><head><title>Lintian::Collect</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::Collect - Lintian interface to package data collection</p>
<h1><a class='u' href='#___top' title='click to go to top of document'
name="SYNOPSIS"
>SYNOPSIS</a></h1>
<pre> my ($name, $type, $dir) = ('foobar', 'udeb', '/some/abs/path');
my $collect = Lintian::Collect->new ($name, $type, $dir);
$name = $collect->name;
$type = $collect->type;</pre>
<h1><a class='u' href='#___top' title='click to go to top of document'
name="DESCRIPTION"
>DESCRIPTION</a></h1>
<p>Lintian::Collect provides the shared interface to package data used by source, binary and udeb packages and .changes files. It creates an object of the appropriate type and provides common functions used by the collection interface to all types of package.</p>
<p>Usually instances should not be created directly (exceptions include collections), but instead be requested via the <a href="../Lintian/Lab/Entry.html#info" class="podlinkpod"
>info</a> method in Lintian::Lab::Entry.</p>
<p>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 via this module and its subclasses so that the module can cache data where appropriate and possibly retire collect scripts in favor of caching that data in memory.</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_(PACKAGE,_TYPE,_BASEDIR[,_FIELDS]))"
>new (PACKAGE, TYPE, BASEDIR[, FIELDS]))</a></dt>
<dd>
<p>Creates a new object appropriate to the package type. TYPE can be retrieved later with the <a href="#type" class="podlinkpod"
>"type"</a> method. Croaks if given an unknown TYPE.</p>
<p>PACKAGE is the name of the package and is stored in the collect object. It can be retrieved with the <a href="#name" class="podlinkpod"
>"name"</a> method.</p>
<p>BASEDIR is the base directory for the data and should be absolute.</p>
<p>If FIELDS is given it is assumed to be the fields from the underlying control file. This is only used to avoid an unnecessary read operation (possibly incl. an ar | gzip pipeline) when the fields are already known.</p>
</dd>
</dl>
<h1><a class='u' href='#___top' title='click to go to top of document'
name="INSTANCE_METHODS"
>INSTANCE METHODS</a></h1>
<p>In addition to the instance methods documented here, see the documentation of <a href="../Lintian/Collect/Source.html" class="podlinkpod"
>Lintian::Collect::Source</a>, <a href="../Lintian/Collect/Binary.html" class="podlinkpod"
>Lintian::Collect::Binary</a> and <a href="../Lintian/Collect/Changes.html" class="podlinkpod"
>Lintian::Collect::Changes</a> for instance methods specific to source and binary / udeb packages and .changes files.</p>
<dl>
<dt><a name="name"
>name</a></dt>
<dd>
<p>Returns the name of the package.</p>
<p>Needs-Info requirements for using <i>name</i>: none</p>
<dt><a name="type"
>type</a></dt>
<dd>
<p>Returns the type of the package.</p>
<p>Needs-Info requirements for using <i>type</i>: none</p>
<dt><a name="base_dir"
>base_dir</a></dt>
<dd>
<p>Returns the base_dir where all the package information is stored.</p>
<p>Needs-Info requirements for using <i>base_dir</i>: none</p>
<dt><a name="lab_data_path_([ENTRY])"
>lab_data_path ([ENTRY])</a></dt>
<dd>
<p>Return the path to the ENTRY in the lab. This is a convenience method around base_dir. If ENTRY is not given, this method behaves like base_dir.</p>
<p>Needs-Info requirements for using <i>lab_data_path</i>: <a href="#base_dir" class="podlinkpod"
>"base_dir"</a></p>
<dt><a name="field_([FIELD[,_DEFAULT]])"
>field ([FIELD[, DEFAULT]])</a></dt>
<dd>
<p>If FIELD is given, this method returns the value of the control field FIELD in the control file for the package. For a source package, this is the *.dsc file; for a binary package, this is the control file in the control section of the package.</p>
<p>If FIELD is passed but not present, then this method will return DEFAULT (if given) or undef.</p>
<p>Otherwise this will return a hash of fields, where the key is the field name (in all lowercase).</p>
<p>Needs-Info requirements for using <i>field</i>: none</p>
<dt><a name="is_non_free"
>is_non_free</a></dt>
<dd>
<p>Returns a truth value if the package appears to be non-free (based on the section field; "non-free/*" and "restricted/*")</p>
<p>Needs-Info requirements for using <i>is_non_free</i>: <a href="#field_(%5BFIELD%5B%2C_DEFAULT%5D%5D)" class="podlinkpod"
>"field ([FIELD[, DEFAULT]])"</a></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 Russ Allbery <rra@debian.org> 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), <a href="../Lintian/Collect/Binary.html" class="podlinkpod"
>Lintian::Collect::Binary</a>, <a href="../Lintian/Collect/Changes.html" class="podlinkpod"
>Lintian::Collect::Changes</a>, <a href="../Lintian/Collect/Source.html" class="podlinkpod"
>Lintian::Collect::Source</a></p>
<p class="backlinkbottom"><b><a name="___bottom" href="../index.html" title="All Documents"><<</a></b></p>
<!-- end doc -->
</body></html>
|