Google Git
Sign in
apache / yetus / fba56b422ab7916a348f2a809b33346f329ca5d2 / . / documentation / 0.16.0-SNAPSHOT / precommit / apidocs / test-patch / index.html
blob: 9247b087c8adfd11ac155813bf56802ca727f6b5 [file] [log] [blame]
<!---
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
-->
<html>
<head>
<meta charset="utf-8">
<title>Apache Yetus</title>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="description" content="">
<meta name="author" content="">
<link href="../../../../../assets/css/bootstrap.css" rel="stylesheet">
<link href="../../../../../assets/css/bootstrap-theme.css" rel="stylesheet">
<link href="../../../../../assets/css/font-awesome.css" rel="stylesheet">
<!-- JS -->
<script type="text/javascript" src="../../../../../assets/js/jquery-2.1.4.min.js"></script>
<script type="text/javascript" src="../../../../../assets/js/bootstrap.js"></script>
</head>
<body>
<div class="navbar navbar-inverse navbar-static-top" role="navigation">
<div class="container">
<div class="navbar-header">
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".navbar-collapse">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<a class="img-responsive pull-left" href="/">
<img style="max-height: 40px; margin-top: 5px; margin-bottom: 5px;" src="../../../../../assets/img/yetus_logo.png" alt="Apache Yetus logo" />
</a>
</div>
<div class="navbar-collapse collapse">
<ul class="nav navbar-nav">
<li><a href="/downloads/">Downloads</a>
<li class="dropdown">
<a class="dropdown-toggle" data-toggle="dropdown" href="#">Documentation <span class="caret"></span></a>
<ul class="dropdown-menu" role="menu">
<li><a href="/documentation/0.13.0/">Docs for v0.13.0</a></li>
<li><a href="/documentation/0.14.1/">Docs for v0.14.1</a></li>
<li><a href="/documentation/0.15.0/">Docs for v0.15.0</a></li>
<li><a href="/documentation/in-progress/">In Progress Docs for Contributors</a>
</li>
<li><a href="/documentation/history/">History of the Project</a>
</li>
</ul>
</li>
<li class="dropdown">
<a class="dropdown-toggle" data-toggle="dropdown" href="#">Get Involved <span class="caret"></span></a>
<ul class="dropdown-menu" role="menu" aria-labelledby="drop1">
<li role="presentation"><a role="menuitem" tabindex="-1" href="/mailinglists"><i class="fa fa-commenting"></i> Mailing Lists</a>
</li>
<li role="presentation"><a role="menuitem" tabindex="-1" href="https://issues.apache.org/jira/browse/YETUS"><i class="fa fa-bug"></i> JIRA (Bugs)</a>
</li>
<li role="presentation"><a role="menuitem" tabindex="-1" href="https://gitbox.apache.org/repos/asf/yetus.git"><i class="fa fa-code"></i> Source (Apache)</a>
</li>
<li role="presentation"><a role="menuitem" tabindex="-1" href="https://github.com/apache/yetus"><i class="fa fa-github-alt"></i> Source (GitHub)</a>
</li>
<li role="presentation"><a role="menuitem" tabindex="-1" href="/contribute/"><i class="fa fa-code-fork"></i> Contributing</a>
</li>
<li role="presentation"><a role="menuitem" tabindex="-1" href="https://twitter.com/ApacheYetus"><i class="fa fa-twitter"></i> @ApacheYetus</a>
</li>
</ul>
</li>
<li>
<li class="dropdown">
<a class="dropdown-toggle" data-toggle="dropdown" href="#">Apache Software Foundation <b class="caret"></b></a>
<ul class="dropdown-menu" role="menu">
<li><a href="https://www.apache.org">Apache Homepage</a>
</li>
<li><a href="https://www.apache.org/licenses/">Apache License</a>
</li>
<li><a href="https://www.apache.org/foundation/sponsorship.html">Sponsorship</a>
</li>
<li><a href="https://www.apache.org/foundation/thanks.html">Thanks</a>
</li>
<li><a href="https://www.apache.org/security/">Security</a>
</li>
</ul>
</li>
</li>
</ul>
</div>
<!--/.nav-collapse -->
</div>
</div>
<div class="container">
<!---
# Licensed to the Apache Software Foundation (ASF) under one
# or more contributor license agreements. See the NOTICE file
# distributed with this work for additional information
# regarding copyright ownership. The ASF licenses this file
# to you under the Apache License, Version 2.0 (the
# "License"); you may not use this file except in compliance
# with the License. You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
-->
<ul>
<li>Public/Stable/Replaceable
<ul>
<li><a href="#verify_multijdk_test">verify_multijdk_test</a></li>
</ul>
</li>
<li>Public/Stable/Not Replaceable
<ul>
<li><a href="#add_footer_table">add_footer_table</a></li>
<li><a href="#add_header_line">add_header_line</a></li>
<li><a href="#add_test_table">add_test_table</a></li>
<li><a href="#add_vote_table">add_vote_table</a></li>
<li><a href="#add_vote_table_v2">add_vote_table_v2</a></li>
<li><a href="#big_console_header">big_console_header</a></li>
<li><a href="#clock_display">clock_display</a></li>
<li><a href="#echo_and_redirect">echo_and_redirect</a></li>
<li><a href="#git_checkout_force">git_checkout_force</a></li>
<li><a href="#git_clean">git_clean</a></li>
<li><a href="#offset_clock">offset_clock</a></li>
<li><a href="#setup_defaults">setup_defaults</a></li>
<li><a href="#start_clock">start_clock</a></li>
<li><a href="#stop_clock">stop_clock</a></li>
<li><a href="#write_comment">write_comment</a></li>
<li><a href="#yetus_usage">yetus_usage</a></li>
</ul>
</li>
<li>Public/Evolving/Not Replaceable
<ul>
<li><a href="#archive">archive</a></li>
<li><a href="#buildtool_cwd">buildtool_cwd</a></li>
<li><a href="#calcdiffs">calcdiffs</a></li>
<li><a href="#clear_personality_queue">clear_personality_queue</a></li>
<li><a href="#column_calcdiffs">column_calcdiffs</a></li>
<li><a href="#compile">compile</a></li>
<li><a href="#compile_cycle">compile_cycle</a></li>
<li><a href="#compile_jvm">compile_jvm</a></li>
<li><a href="#compile_nonjvm">compile_nonjvm</a></li>
<li><a href="#dequeue_personality_module">dequeue_personality_module</a></li>
<li><a href="#distclean">distclean</a></li>
<li><a href="#error_calcdiffs">error_calcdiffs</a></li>
<li><a href="#generic_calcdiff_status">generic_calcdiff_status</a></li>
<li><a href="#generic_logfilter">generic_logfilter</a></li>
<li><a href="#generic_post_handler">generic_post_handler</a></li>
<li><a href="#generic_postlog_compare">generic_postlog_compare</a></li>
<li><a href="#generic_pre_handler">generic_pre_handler</a></li>
<li><a href="#initialize">initialize</a></li>
<li><a href="#module_post_handler">module_post_handler</a></li>
<li><a href="#module_postlog_compare">module_postlog_compare</a></li>
<li><a href="#module_pre_handler">module_pre_handler</a></li>
<li><a href="#module_status">module_status</a></li>
<li><a href="#modules_backup">modules_backup</a></li>
<li><a href="#modules_messages">modules_messages</a></li>
<li><a href="#modules_reset">modules_reset</a></li>
<li><a href="#modules_restore">modules_restore</a></li>
<li><a href="#modules_workers">modules_workers</a></li>
<li><a href="#patchfiletests">patchfiletests</a></li>
<li><a href="#personality_enqueue_module">personality_enqueue_module</a></li>
<li><a href="#root_postlog_compare">root_postlog_compare</a></li>
</ul>
</li>
<li>Private/Stable/Replaceable
<ul>
<li><a href="#prepopulate_footer">prepopulate_footer</a></li>
<li><a href="#report_jvm_version">report_jvm_version</a></li>
</ul>
</li>
<li>Private/Evolving/Replaceable
<ul>
<li><a href="#start_coprocessors">start_coprocessors</a></li>
<li><a href="#stop_coprocessors">stop_coprocessors</a></li>
<li><a href="#verify_patchdir_still_exists">verify_patchdir_still_exists</a></li>
</ul>
</li>
</ul>
<hr />
<h2 id="publicstablereplaceable">Public/Stable/Replaceable</h2>
<h3 id="verify_multijdk_test"><code>verify_multijdk_test</code></h3>
<ul>
<li>Synopsis</li>
</ul>
<div class="highlight"><pre class="highlight plaintext"><code>verify_multijdk_test test
</code></pre></div>
<ul>
<li>Description</li>
</ul>
<p>Verify if a given test is multijdk</p>
<ul>
<li>Returns</li>
</ul>
<p>0 = yes<br />
1 = no</p>
<table class="table table-bordered table-striped">
<thead>
<tr>
<th style="text-align: left">Classification</th>
<th style="text-align: left">Level</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left">Audience</td>
<td style="text-align: left">Public</td>
</tr>
<tr>
<td style="text-align: left">Stability</td>
<td style="text-align: left">Stable</td>
</tr>
<tr>
<td style="text-align: left">Replaceable</td>
<td style="text-align: left">True</td>
</tr>
</tbody>
</table>
<h2 id="publicstablenot-replaceable">Public/Stable/Not Replaceable</h2>
<h3 id="add_footer_table"><code>add_footer_table</code></h3>
<ul>
<li>Synopsis</li>
</ul>
<div class="highlight"><pre class="highlight plaintext"><code>add_footer_table subsystem string
</code></pre></div>
<ul>
<li>Description</li>
</ul>
<p>Add to the footer of the display. @@BASE@@ will get replaced with the<br />
correct location for the local filesystem in dev mode or the URL for<br />
Jenkins mode.</p>
<ul>
<li>Returns</li>
</ul>
<p>Nothing</p>
<table class="table table-bordered table-striped">
<thead>
<tr>
<th style="text-align: left">Classification</th>
<th style="text-align: left">Level</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left">Audience</td>
<td style="text-align: left">Public</td>
</tr>
<tr>
<td style="text-align: left">Stability</td>
<td style="text-align: left">Stable</td>
</tr>
<tr>
<td style="text-align: left">Replaceable</td>
<td style="text-align: left">False</td>
</tr>
</tbody>
</table>
<h3 id="add_header_line"><code>add_header_line</code></h3>
<ul>
<li>Synopsis</li>
</ul>
<div class="highlight"><pre class="highlight plaintext"><code>add_header_line string
</code></pre></div>
<ul>
<li>Description</li>
</ul>
<p>Add to the header of the display</p>
<ul>
<li>Returns</li>
</ul>
<p>Nothing</p>
<table class="table table-bordered table-striped">
<thead>
<tr>
<th style="text-align: left">Classification</th>
<th style="text-align: left">Level</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left">Audience</td>
<td style="text-align: left">Public</td>
</tr>
<tr>
<td style="text-align: left">Stability</td>
<td style="text-align: left">Stable</td>
</tr>
<tr>
<td style="text-align: left">Replaceable</td>
<td style="text-align: left">False</td>
</tr>
</tbody>
</table>
<h3 id="add_test_table"><code>add_test_table</code></h3>
<ul>
<li>Synopsis</li>
</ul>
<div class="highlight"><pre class="highlight plaintext"><code>add_test_table failurereason testlist
</code></pre></div>
<ul>
<li>Description</li>
</ul>
<p>Special table just for unit test failures</p>
<ul>
<li>Returns</li>
</ul>
<p>Nothing</p>
<table class="table table-bordered table-striped">
<thead>
<tr>
<th style="text-align: left">Classification</th>
<th style="text-align: left">Level</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left">Audience</td>
<td style="text-align: left">Public</td>
</tr>
<tr>
<td style="text-align: left">Stability</td>
<td style="text-align: left">Stable</td>
</tr>
<tr>
<td style="text-align: left">Replaceable</td>
<td style="text-align: left">False</td>
</tr>
</tbody>
</table>
<h3 id="add_vote_table"><code>add_vote_table</code></h3>
<ul>
<li>Synopsis</li>
</ul>
<div class="highlight"><pre class="highlight plaintext"><code>add_vote_table
</code></pre></div>
<ul>
<li>Description</li>
</ul>
<p>Deprecated. Use add_vote_table_v2 instead.</p>
<ul>
<li>Returns</li>
</ul>
<p>Nothing</p>
<table class="table table-bordered table-striped">
<thead>
<tr>
<th style="text-align: left">Classification</th>
<th style="text-align: left">Level</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left">Audience</td>
<td style="text-align: left">Public</td>
</tr>
<tr>
<td style="text-align: left">Stability</td>
<td style="text-align: left">Stable</td>
</tr>
<tr>
<td style="text-align: left">Replaceable</td>
<td style="text-align: left">False</td>
</tr>
</tbody>
</table>
<h3 id="add_vote_table_v2"><code>add_vote_table_v2</code></h3>
<ul>
<li>Synopsis</li>
</ul>
<div class="highlight"><pre class="highlight plaintext"><code>add_vote_table_v2 +1/0/-1/H subsystem logfile string
</code></pre></div>
<ul>
<li>Description</li>
</ul>
<p>Add to the output table. If the first parameter is a number<br />
that is the vote for that column and calculates the elapsed time<br />
based upon the last start_clock(). The second parameter is the reporting<br />
subsystem (or test) that is providing the vote. The second parameter<br />
is always required. The third parameter is any extra verbiage that goes<br />
with that subsystem.<br />
if the vote is H, then that designates that "subsystem" should be a<br />
header in the vote table comment output. The other parameters are<br />
ignored</p>
<ul>
<li>Returns</li>
</ul>
<p>Nothing</p>
<table class="table table-bordered table-striped">
<thead>
<tr>
<th style="text-align: left">Classification</th>
<th style="text-align: left">Level</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left">Audience</td>
<td style="text-align: left">Public</td>
</tr>
<tr>
<td style="text-align: left">Stability</td>
<td style="text-align: left">Stable</td>
</tr>
<tr>
<td style="text-align: left">Replaceable</td>
<td style="text-align: left">False</td>
</tr>
</tbody>
</table>
<h3 id="big_console_header"><code>big_console_header</code></h3>
<ul>
<li>Synopsis</li>
</ul>
<div class="highlight"><pre class="highlight plaintext"><code>big_console_header string
</code></pre></div>
<ul>
<li>Description</li>
</ul>
<p>Large display for the user console</p>
<ul>
<li>Returns</li>
</ul>
<p>large chunk of text</p>
<table class="table table-bordered table-striped">
<thead>
<tr>
<th style="text-align: left">Classification</th>
<th style="text-align: left">Level</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left">Audience</td>
<td style="text-align: left">Public</td>
</tr>
<tr>
<td style="text-align: left">Stability</td>
<td style="text-align: left">Stable</td>
</tr>
<tr>
<td style="text-align: left">Replaceable</td>
<td style="text-align: left">False</td>
</tr>
</tbody>
</table>
<h3 id="clock_display"><code>clock_display</code></h3>
<ul>
<li>Synopsis</li>
</ul>
<div class="highlight"><pre class="highlight plaintext"><code>clock_display seconds
</code></pre></div>
<ul>
<li>Description</li>
</ul>
<p>Convert time in seconds to m + s</p>
<ul>
<li>Returns</li>
</ul>
<p>Nothing</p>
<table class="table table-bordered table-striped">
<thead>
<tr>
<th style="text-align: left">Classification</th>
<th style="text-align: left">Level</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left">Audience</td>
<td style="text-align: left">Public</td>
</tr>
<tr>
<td style="text-align: left">Stability</td>
<td style="text-align: left">Stable</td>
</tr>
<tr>
<td style="text-align: left">Replaceable</td>
<td style="text-align: left">False</td>
</tr>
</tbody>
</table>
<h3 id="echo_and_redirect"><code>echo_and_redirect</code></h3>
<ul>
<li>Synopsis</li>
</ul>
<div class="highlight"><pre class="highlight plaintext"><code>echo_and_redirect filename command [..]
</code></pre></div>
<ul>
<li>Description</li>
</ul>
<p>Print the command to be executing to the screen. Then<br />
run the command, sending stdout and stderr to the given filename<br />
This will also ensure that any directories in ${BASEDIR} have<br />
the exec bit set as a pre-exec step.</p>
<ul>
<li>Returns</li>
</ul>
<p>$?</p>
<table class="table table-bordered table-striped">
<thead>
<tr>
<th style="text-align: left">Classification</th>
<th style="text-align: left">Level</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left">Audience</td>
<td style="text-align: left">Public</td>
</tr>
<tr>
<td style="text-align: left">Stability</td>
<td style="text-align: left">Stable</td>
</tr>
<tr>
<td style="text-align: left">Replaceable</td>
<td style="text-align: left">False</td>
</tr>
</tbody>
</table>
<h3 id="git_checkout_force"><code>git_checkout_force</code></h3>
<ul>
<li>Synopsis</li>
</ul>
<div class="highlight"><pre class="highlight plaintext"><code>git_checkout_force
</code></pre></div>
<ul>
<li>Description</li>
</ul>
<p>Forcibly reset the tree back to it's original state</p>
<ul>
<li>Returns</li>
</ul>
<p>0 on success</p>
<table class="table table-bordered table-striped">
<thead>
<tr>
<th style="text-align: left">Classification</th>
<th style="text-align: left">Level</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left">Audience</td>
<td style="text-align: left">Public</td>
</tr>
<tr>
<td style="text-align: left">Stability</td>
<td style="text-align: left">Stable</td>
</tr>
<tr>
<td style="text-align: left">Replaceable</td>
<td style="text-align: left">False</td>
</tr>
</tbody>
</table>
<h3 id="git_clean"><code>git_clean</code></h3>
<ul>
<li>Synopsis</li>
</ul>
<div class="highlight"><pre class="highlight plaintext"><code>git_clean
</code></pre></div>
<ul>
<li>Description</li>
</ul>
<p>git clean the repository</p>
<ul>
<li>Returns</li>
</ul>
<p>0 on success</p>
<table class="table table-bordered table-striped">
<thead>
<tr>
<th style="text-align: left">Classification</th>
<th style="text-align: left">Level</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left">Audience</td>
<td style="text-align: left">Public</td>
</tr>
<tr>
<td style="text-align: left">Stability</td>
<td style="text-align: left">Stable</td>
</tr>
<tr>
<td style="text-align: left">Replaceable</td>
<td style="text-align: left">False</td>
</tr>
</tbody>
</table>
<h3 id="offset_clock"><code>offset_clock</code></h3>
<ul>
<li>Synopsis</li>
</ul>
<div class="highlight"><pre class="highlight plaintext"><code>offset_clock seconds
</code></pre></div>
<ul>
<li>Description</li>
</ul>
<p>Add time to the local timer</p>
<ul>
<li>Returns</li>
</ul>
<p>Nothing</p>
<table class="table table-bordered table-striped">
<thead>
<tr>
<th style="text-align: left">Classification</th>
<th style="text-align: left">Level</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left">Audience</td>
<td style="text-align: left">Public</td>
</tr>
<tr>
<td style="text-align: left">Stability</td>
<td style="text-align: left">Stable</td>
</tr>
<tr>
<td style="text-align: left">Replaceable</td>
<td style="text-align: left">False</td>
</tr>
</tbody>
</table>
<h3 id="setup_defaults"><code>setup_defaults</code></h3>
<ul>
<li>Synopsis</li>
</ul>
<div class="highlight"><pre class="highlight plaintext"><code>setup_defaults
</code></pre></div>
<ul>
<li>Description</li>
</ul>
<p>Setup the default global variables</p>
<ul>
<li>Returns</li>
</ul>
<p>Nothing</p>
<table class="table table-bordered table-striped">
<thead>
<tr>
<th style="text-align: left">Classification</th>
<th style="text-align: left">Level</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left">Audience</td>
<td style="text-align: left">Public</td>
</tr>
<tr>
<td style="text-align: left">Stability</td>
<td style="text-align: left">Stable</td>
</tr>
<tr>
<td style="text-align: left">Replaceable</td>
<td style="text-align: left">False</td>
</tr>
</tbody>
</table>
<h3 id="start_clock"><code>start_clock</code></h3>
<ul>
<li>Synopsis</li>
</ul>
<div class="highlight"><pre class="highlight plaintext"><code>start_clock
</code></pre></div>
<ul>
<li>Description</li>
</ul>
<p>Activate the local timer</p>
<ul>
<li>Returns</li>
</ul>
<p>Nothing</p>
<table class="table table-bordered table-striped">
<thead>
<tr>
<th style="text-align: left">Classification</th>
<th style="text-align: left">Level</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left">Audience</td>
<td style="text-align: left">Public</td>
</tr>
<tr>
<td style="text-align: left">Stability</td>
<td style="text-align: left">Stable</td>
</tr>
<tr>
<td style="text-align: left">Replaceable</td>
<td style="text-align: left">False</td>
</tr>
</tbody>
</table>
<h3 id="stop_clock"><code>stop_clock</code></h3>
<ul>
<li>Synopsis</li>
</ul>
<div class="highlight"><pre class="highlight plaintext"><code>stop_clock
</code></pre></div>
<ul>
<li>Description</li>
</ul>
<p>Print the elapsed time in seconds since the start of the local timer</p>
<ul>
<li>Returns</li>
</ul>
<p>Nothing</p>
<table class="table table-bordered table-striped">
<thead>
<tr>
<th style="text-align: left">Classification</th>
<th style="text-align: left">Level</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left">Audience</td>
<td style="text-align: left">Public</td>
</tr>
<tr>
<td style="text-align: left">Stability</td>
<td style="text-align: left">Stable</td>
</tr>
<tr>
<td style="text-align: left">Replaceable</td>
<td style="text-align: left">False</td>
</tr>
</tbody>
</table>
<h3 id="write_comment"><code>write_comment</code></h3>
<ul>
<li>Synopsis</li>
</ul>
<div class="highlight"><pre class="highlight plaintext"><code>write_comment filename
</code></pre></div>
<ul>
<li>Description</li>
</ul>
<p>Write the contents of a file to all of the bug systems<br />
(so content should avoid special formatting)</p>
<ul>
<li>Returns</li>
</ul>
<p>Nothing</p>
<table class="table table-bordered table-striped">
<thead>
<tr>
<th style="text-align: left">Classification</th>
<th style="text-align: left">Level</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left">Audience</td>
<td style="text-align: left">Public</td>
</tr>
<tr>
<td style="text-align: left">Stability</td>
<td style="text-align: left">Stable</td>
</tr>
<tr>
<td style="text-align: left">Replaceable</td>
<td style="text-align: left">False</td>
</tr>
</tbody>
</table>
<h3 id="yetus_usage"><code>yetus_usage</code></h3>
<ul>
<li>Synopsis</li>
</ul>
<div class="highlight"><pre class="highlight plaintext"><code>yetus_usage
</code></pre></div>
<ul>
<li>Description</li>
</ul>
<p>Print the usage information</p>
<ul>
<li>Returns</li>
</ul>
<p>Nothing</p>
<table class="table table-bordered table-striped">
<thead>
<tr>
<th style="text-align: left">Classification</th>
<th style="text-align: left">Level</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left">Audience</td>
<td style="text-align: left">Public</td>
</tr>
<tr>
<td style="text-align: left">Stability</td>
<td style="text-align: left">Stable</td>
</tr>
<tr>
<td style="text-align: left">Replaceable</td>
<td style="text-align: left">False</td>
</tr>
</tbody>
</table>
<h2 id="publicevolvingnot-replaceable">Public/Evolving/Not Replaceable</h2>
<h3 id="archive"><code>archive</code></h3>
<ul>
<li>Synopsis</li>
</ul>
<div class="highlight"><pre class="highlight plaintext"><code>archive
</code></pre></div>
<ul>
<li>Description</li>
</ul>
<p>Save file names and directory to the patch dir</p>
<ul>
<li>Returns</li>
</ul>
<p>Nothing</p>
<table class="table table-bordered table-striped">
<thead>
<tr>
<th style="text-align: left">Classification</th>
<th style="text-align: left">Level</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left">Audience</td>
<td style="text-align: left">Public</td>
</tr>
<tr>
<td style="text-align: left">Stability</td>
<td style="text-align: left">Evolving</td>
</tr>
<tr>
<td style="text-align: left">Replaceable</td>
<td style="text-align: left">False</td>
</tr>
</tbody>
</table>
<h3 id="buildtool_cwd"><code>buildtool_cwd</code></h3>
<ul>
<li>Synopsis</li>
</ul>
<div class="highlight"><pre class="highlight plaintext"><code>buildtool_cwd MODULE_ index
</code></pre></div>
<ul>
<li>Description</li>
</ul>
<p>change the working directory to execute the buildtool</p>
<ul>
<li>Returns</li>
</ul>
<p>Nothing</p>
<table class="table table-bordered table-striped">
<thead>
<tr>
<th style="text-align: left">Classification</th>
<th style="text-align: left">Level</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left">Audience</td>
<td style="text-align: left">Public</td>
</tr>
<tr>
<td style="text-align: left">Stability</td>
<td style="text-align: left">Evolving</td>
</tr>
<tr>
<td style="text-align: left">Replaceable</td>
<td style="text-align: left">False</td>
</tr>
</tbody>
</table>
<h3 id="calcdiffs"><code>calcdiffs</code></h3>
<ul>
<li>Synopsis</li>
</ul>
<div class="highlight"><pre class="highlight plaintext"><code>calcdiffs branchlog patchlog testtype
</code></pre></div>
<ul>
<li>Description</li>
</ul>
<p>Wrapper to call specific version of calcdiffs if available<br />
otherwise calls error_calcdiffs</p>
<ul>
<li>Returns</li>
</ul>
<p>differences</p>
<table class="table table-bordered table-striped">
<thead>
<tr>
<th style="text-align: left">Classification</th>
<th style="text-align: left">Level</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left">Audience</td>
<td style="text-align: left">Public</td>
</tr>
<tr>
<td style="text-align: left">Stability</td>
<td style="text-align: left">Evolving</td>
</tr>
<tr>
<td style="text-align: left">Replaceable</td>
<td style="text-align: left">False</td>
</tr>
</tbody>
</table>
<h3 id="clear_personality_queue"><code>clear_personality_queue</code></h3>
<ul>
<li>Synopsis</li>
</ul>
<div class="highlight"><pre class="highlight plaintext"><code>clear_personality_queue
</code></pre></div>
<ul>
<li>Description</li>
</ul>
<p>Reset the queue for tests</p>
<ul>
<li>Returns</li>
</ul>
<p>Nothing</p>
<table class="table table-bordered table-striped">
<thead>
<tr>
<th style="text-align: left">Classification</th>
<th style="text-align: left">Level</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left">Audience</td>
<td style="text-align: left">Public</td>
</tr>
<tr>
<td style="text-align: left">Stability</td>
<td style="text-align: left">Evolving</td>
</tr>
<tr>
<td style="text-align: left">Replaceable</td>
<td style="text-align: left">False</td>
</tr>
</tbody>
</table>
<h3 id="column_calcdiffs"><code>column_calcdiffs</code></h3>
<ul>
<li>Synopsis</li>
</ul>
<div class="highlight"><pre class="highlight plaintext"><code>column_calcdiffs branchlog patchlog
</code></pre></div>
<ul>
<li>Description</li>
</ul>
<p>Calculate the differences between the specified files<br />
using just the column+ messages (third+ column in a<br />
colon delimated file) and output it to stdout.</p>
<ul>
<li>Returns</li>
</ul>
<p>differences</p>
<table class="table table-bordered table-striped">
<thead>
<tr>
<th style="text-align: left">Classification</th>
<th style="text-align: left">Level</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left">Audience</td>
<td style="text-align: left">Public</td>
</tr>
<tr>
<td style="text-align: left">Stability</td>
<td style="text-align: left">Evolving</td>
</tr>
<tr>
<td style="text-align: left">Replaceable</td>
<td style="text-align: left">False</td>
</tr>
</tbody>
</table>
<h3 id="compile"><code>compile</code></h3>
<ul>
<li>Synopsis</li>
</ul>
<div class="highlight"><pre class="highlight plaintext"><code>compile branch|patch
</code></pre></div>
<ul>
<li>Description</li>
</ul>
<p>Execute the compile phase. This will callout<br />
to _compile</p>
<ul>
<li>Returns</li>
</ul>
<p>0 on success<br />
1 on failure</p>
<table class="table table-bordered table-striped">
<thead>
<tr>
<th style="text-align: left">Classification</th>
<th style="text-align: left">Level</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left">Audience</td>
<td style="text-align: left">Public</td>
</tr>
<tr>
<td style="text-align: left">Stability</td>
<td style="text-align: left">Evolving</td>
</tr>
<tr>
<td style="text-align: left">Replaceable</td>
<td style="text-align: left">False</td>
</tr>
</tbody>
</table>
<h3 id="compile_cycle"><code>compile_cycle</code></h3>
<ul>
<li>Synopsis</li>
</ul>
<div class="highlight"><pre class="highlight plaintext"><code>compile_cycle branch|patch
</code></pre></div>
<ul>
<li>Description</li>
</ul>
<p>Execute the static analysis test cycle.<br />
This will callout to _precompile, compile, _postcompile and _rebuild</p>
<ul>
<li>Returns</li>
</ul>
<p>0 on success<br />
1 on failure</p>
<table class="table table-bordered table-striped">
<thead>
<tr>
<th style="text-align: left">Classification</th>
<th style="text-align: left">Level</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left">Audience</td>
<td style="text-align: left">Public</td>
</tr>
<tr>
<td style="text-align: left">Stability</td>
<td style="text-align: left">Evolving</td>
</tr>
<tr>
<td style="text-align: left">Replaceable</td>
<td style="text-align: left">False</td>
</tr>
</tbody>
</table>
<h3 id="compile_jvm"><code>compile_jvm</code></h3>
<ul>
<li>Synopsis</li>
</ul>
<div class="highlight"><pre class="highlight plaintext"><code>compile_jvm branch|patch
</code></pre></div>
<ul>
<li>Description</li>
</ul>
<p>Execute the compile phase. This will callout<br />
to _compile</p>
<ul>
<li>Returns</li>
</ul>
<p>0 on success<br />
1 on failure</p>
<table class="table table-bordered table-striped">
<thead>
<tr>
<th style="text-align: left">Classification</th>
<th style="text-align: left">Level</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left">Audience</td>
<td style="text-align: left">Public</td>
</tr>
<tr>
<td style="text-align: left">Stability</td>
<td style="text-align: left">Evolving</td>
</tr>
<tr>
<td style="text-align: left">Replaceable</td>
<td style="text-align: left">False</td>
</tr>
</tbody>
</table>
<h3 id="compile_nonjvm"><code>compile_nonjvm</code></h3>
<ul>
<li>Synopsis</li>
</ul>
<div class="highlight"><pre class="highlight plaintext"><code>compile_nonjvm branch|patch
</code></pre></div>
<ul>
<li>Description</li>
</ul>
<p>Execute the compile phase. This will callout<br />
to _compile</p>
<ul>
<li>Returns</li>
</ul>
<p>0 on success<br />
1 on failure</p>
<table class="table table-bordered table-striped">
<thead>
<tr>
<th style="text-align: left">Classification</th>
<th style="text-align: left">Level</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left">Audience</td>
<td style="text-align: left">Public</td>
</tr>
<tr>
<td style="text-align: left">Stability</td>
<td style="text-align: left">Evolving</td>
</tr>
<tr>
<td style="text-align: left">Replaceable</td>
<td style="text-align: left">False</td>
</tr>
</tbody>
</table>
<h3 id="dequeue_personality_module"><code>dequeue_personality_module</code></h3>
<ul>
<li>Synopsis</li>
</ul>
<div class="highlight"><pre class="highlight plaintext"><code>dequeue_personality_module modulenames
</code></pre></div>
<ul>
<li>Description</li>
</ul>
<p>Remove a module</p>
<ul>
<li>Returns</li>
</ul>
<p>Nothing</p>
<table class="table table-bordered table-striped">
<thead>
<tr>
<th style="text-align: left">Classification</th>
<th style="text-align: left">Level</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left">Audience</td>
<td style="text-align: left">Public</td>
</tr>
<tr>
<td style="text-align: left">Stability</td>
<td style="text-align: left">Evolving</td>
</tr>
<tr>
<td style="text-align: left">Replaceable</td>
<td style="text-align: left">False</td>
</tr>
</tbody>
</table>
<h3 id="distclean"><code>distclean</code></h3>
<ul>
<li>Synopsis</li>
</ul>
<div class="highlight"><pre class="highlight plaintext"><code>distclean
</code></pre></div>
<ul>
<li>Description</li>
</ul>
<p>Wipe the repo clean to not invalidate tests</p>
<ul>
<li>Returns</li>
</ul>
<p>0 on success<br />
1 on failure</p>
<table class="table table-bordered table-striped">
<thead>
<tr>
<th style="text-align: left">Classification</th>
<th style="text-align: left">Level</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left">Audience</td>
<td style="text-align: left">Public</td>
</tr>
<tr>
<td style="text-align: left">Stability</td>
<td style="text-align: left">Evolving</td>
</tr>
<tr>
<td style="text-align: left">Replaceable</td>
<td style="text-align: left">False</td>
</tr>
</tbody>
</table>
<h3 id="error_calcdiffs"><code>error_calcdiffs</code></h3>
<ul>
<li>Synopsis</li>
</ul>
<div class="highlight"><pre class="highlight plaintext"><code>error_calcdiffs branchlog patchlog
</code></pre></div>
<ul>
<li>Description</li>
</ul>
<p>Calculate the differences between the specified files<br />
using just the error messages (last column in a<br />
colon delimated file) and output it to stdout.</p>
<ul>
<li>Returns</li>
</ul>
<p>differences</p>
<table class="table table-bordered table-striped">
<thead>
<tr>
<th style="text-align: left">Classification</th>
<th style="text-align: left">Level</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left">Audience</td>
<td style="text-align: left">Public</td>
</tr>
<tr>
<td style="text-align: left">Stability</td>
<td style="text-align: left">Evolving</td>
</tr>
<tr>
<td style="text-align: left">Replaceable</td>
<td style="text-align: left">False</td>
</tr>
</tbody>
</table>
<h3 id="generic_calcdiff_status"><code>generic_calcdiff_status</code></h3>
<ul>
<li>Synopsis</li>
</ul>
<div class="highlight"><pre class="highlight plaintext"><code>generic_calcdiff_status totalbranchissues totalpatchissues newpatchissues
</code></pre></div>
<ul>
<li>Description</li>
</ul>
<p>generate a standardized calcdiff status message</p>
<ul>
<li>Returns</li>
</ul>
<p>errorstring</p>
<table class="table table-bordered table-striped">
<thead>
<tr>
<th style="text-align: left">Classification</th>
<th style="text-align: left">Level</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left">Audience</td>
<td style="text-align: left">Public</td>
</tr>
<tr>
<td style="text-align: left">Stability</td>
<td style="text-align: left">Evolving</td>
</tr>
<tr>
<td style="text-align: left">Replaceable</td>
<td style="text-align: left">False</td>
</tr>
</tbody>
</table>
<h3 id="generic_logfilter"><code>generic_logfilter</code></h3>
<ul>
<li>Synopsis</li>
</ul>
<div class="highlight"><pre class="highlight plaintext"><code>generic_logfilter
</code></pre></div>
<ul>
<li>Description</li>
</ul>
<p>Helper routine for plugins to ask projects, etc<br />
to count problems in a log file<br />
and output it to stdout.</p>
<ul>
<li>Returns</li>
</ul>
<p>number of issues</p>
<table class="table table-bordered table-striped">
<thead>
<tr>
<th style="text-align: left">Classification</th>
<th style="text-align: left">Level</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left">Audience</td>
<td style="text-align: left">Public</td>
</tr>
<tr>
<td style="text-align: left">Stability</td>
<td style="text-align: left">Evolving</td>
</tr>
<tr>
<td style="text-align: left">Replaceable</td>
<td style="text-align: left">False</td>
</tr>
</tbody>
</table>
<h3 id="generic_post_handler"><code>generic_post_handler</code></h3>
<ul>
<li>Synopsis</li>
</ul>
<div class="highlight"><pre class="highlight plaintext"><code>generic_post_handler
</code></pre></div>
<ul>
<li>Description</li>
</ul>
<p>Deprecated. Use module_post_handler instead.</p>
<ul>
<li>Returns</li>
</ul>
<p>Nothing</p>
<table class="table table-bordered table-striped">
<thead>
<tr>
<th style="text-align: left">Classification</th>
<th style="text-align: left">Level</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left">Audience</td>
<td style="text-align: left">Public</td>
</tr>
<tr>
<td style="text-align: left">Stability</td>
<td style="text-align: left">Evolving</td>
</tr>
<tr>
<td style="text-align: left">Replaceable</td>
<td style="text-align: left">False</td>
</tr>
</tbody>
</table>
<h3 id="generic_postlog_compare"><code>generic_postlog_compare</code></h3>
<ul>
<li>Synopsis</li>
</ul>
<div class="highlight"><pre class="highlight plaintext"><code>generic_postlog_compare
</code></pre></div>
<ul>
<li>Description</li>
</ul>
<p>Deprecated. Use module_postlog_compare instead.</p>
<ul>
<li>Returns</li>
</ul>
<p>Nothing</p>
<table class="table table-bordered table-striped">
<thead>
<tr>
<th style="text-align: left">Classification</th>
<th style="text-align: left">Level</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left">Audience</td>
<td style="text-align: left">Public</td>
</tr>
<tr>
<td style="text-align: left">Stability</td>
<td style="text-align: left">Evolving</td>
</tr>
<tr>
<td style="text-align: left">Replaceable</td>
<td style="text-align: left">False</td>
</tr>
</tbody>
</table>
<h3 id="generic_pre_handler"><code>generic_pre_handler</code></h3>
<ul>
<li>Synopsis</li>
</ul>
<div class="highlight"><pre class="highlight plaintext"><code>generic_pre_handler testype multijdk
</code></pre></div>
<ul>
<li>Description</li>
</ul>
<p>Deprecated. Use module_pre_handler instead.</p>
<ul>
<li>Returns</li>
</ul>
<p>1 on failure<br />
0 on success</p>
<table class="table table-bordered table-striped">
<thead>
<tr>
<th style="text-align: left">Classification</th>
<th style="text-align: left">Level</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left">Audience</td>
<td style="text-align: left">Public</td>
</tr>
<tr>
<td style="text-align: left">Stability</td>
<td style="text-align: left">Evolving</td>
</tr>
<tr>
<td style="text-align: left">Replaceable</td>
<td style="text-align: left">False</td>
</tr>
</tbody>
</table>
<h3 id="initialize"><code>initialize</code></h3>
<ul>
<li>Synopsis</li>
</ul>
<div class="highlight"><pre class="highlight plaintext"><code>initialize $@
</code></pre></div>
<ul>
<li>Description</li>
</ul>
<p>Setup to execute</p>
<ul>
<li>Returns</li>
</ul>
<p>0 on success<br />
1 on failure</p>
<table class="table table-bordered table-striped">
<thead>
<tr>
<th style="text-align: left">Classification</th>
<th style="text-align: left">Level</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left">Audience</td>
<td style="text-align: left">Public</td>
</tr>
<tr>
<td style="text-align: left">Stability</td>
<td style="text-align: left">Evolving</td>
</tr>
<tr>
<td style="text-align: left">Replaceable</td>
<td style="text-align: left">False</td>
</tr>
</tbody>
</table>
<h3 id="module_post_handler"><code>module_post_handler</code></h3>
<ul>
<li>Synopsis</li>
</ul>
<div class="highlight"><pre class="highlight plaintext"><code>module_post_handler origlog testtype multijdkmode run commands
</code></pre></div>
<ul>
<li>Description</li>
</ul>
<p>Generic post-patch handler</p>
<ul>
<li>Returns</li>
</ul>
<p>0 on success<br />
1 on failure</p>
<table class="table table-bordered table-striped">
<thead>
<tr>
<th style="text-align: left">Classification</th>
<th style="text-align: left">Level</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left">Audience</td>
<td style="text-align: left">Public</td>
</tr>
<tr>
<td style="text-align: left">Stability</td>
<td style="text-align: left">Evolving</td>
</tr>
<tr>
<td style="text-align: left">Replaceable</td>
<td style="text-align: left">False</td>
</tr>
</tbody>
</table>
<h3 id="module_postlog_compare"><code>module_postlog_compare</code></h3>
<ul>
<li>Synopsis</li>
</ul>
<div class="highlight"><pre class="highlight plaintext"><code>module_postlog_compare origlog testtype multijdkmode
</code></pre></div>
<ul>
<li>Description</li>
</ul>
<p>Module post-patch log handler</p>
<ul>
<li>Returns</li>
</ul>
<p>0 on success<br />
1 on failure</p>
<table class="table table-bordered table-striped">
<thead>
<tr>
<th style="text-align: left">Classification</th>
<th style="text-align: left">Level</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left">Audience</td>
<td style="text-align: left">Public</td>
</tr>
<tr>
<td style="text-align: left">Stability</td>
<td style="text-align: left">Evolving</td>
</tr>
<tr>
<td style="text-align: left">Replaceable</td>
<td style="text-align: left">False</td>
</tr>
</tbody>
</table>
<h3 id="module_pre_handler"><code>module_pre_handler</code></h3>
<ul>
<li>Synopsis</li>
</ul>
<div class="highlight"><pre class="highlight plaintext"><code>module_pre_handler testype multijdk
</code></pre></div>
<ul>
<li>Description</li>
</ul>
<p>Helper routine for plugins to do a pre-patch run</p>
<ul>
<li>Returns</li>
</ul>
<p>1 on failure<br />
0 on success</p>
<table class="table table-bordered table-striped">
<thead>
<tr>
<th style="text-align: left">Classification</th>
<th style="text-align: left">Level</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left">Audience</td>
<td style="text-align: left">Public</td>
</tr>
<tr>
<td style="text-align: left">Stability</td>
<td style="text-align: left">Evolving</td>
</tr>
<tr>
<td style="text-align: left">Replaceable</td>
<td style="text-align: left">False</td>
</tr>
</tbody>
</table>
<h3 id="module_status"><code>module_status</code></h3>
<ul>
<li>Synopsis</li>
</ul>
<div class="highlight"><pre class="highlight plaintext"><code>module_status moduleindex -1-0|0|+1 logvalue message
</code></pre></div>
<ul>
<li>Description</li>
</ul>
<p>Add or update a test result. Update requires<br />
at least the first two parameters.<br />
WARNING: If the message is updated,<br />
then the JDK version is also calculated to match<br />
the current JAVA_HOME.</p>
<ul>
<li>Returns</li>
</ul>
<p>Nothing</p>
<table class="table table-bordered table-striped">
<thead>
<tr>
<th style="text-align: left">Classification</th>
<th style="text-align: left">Level</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left">Audience</td>
<td style="text-align: left">Public</td>
</tr>
<tr>
<td style="text-align: left">Stability</td>
<td style="text-align: left">Evolving</td>
</tr>
<tr>
<td style="text-align: left">Replaceable</td>
<td style="text-align: left">False</td>
</tr>
</tbody>
</table>
<h3 id="modules_backup"><code>modules_backup</code></h3>
<ul>
<li>Synopsis</li>
</ul>
<div class="highlight"><pre class="highlight plaintext"><code>modules_backup
</code></pre></div>
<ul>
<li>Description</li>
</ul>
<p>Backup the MODULE globals prior to loop processing</p>
<ul>
<li>Returns</li>
</ul>
<p>Nothing</p>
<table class="table table-bordered table-striped">
<thead>
<tr>
<th style="text-align: left">Classification</th>
<th style="text-align: left">Level</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left">Audience</td>
<td style="text-align: left">Public</td>
</tr>
<tr>
<td style="text-align: left">Stability</td>
<td style="text-align: left">Evolving</td>
</tr>
<tr>
<td style="text-align: left">Replaceable</td>
<td style="text-align: left">False</td>
</tr>
</tbody>
</table>
<h3 id="modules_messages"><code>modules_messages</code></h3>
<ul>
<li>Synopsis</li>
</ul>
<div class="highlight"><pre class="highlight plaintext"><code>modules_messages repostatus testtype summarymode
</code></pre></div>
<ul>
<li>Description</li>
</ul>
<p>Utility to print standard module errors</p>
<ul>
<li>Returns</li>
</ul>
<p>Nothing</p>
<table class="table table-bordered table-striped">
<thead>
<tr>
<th style="text-align: left">Classification</th>
<th style="text-align: left">Level</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left">Audience</td>
<td style="text-align: left">Public</td>
</tr>
<tr>
<td style="text-align: left">Stability</td>
<td style="text-align: left">Evolving</td>
</tr>
<tr>
<td style="text-align: left">Replaceable</td>
<td style="text-align: left">False</td>
</tr>
</tbody>
</table>
<h3 id="modules_reset"><code>modules_reset</code></h3>
<ul>
<li>Synopsis</li>
</ul>
<div class="highlight"><pre class="highlight plaintext"><code>modules_reset
</code></pre></div>
<ul>
<li>Description</li>
</ul>
<p>Reset the test results</p>
<ul>
<li>Returns</li>
</ul>
<p>Nothing</p>
<table class="table table-bordered table-striped">
<thead>
<tr>
<th style="text-align: left">Classification</th>
<th style="text-align: left">Level</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left">Audience</td>
<td style="text-align: left">Public</td>
</tr>
<tr>
<td style="text-align: left">Stability</td>
<td style="text-align: left">Evolving</td>
</tr>
<tr>
<td style="text-align: left">Replaceable</td>
<td style="text-align: left">False</td>
</tr>
</tbody>
</table>
<h3 id="modules_restore"><code>modules_restore</code></h3>
<ul>
<li>Synopsis</li>
</ul>
<div class="highlight"><pre class="highlight plaintext"><code>modules_restore
</code></pre></div>
<ul>
<li>Description</li>
</ul>
<p>Restore the backup</p>
<ul>
<li>Returns</li>
</ul>
<p>Nothing</p>
<table class="table table-bordered table-striped">
<thead>
<tr>
<th style="text-align: left">Classification</th>
<th style="text-align: left">Level</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left">Audience</td>
<td style="text-align: left">Public</td>
</tr>
<tr>
<td style="text-align: left">Stability</td>
<td style="text-align: left">Evolving</td>
</tr>
<tr>
<td style="text-align: left">Replaceable</td>
<td style="text-align: left">False</td>
</tr>
</tbody>
</table>
<h3 id="modules_workers"><code>modules_workers</code></h3>
<ul>
<li>Synopsis</li>
</ul>
<div class="highlight"><pre class="highlight plaintext"><code>modules_workers repostatus testtype mvncmdline
</code></pre></div>
<ul>
<li>Description</li>
</ul>
<p>run the tests for the queued modules</p>
<ul>
<li>Returns</li>
</ul>
<p>Nothing</p>
<table class="table table-bordered table-striped">
<thead>
<tr>
<th style="text-align: left">Classification</th>
<th style="text-align: left">Level</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left">Audience</td>
<td style="text-align: left">Public</td>
</tr>
<tr>
<td style="text-align: left">Stability</td>
<td style="text-align: left">Evolving</td>
</tr>
<tr>
<td style="text-align: left">Replaceable</td>
<td style="text-align: left">False</td>
</tr>
</tbody>
</table>
<h3 id="patchfiletests"><code>patchfiletests</code></h3>
<ul>
<li>Synopsis</li>
</ul>
<div class="highlight"><pre class="highlight plaintext"><code>patchfiletests branch|patch
</code></pre></div>
<ul>
<li>Description</li>
</ul>
<p>Execute the patch file test phase. Calls out to<br />
to _patchfile</p>
<ul>
<li>Returns</li>
</ul>
<p>0 on success<br />
1 on failure</p>
<table class="table table-bordered table-striped">
<thead>
<tr>
<th style="text-align: left">Classification</th>
<th style="text-align: left">Level</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left">Audience</td>
<td style="text-align: left">Public</td>
</tr>
<tr>
<td style="text-align: left">Stability</td>
<td style="text-align: left">Evolving</td>
</tr>
<tr>
<td style="text-align: left">Replaceable</td>
<td style="text-align: left">False</td>
</tr>
</tbody>
</table>
<h3 id="personality_enqueue_module"><code>personality_enqueue_module</code></h3>
<ul>
<li>Synopsis</li>
</ul>
<div class="highlight"><pre class="highlight plaintext"><code>personality_enqueue_module module profiles/flags/etc
</code></pre></div>
<ul>
<li>Description</li>
</ul>
<p>Build the queue for tests</p>
<ul>
<li>Returns</li>
</ul>
<p>Nothing</p>
<table class="table table-bordered table-striped">
<thead>
<tr>
<th style="text-align: left">Classification</th>
<th style="text-align: left">Level</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left">Audience</td>
<td style="text-align: left">Public</td>
</tr>
<tr>
<td style="text-align: left">Stability</td>
<td style="text-align: left">Evolving</td>
</tr>
<tr>
<td style="text-align: left">Replaceable</td>
<td style="text-align: left">False</td>
</tr>
</tbody>
</table>
<h3 id="root_postlog_compare"><code>root_postlog_compare</code></h3>
<ul>
<li>Synopsis</li>
</ul>
<div class="highlight"><pre class="highlight plaintext"><code>root_postlog_compare testtype branchlog patchlog
</code></pre></div>
<ul>
<li>Description</li>
</ul>
<p>Root-level post-patch log handler. Files should be<br />
linecomments compatible!</p>
<ul>
<li>Returns</li>
</ul>
<p>0 on success<br />
1 on failure</p>
<table class="table table-bordered table-striped">
<thead>
<tr>
<th style="text-align: left">Classification</th>
<th style="text-align: left">Level</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left">Audience</td>
<td style="text-align: left">Public</td>
</tr>
<tr>
<td style="text-align: left">Stability</td>
<td style="text-align: left">Evolving</td>
</tr>
<tr>
<td style="text-align: left">Replaceable</td>
<td style="text-align: left">False</td>
</tr>
</tbody>
</table>
<h2 id="privatestablereplaceable">Private/Stable/Replaceable</h2>
<h3 id="prepopulate_footer"><code>prepopulate_footer</code></h3>
<ul>
<li>Synopsis</li>
</ul>
<div class="highlight"><pre class="highlight plaintext"><code>prepopulate_footer
</code></pre></div>
<ul>
<li>Description</li>
</ul>
<p>Put the opening environment information at the bottom<br />
of the footer table</p>
<ul>
<li>Returns</li>
</ul>
<p>Nothing</p>
<table class="table table-bordered table-striped">
<thead>
<tr>
<th style="text-align: left">Classification</th>
<th style="text-align: left">Level</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left">Audience</td>
<td style="text-align: left">Private</td>
</tr>
<tr>
<td style="text-align: left">Stability</td>
<td style="text-align: left">Stable</td>
</tr>
<tr>
<td style="text-align: left">Replaceable</td>
<td style="text-align: left">True</td>
</tr>
</tbody>
</table>
<h3 id="report_jvm_version"><code>report_jvm_version</code></h3>
<ul>
<li>Synopsis</li>
</ul>
<div class="highlight"><pre class="highlight plaintext"><code>report_jvm_version directory
</code></pre></div>
<ul>
<li>Description</li>
</ul>
<p>Report the JVM vendor and version of the given directory</p>
<ul>
<li>Returns</li>
</ul>
<p>vendor and version string</p>
<table class="table table-bordered table-striped">
<thead>
<tr>
<th style="text-align: left">Classification</th>
<th style="text-align: left">Level</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left">Audience</td>
<td style="text-align: left">Private</td>
</tr>
<tr>
<td style="text-align: left">Stability</td>
<td style="text-align: left">Stable</td>
</tr>
<tr>
<td style="text-align: left">Replaceable</td>
<td style="text-align: left">True</td>
</tr>
</tbody>
</table>
<h2 id="privateevolvingreplaceable">Private/Evolving/Replaceable</h2>
<h3 id="start_coprocessors"><code>start_coprocessors</code></h3>
<ul>
<li>Synopsis</li>
</ul>
<div class="highlight"><pre class="highlight plaintext"><code>start_coprocessors
</code></pre></div>
<ul>
<li>Description</li>
</ul>
<p>Start any coprocessors</p>
<ul>
<li>Returns</li>
</ul>
<p>Nothing</p>
<table class="table table-bordered table-striped">
<thead>
<tr>
<th style="text-align: left">Classification</th>
<th style="text-align: left">Level</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left">Audience</td>
<td style="text-align: left">Private</td>
</tr>
<tr>
<td style="text-align: left">Stability</td>
<td style="text-align: left">Evolving</td>
</tr>
<tr>
<td style="text-align: left">Replaceable</td>
<td style="text-align: left">True</td>
</tr>
</tbody>
</table>
<h3 id="stop_coprocessors"><code>stop_coprocessors</code></h3>
<ul>
<li>Synopsis</li>
</ul>
<div class="highlight"><pre class="highlight plaintext"><code>stop_coprocessors
</code></pre></div>
<ul>
<li>Description</li>
</ul>
<p>Stop any coprocessors</p>
<ul>
<li>Returns</li>
</ul>
<p>Nothing</p>
<table class="table table-bordered table-striped">
<thead>
<tr>
<th style="text-align: left">Classification</th>
<th style="text-align: left">Level</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left">Audience</td>
<td style="text-align: left">Private</td>
</tr>
<tr>
<td style="text-align: left">Stability</td>
<td style="text-align: left">Evolving</td>
</tr>
<tr>
<td style="text-align: left">Replaceable</td>
<td style="text-align: left">True</td>
</tr>
</tbody>
</table>
<h3 id="verify_patchdir_still_exists"><code>verify_patchdir_still_exists</code></h3>
<ul>
<li>Synopsis</li>
</ul>
<div class="highlight"><pre class="highlight plaintext"><code>verify_patchdir_still_exists
</code></pre></div>
<ul>
<li>Description</li>
</ul>
<p>Verify that the patch directory is still in working order<br />
since bad actors on some systems wipe it out. If not,<br />
recreate it and then exit</p>
<ul>
<li>Returns</li>
</ul>
<p>may exit on failure</p>
<table class="table table-bordered table-striped">
<thead>
<tr>
<th style="text-align: left">Classification</th>
<th style="text-align: left">Level</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left">Audience</td>
<td style="text-align: left">Private</td>
</tr>
<tr>
<td style="text-align: left">Stability</td>
<td style="text-align: left">Evolving</td>
</tr>
<tr>
<td style="text-align: left">Replaceable</td>
<td style="text-align: left">True</td>
</tr>
</tbody>
</table>
</div>
<div class="container">
<hr>
<footer class="footer">
<div class="row-fluid">
<div class="span12 text-left">
<div class="span12">
Copyright 2008-2023 <a href="https://www.apache.org/">Apache Software Foundation</a>. Licensed under the <a href="https://www.apache.org/licenses/">Apache License v2.0</a>. Apache Yetus and the Apache feather logo are trademarks of The Apache Software Foundation.
</div>
</div>
</div>
</footer>
</div>
</body>
</html>