/usr/share/doc/lintian/api.html/Lintian/CheckScript.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 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html><head><title>Lintian::CheckScript</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='#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::CheckScript - Check script meta data</p>
<h1><a class='u' href='#___top' title='click to go to top of document'
name="SYNOPSIS"
>SYNOPSIS</a></h1>
<pre> use Lintian::CheckScript;
my $cs = Lintian::CheckScript->new ("$ENV{'LINTIAN_ROOT'}/checks/",
'files');
my $name = $cs->name;
foreach my $tag ($cs->tags) {
# $ti is an instance of Lintian::Tag::Info
my $ti = $cs->get_tag ($tag);
print "$tag is a part of the check $name\n";
# Do something with $ti / $tag
}
foreach my $needs ($cs->needs_info) {
print "$name needs $needs\n";
}
if ($cs->is_check_type ('binary') && $cs->is_check_type ('source')) {
# Check applies to binary pkgs AND source pkgs
}</pre>
<h1><a class='u' href='#___top' title='click to go to top of document'
name="DESCRIPTION"
>DESCRIPTION</a></h1>
<p>Instances of this class represents the data in the check ".desc" files. It allows access to the tags (as Lintian::Tag::Info) and the common meta data of the check (such as Needs-Info).</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="Lintian::CheckScript->new($basedir,_$checkname[,_$profile,_$lang])"
>Lintian::CheckScript->new($basedir, $checkname[, $profile, $lang])</a></dt>
<dd>
<p>Parses the $file as a check desc file. If $profile and $lang is given, translations for the check will be loaded as well.</p>
<dt><a name="$cs->name"
>$cs->name</a></dt>
<dd>
<p>Returns the "name" of the check script. This is the value in the Check-Script field in the file.</p>
<dt><a name="$cs->type"
>$cs->type</a></dt>
<dd>
<p>Returns the value stored in the "Type" field of the file. For the purpose of testing if the check applies to a given package type, the <a href="#is_check_type" class="podlinkpod"
>"is_check_type"</a> method can be used instead.</p>
<p>Note in rare cases this may return undef. This is the case for the lintian.desc, where this field is simply not present.</p>
<dt><a name="$cs->abbrev"
>$cs->abbrev</a></dt>
<dd>
<p>Returns the value of the Abbrev field from the desc file.</p>
<dt><a name="$cs->script_path"
>$cs->script_path</a></dt>
<dd>
<p>Returns the (expected) path to the script implementing this check.</p>
<dt><a name="needs_info"
>needs_info</a></dt>
<dd>
<p>Returns a list of all items listed in the Needs-Info field. Neither the list nor its contents should be modified.</p>
<dt><a name="$cs->is_check_type_($type)"
>$cs->is_check_type ($type)</a></dt>
<dd>
<p>Returns a truth value if this check can be applied to a $type package.</p>
<p>Note if $cs->type return undef, this will return a truth value for all inputs.</p>
<dt><a name="$cs->get_tag_($tagname)"
>$cs->get_tag ($tagname)</a></dt>
<dd>
<p>Return the <a href="../Lintian/Tag/Info.html" class="podlinkpod"
>tag</a> or undef (if the tag is not in this check).</p>
<dt><a name="$cs->tags"
>$cs->tags</a></dt>
<dd>
<p>Returns the list of tag names in the check. The list nor its contents should be modified.</p>
<dt><a name="$cs->load_check"
>$cs->load_check</a></dt>
<dd>
<p>Attempts to load the check. On failure, the load error will be propagated to the caller. On success it returns normally.</p>
<dt><a name="$cs->run_check_($proc,_$group)"
>$cs->run_check ($proc, $group)</a></dt>
<dd>
<p>Run the check on <code>$proc</code>, which is in the <a href="../Lintian/ProcessableGroup.html" class="podlinkpod"
>group</a> <code>$group</code>. <code>$proc</code> should be a <a href="../Lintian/Lab/Entry.html" class="podlinkpod"
>lab entry</a> and must have the proper collections run on it prior to calling this method (See <a href="../Lintian/Unpacker.html" class="podlinkpod"
>Lintian::Unpacker</a>).</p>
<p>The method may error out if loading the check failed or if the check itself calls die/croak/fail/etc.</p>
<p>Returns normally on success; the return value has no semantic meaning and is currently <code>undef</code>.</p>
<p>NB: load_check can be used to determine if the check itself is loadable.</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), Lintian::Profile(3), Lintian::Tag::Info(3)</p>
<p class="backlinkbottom"><b><a name="___bottom" href="../index.html" title="All Documents"><<</a></b></p>
<!-- end doc -->
</body></html>
|