162 lines
5.6 KiB
HTML
162 lines
5.6 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
|
|
<html>
|
|
<head>
|
|
<title>
|
|
Bugzilla::Install::Requirements</title>
|
|
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
|
<link rel="stylesheet" title="style" type="text/css" href="../.././../../../style.css" media="all" >
|
|
|
|
</head>
|
|
<body id="pod">
|
|
<p class="backlinktop"><b><a name="___top" href="../../index.html" accesskey="1" title="All Documents"><<</a></b></p>
|
|
<h1>Bugzilla::Install::Requirements</h1>
|
|
<div class='indexgroup'>
|
|
<ul class='indexList indexList1'>
|
|
<li class='indexItem indexItem1'><a href='#NAME'>NAME</a>
|
|
<li class='indexItem indexItem1'><a href='#DESCRIPTION'>DESCRIPTION</a>
|
|
<li class='indexItem indexItem1'><a href='#CONSTANTS'>CONSTANTS</a>
|
|
<li class='indexItem indexItem1'><a href='#SUBROUTINES'>SUBROUTINES</a>
|
|
</ul>
|
|
</div>
|
|
|
|
<h1><a class='u' href='#___top' title='click to go to top of document'
|
|
name="NAME"
|
|
>NAME</a></h1>
|
|
|
|
<p>Bugzilla::Install::Requirements - Functions and variables dealing with Bugzilla's perl-module requirements.</p>
|
|
|
|
<h1><a class='u' href='#___top' title='click to go to top of document'
|
|
name="DESCRIPTION"
|
|
>DESCRIPTION</a></h1>
|
|
|
|
<p>This module is used primarily by <code class="code">checksetup.pl</code> to determine whether or not all of Bugzilla's prerequisites are installed.
|
|
(That is,
|
|
all the perl modules it requires.)</p>
|
|
|
|
<h1><a class='u' href='#___top' title='click to go to top of document'
|
|
name="CONSTANTS"
|
|
>CONSTANTS</a></h1>
|
|
|
|
<dl>
|
|
<dt><a name="REQUIRED_MODULES"
|
|
><code class="code">REQUIRED_MODULES</code></a></dt>
|
|
|
|
<dd>
|
|
<p>An arrayref of hashrefs that describes the perl modules required by Bugzilla.
|
|
The hashes have two keys,
|
|
<code class="code">name</code> and <code class="code">version</code>,
|
|
which represent the name of the module and the version that we require.</p>
|
|
</dd>
|
|
</dl>
|
|
|
|
<h1><a class='u' href='#___top' title='click to go to top of document'
|
|
name="SUBROUTINES"
|
|
>SUBROUTINES</a></h1>
|
|
|
|
<dl>
|
|
<dt><a name="check_requirements"
|
|
><code class="code">check_requirements</code></a></dt>
|
|
|
|
<dd>
|
|
<dl>
|
|
<dt><a name="Description"
|
|
><b>Description</b></a></dt>
|
|
|
|
<dd>
|
|
<p>This checks what optional or required perl modules are installed,
|
|
like <code class="code">checksetup.pl</code> does.</p>
|
|
|
|
<dt><a name="Params"
|
|
><b>Params</b></a></dt>
|
|
|
|
<dd>
|
|
<dl>
|
|
<dt><a
|
|
><code class="code">$output</code> - <code class="code">true</code> if you want the function to print out information about what it's doing,
|
|
and the versions of everything installed.</a></dt>
|
|
</dl>
|
|
|
|
<dt><a name="Returns"
|
|
><b>Returns</b></a></dt>
|
|
|
|
<dd>
|
|
<p>A hashref containing these values:</p>
|
|
|
|
<dl>
|
|
<dt><a name="pass_-_Whether_or_not_we_have_all_the_mandatory_requirements."
|
|
><code class="code">pass</code> - Whether or not we have all the mandatory requirements.</a></dt>
|
|
|
|
<dd>
|
|
<dt><a
|
|
><code class="code">missing</code> - An arrayref containing any required modules that are not installed or that are not up-to-date.
|
|
Each item in the array is a hashref in the format of items from <a href="#REQUIRED_MODULES" class="podlinkpod"
|
|
>"REQUIRED_MODULES"</a>.</a></dt>
|
|
|
|
<dd>
|
|
<dt><a name="optional_-_The_same_as_missing,_but_for_optional_modules."
|
|
><code class="code">optional</code> - The same as <code class="code">missing</code>,
|
|
but for optional modules.</a></dt>
|
|
|
|
<dd>
|
|
<dt><a name="have_one_dbd_-_True_if_at_least_one_DBD::_module_is_installed."
|
|
><code class="code">have_one_dbd</code> - True if at least one <code class="code">DBD::</code> module is installed.</a></dt>
|
|
|
|
<dd>
|
|
<dt><a name="any_missing_-_True_if_there_are_any_missing_modules,_even_optional_modules."
|
|
><code class="code">any_missing</code> - True if there are any missing modules,
|
|
even optional modules.</a></dt>
|
|
</dl>
|
|
</dd>
|
|
</dl>
|
|
|
|
<dt><a name="check_graphviz($output)"
|
|
><code class="code">check_graphviz($output)</code></a></dt>
|
|
|
|
<dd>
|
|
<p>Description: Checks if the graphviz binary specified in the <code class="code">webdotbase</code> parameter is a valid binary,
|
|
or a valid URL.</p>
|
|
|
|
<p>Params: <code class="code">$output</code> - <code class="code">$true</code> if you want the function to print out information about what it's doing.</p>
|
|
|
|
<p>Returns: <code class="code">1</code> if the check was successful,
|
|
<code class="code">0</code> otherwise.</p>
|
|
|
|
<dt><a name="have_vers($module,_$output)"
|
|
><code class="code">have_vers($module,
|
|
$output)</code></a></dt>
|
|
|
|
<dd>
|
|
<pre class="code"> Description: Tells you whether or not you have the appropriate
|
|
version of the module requested. It also prints
|
|
out a message to the user explaining the check
|
|
and the result.
|
|
|
|
Params: C<$module> - A hashref, in the format of an item from
|
|
L</REQUIRED_MODULES>.
|
|
C<$output> - Set to true if you want this function to
|
|
print information to STDOUT about what it's
|
|
doing.
|
|
|
|
Returns: C<1> if you have the module installed and you have the
|
|
appropriate version. C<0> otherwise.</pre>
|
|
|
|
<dt><a name="install_command($module)"
|
|
><code class="code">install_command($module)</code></a></dt>
|
|
|
|
<dd>
|
|
<pre class="code"> Description: Prints out the appropriate command to install the
|
|
module specified, depending on whether you're
|
|
on Windows or Linux.
|
|
|
|
Params: C<$module> - A hashref, in the format of an item from
|
|
L</REQUIRED_MODULES>.
|
|
|
|
Returns: nothing</pre>
|
|
</dd>
|
|
</dl>
|
|
<p class="backlinkbottom"><b><a name="___bottom" href="../../index.html" title="All Documents"><<</a></b></p>
|
|
|
|
<!-- end doc -->
|
|
|
|
</body></html>
|