~ubuntu-branches/debian/sid/bugzilla/sid

<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($output)"

><code class="code">check_requirements($output)</code></a></dt>

<dd>

<pre class="code"> Description: This checks what optional or required perl modules

are installed, like C<checksetup.pl> does.

Params: C<$output> - C<true> if you want the function to print

out information about what it's doing,

and the versions of everything installed.

If you don't pass the minimum requirements,

the will always print out something,

regardless of this parameter.

Returns: A hashref containing three values:

C<pass> - Whether or not we have all the mandatory

requirements.

C<missing> - A hash showing which mandatory requirements

are missing. The key is the module name,

and the value is the version we require.

C<optional> - Which optional modules are installed and

up-to-date enough for Bugzilla.</pre>

<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="vers_cmp($a,_$b)"

><code class="code">vers_cmp($a, $b)</code></a></dt>

<dd>

<pre class="code"> Description: This is a comparison function, like you would use in

C<sort>, except that it compares two version numbers.

It's actually identical to versioncmp from

L<Sort::Versions>.

Params: c<$a> and C<$b> are versions you want to compare.

100

101

Returns: -1 if $a is less than $b, 0 if they are equal, and

102

1 if $a is greater than $b.</pre>

103

104

<dt><a name="have_vers($module,_$output)"

105

><code class="code">have_vers($module, $output)</code></a></dt>

106

107

<dd>

108

<pre class="code"> Description: Tells you whether or not you have the appropriate

109

version of the module requested. It also prints

110

out a message to the user explaining the check

111

and the result.

112

113

Params: C<$module> - A hashref, in the format of an item from

114

L</REQUIRED_MODULES>.

115

C<$output> - Set to true if you want this function to

116

print information to STDOUT about what it's

117

doing.

118

119

Returns: C<1> if you have the module installed and you have the

120

appropriate version. C<0> otherwise.</pre>

121

122

<dt><a name="install_command($module)"

123

><code class="code">install_command($module)</code></a></dt>

124

125

<dd>

126

<pre class="code"> Description: Prints out the appropriate command to install the

127

module specified, depending on whether you're

128

on Windows or Linux.

129

130

Params: C<$module> - A hashref, in the format of an item from

131

L</REQUIRED_MODULES>.

132

133

Returns: nothing</pre>

134

</dd>

135

</dl>

136

137

138

139

140

</body></html>

Older »