documentation/0.16.0-SNAPSHOT/precommit/apidocs/plugins/index.html - yetus - Git at Google

 <!---
   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="#maven_add_install">maven_add_install</a></li>
       <li><a href="#maven_delete_install">maven_delete_install</a></li>
       <li><a href="#maven_initialize">maven_initialize</a></li>
       <li><a href="#maven_parse_args">maven_parse_args</a></li>
     </ul>
   </li>
   <li>Public/Stable/Not Replaceable
     <ul>
       <li><a href="#maven_modules_worker">maven_modules_worker</a></li>
     </ul>
   </li>
   <li>Public/Evolving/Replaceable
     <ul>
       <li><a href="#golang_gomod_file">golang_gomod_file</a></li>
       <li><a href="#golang_gomod_find">golang_gomod_find</a></li>
     </ul>
   </li>
   <li>Private/Stable/Replaceable
     <ul>
       <li><a href="#golang_filefilter">golang_filefilter</a></li>
     </ul>
   </li>
   <li>Private/Evolving/Replaceable
     <ul>
       <li><a href="#dupname_icase_sort_array">dupname_icase_sort_array</a></li>
       <li><a href="#golang_clean">golang_clean</a></li>
       <li><a href="#golang_docker_support">golang_docker_support</a></li>
       <li><a href="#golang_logfilter">golang_logfilter</a></li>
       <li><a href="#golang_postapply">golang_postapply</a></li>
       <li><a href="#maven_builtin_personality_file_tests">maven_builtin_personality_file_tests</a></li>
       <li><a href="#maven_builtin_personality_modules">maven_builtin_personality_modules</a></li>
       <li><a href="#maven_docker_support">maven_docker_support</a></li>
     </ul>
   </li>
 </ul>

 <hr />

 <h2 id="publicstablereplaceable">Public/Stable/Replaceable</h2>
 <h3 id="maven_add_install"><code>maven_add_install</code></h3>

 <ul>
   <li>Synopsis</li>
 </ul>

 <div class="highlight"><pre class="highlight plaintext"><code>maven_add_install test
 </code></pre></div>
 <ul>
   <li>Description</li>
 </ul>

 <p>Add the given test type as requiring a mvn install during the branch phase</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">True</td>
     </tr>
   </tbody>
 </table>

 <h3 id="maven_delete_install"><code>maven_delete_install</code></h3>

 <ul>
   <li>Synopsis</li>
 </ul>

 <div class="highlight"><pre class="highlight plaintext"><code>maven_delete_install test
 </code></pre></div>
 <ul>
   <li>Description</li>
 </ul>

 <p>Remove the given test type as requiring a mvn install</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">True</td>
     </tr>
   </tbody>
 </table>

 <h3 id="maven_initialize"><code>maven_initialize</code></h3>

 <ul>
   <li>Synopsis</li>
 </ul>

 <div class="highlight"><pre class="highlight plaintext"><code>maven_initialize
 </code></pre></div>
 <ul>
   <li>Description</li>
 </ul>

 <p>initialize the maven build tool</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">True</td>
     </tr>
   </tbody>
 </table>

 <h3 id="maven_parse_args"><code>maven_parse_args</code></h3>

 <ul>
   <li>Synopsis</li>
 </ul>

 <div class="highlight"><pre class="highlight plaintext"><code>maven_parse_args
 </code></pre></div>
 <ul>
   <li>Description</li>
 </ul>

 <p>parse maven build tool args</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">True</td>
     </tr>
   </tbody>
 </table>

 <h2 id="publicstablenot-replaceable">Public/Stable/Not Replaceable</h2>
 <h3 id="maven_modules_worker"><code>maven_modules_worker</code></h3>

 <ul>
   <li>Synopsis</li>
 </ul>

 <div class="highlight"><pre class="highlight plaintext"><code>maven_modules_worker
 </code></pre></div>
 <ul>
   <li>Description</li>
 </ul>

 <p>maven version of the modules_worker routine</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="publicevolvingreplaceable">Public/Evolving/Replaceable</h2>
 <h3 id="golang_gomod_file"><code>golang_gomod_file</code></h3>

 <ul>
   <li>Synopsis</li>
 </ul>

 <div class="highlight"><pre class="highlight plaintext"><code>golang_gomod_file
 </code></pre></div>
 <ul>
   <li>Description</li>
 </ul>

 <p>Determine if a file is in GOMOD_DIRS[@]</p>

 <ul>
   <li>Returns</li>
 </ul>

 <p>all matching dirs</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">True</td>
     </tr>
   </tbody>
 </table>

 <h3 id="golang_gomod_find"><code>golang_gomod_find</code></h3>

 <ul>
   <li>Synopsis</li>
 </ul>

 <div class="highlight"><pre class="highlight plaintext"><code>golang_gomod_find
 </code></pre></div>
 <ul>
   <li>Description</li>
 </ul>

 <p>find all non-vendor directories that have a go.mod file</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">True</td>
     </tr>
   </tbody>
 </table>

 <h2 id="privatestablereplaceable">Private/Stable/Replaceable</h2>
 <h3 id="golang_filefilter"><code>golang_filefilter</code></h3>

 <ul>
   <li>Synopsis</li>
 </ul>

 <div class="highlight"><pre class="highlight plaintext"><code>golang_filefilter
 </code></pre></div>
 <ul>
   <li>Description</li>
 </ul>

 <p>discover files to check</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>

 <h2 id="privateevolvingreplaceable">Private/Evolving/Replaceable</h2>
 <h3 id="dupname_icase_sort_array"><code>dupname_icase_sort_array</code></h3>

 <ul>
   <li>Synopsis</li>
 </ul>

 <div class="highlight"><pre class="highlight plaintext"><code>dupname_icase_sort_array arrayvar
 </code></pre></div>
 <ul>
   <li>Description</li>
 </ul>

 <p>Sort an array by its elements, ignoring case</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="golang_clean"><code>golang_clean</code></h3>

 <ul>
   <li>Synopsis</li>
 </ul>

 <div class="highlight"><pre class="highlight plaintext"><code>golang_clean
 </code></pre></div>
 <ul>
   <li>Description</li>
 </ul>

 <p>set volumes and options as appropriate for maven</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="golang_docker_support"><code>golang_docker_support</code></h3>

 <ul>
   <li>Synopsis</li>
 </ul>

 <div class="highlight"><pre class="highlight plaintext"><code>golang_docker_support
 </code></pre></div>
 <ul>
   <li>Description</li>
 </ul>

 <p>set volumes and options as appropriate for maven</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="golang_logfilter"><code>golang_logfilter</code></h3>

 <ul>
   <li>Synopsis</li>
 </ul>

 <div class="highlight"><pre class="highlight plaintext"><code>golang_logfilter
 </code></pre></div>
 <ul>
   <li>Description</li>
 </ul>

 <p>Helper for generic_logfilter</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="golang_postapply"><code>golang_postapply</code></h3>

 <ul>
   <li>Synopsis</li>
 </ul>

 <div class="highlight"><pre class="highlight plaintext"><code>golang_postapply
 </code></pre></div>
 <ul>
   <li>Description</li>
 </ul>

 <p>go post</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="maven_builtin_personality_file_tests"><code>maven_builtin_personality_file_tests</code></h3>

 <ul>
   <li>Synopsis</li>
 </ul>

 <div class="highlight"><pre class="highlight plaintext"><code>maven_builtin_personality_file_tests
 </code></pre></div>
 <ul>
   <li>Description</li>
 </ul>

 <p>maven default test triggers</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="maven_builtin_personality_modules"><code>maven_builtin_personality_modules</code></h3>

 <ul>
   <li>Synopsis</li>
 </ul>

 <div class="highlight"><pre class="highlight plaintext"><code>maven_builtin_personality_modules
 </code></pre></div>
 <ul>
   <li>Description</li>
 </ul>

 <p>maven personality handler</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="maven_docker_support"><code>maven_docker_support</code></h3>

 <ul>
   <li>Synopsis</li>
 </ul>

 <div class="highlight"><pre class="highlight plaintext"><code>maven_docker_support
 </code></pre></div>
 <ul>
   <li>Description</li>
 </ul>

 <p>set volumes and options as appropriate for maven</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>


     </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>
	<!---
	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="#maven_add_install">maven_add_install</a></li>
	<li><a href="#maven_delete_install">maven_delete_install</a></li>
	<li><a href="#maven_initialize">maven_initialize</a></li>
	<li><a href="#maven_parse_args">maven_parse_args</a></li>
	</ul>
	</li>
	<li>Public/Stable/Not Replaceable
	<ul>
	<li><a href="#maven_modules_worker">maven_modules_worker</a></li>
	</ul>
	</li>
	<li>Public/Evolving/Replaceable
	<ul>
	<li><a href="#golang_gomod_file">golang_gomod_file</a></li>
	<li><a href="#golang_gomod_find">golang_gomod_find</a></li>
	</ul>
	</li>
	<li>Private/Stable/Replaceable
	<ul>
	<li><a href="#golang_filefilter">golang_filefilter</a></li>
	</ul>
	</li>
	<li>Private/Evolving/Replaceable
	<ul>
	<li><a href="#dupname_icase_sort_array">dupname_icase_sort_array</a></li>
	<li><a href="#golang_clean">golang_clean</a></li>
	<li><a href="#golang_docker_support">golang_docker_support</a></li>
	<li><a href="#golang_logfilter">golang_logfilter</a></li>
	<li><a href="#golang_postapply">golang_postapply</a></li>
	<li><a href="#maven_builtin_personality_file_tests">maven_builtin_personality_file_tests</a></li>
	<li><a href="#maven_builtin_personality_modules">maven_builtin_personality_modules</a></li>
	<li><a href="#maven_docker_support">maven_docker_support</a></li>
	</ul>
	</li>
	</ul>

	<hr />

	<h2 id="publicstablereplaceable">Public/Stable/Replaceable</h2>
	<h3 id="maven_add_install"><code>maven_add_install</code></h3>

	<ul>
	<li>Synopsis</li>
	</ul>

	<div class="highlight"><pre class="highlight plaintext"><code>maven_add_install test
	</code></pre></div>
	<ul>
	<li>Description</li>
	</ul>

	<p>Add the given test type as requiring a mvn install during the branch phase</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">True</td>
	</tr>
	</tbody>
	</table>

	<h3 id="maven_delete_install"><code>maven_delete_install</code></h3>

	<ul>
	<li>Synopsis</li>
	</ul>

	<div class="highlight"><pre class="highlight plaintext"><code>maven_delete_install test
	</code></pre></div>
	<ul>
	<li>Description</li>
	</ul>

	<p>Remove the given test type as requiring a mvn install</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">True</td>
	</tr>
	</tbody>
	</table>

	<h3 id="maven_initialize"><code>maven_initialize</code></h3>

	<ul>
	<li>Synopsis</li>
	</ul>

	<div class="highlight"><pre class="highlight plaintext"><code>maven_initialize
	</code></pre></div>
	<ul>
	<li>Description</li>
	</ul>

	<p>initialize the maven build tool</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">True</td>
	</tr>
	</tbody>
	</table>

	<h3 id="maven_parse_args"><code>maven_parse_args</code></h3>

	<ul>
	<li>Synopsis</li>
	</ul>

	<div class="highlight"><pre class="highlight plaintext"><code>maven_parse_args
	</code></pre></div>
	<ul>
	<li>Description</li>
	</ul>

	<p>parse maven build tool args</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">True</td>
	</tr>
	</tbody>
	</table>

	<h2 id="publicstablenot-replaceable">Public/Stable/Not Replaceable</h2>
	<h3 id="maven_modules_worker"><code>maven_modules_worker</code></h3>

	<ul>
	<li>Synopsis</li>
	</ul>

	<div class="highlight"><pre class="highlight plaintext"><code>maven_modules_worker
	</code></pre></div>
	<ul>
	<li>Description</li>
	</ul>

	<p>maven version of the modules_worker routine</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="publicevolvingreplaceable">Public/Evolving/Replaceable</h2>
	<h3 id="golang_gomod_file"><code>golang_gomod_file</code></h3>

	<ul>
	<li>Synopsis</li>
	</ul>

	<div class="highlight"><pre class="highlight plaintext"><code>golang_gomod_file
	</code></pre></div>
	<ul>
	<li>Description</li>
	</ul>

	<p>Determine if a file is in GOMOD_DIRS[@]</p>

	<ul>
	<li>Returns</li>
	</ul>

	<p>all matching dirs</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">True</td>
	</tr>
	</tbody>
	</table>

	<h3 id="golang_gomod_find"><code>golang_gomod_find</code></h3>

	<ul>
	<li>Synopsis</li>
	</ul>

	<div class="highlight"><pre class="highlight plaintext"><code>golang_gomod_find
	</code></pre></div>
	<ul>
	<li>Description</li>
	</ul>

	<p>find all non-vendor directories that have a go.mod file</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">True</td>
	</tr>
	</tbody>
	</table>

	<h2 id="privatestablereplaceable">Private/Stable/Replaceable</h2>
	<h3 id="golang_filefilter"><code>golang_filefilter</code></h3>

	<ul>
	<li>Synopsis</li>
	</ul>

	<div class="highlight"><pre class="highlight plaintext"><code>golang_filefilter
	</code></pre></div>
	<ul>
	<li>Description</li>
	</ul>

	<p>discover files to check</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>

	<h2 id="privateevolvingreplaceable">Private/Evolving/Replaceable</h2>
	<h3 id="dupname_icase_sort_array"><code>dupname_icase_sort_array</code></h3>

	<ul>
	<li>Synopsis</li>
	</ul>

	<div class="highlight"><pre class="highlight plaintext"><code>dupname_icase_sort_array arrayvar
	</code></pre></div>
	<ul>
	<li>Description</li>
	</ul>

	<p>Sort an array by its elements, ignoring case</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="golang_clean"><code>golang_clean</code></h3>

	<ul>
	<li>Synopsis</li>
	</ul>

	<div class="highlight"><pre class="highlight plaintext"><code>golang_clean
	</code></pre></div>
	<ul>
	<li>Description</li>
	</ul>

	<p>set volumes and options as appropriate for maven</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="golang_docker_support"><code>golang_docker_support</code></h3>

	<ul>
	<li>Synopsis</li>
	</ul>

	<div class="highlight"><pre class="highlight plaintext"><code>golang_docker_support
	</code></pre></div>
	<ul>
	<li>Description</li>
	</ul>

	<p>set volumes and options as appropriate for maven</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="golang_logfilter"><code>golang_logfilter</code></h3>

	<ul>
	<li>Synopsis</li>
	</ul>

	<div class="highlight"><pre class="highlight plaintext"><code>golang_logfilter
	</code></pre></div>
	<ul>
	<li>Description</li>
	</ul>

	<p>Helper for generic_logfilter</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="golang_postapply"><code>golang_postapply</code></h3>

	<ul>
	<li>Synopsis</li>
	</ul>

	<div class="highlight"><pre class="highlight plaintext"><code>golang_postapply
	</code></pre></div>
	<ul>
	<li>Description</li>
	</ul>

	<p>go post</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="maven_builtin_personality_file_tests"><code>maven_builtin_personality_file_tests</code></h3>

	<ul>
	<li>Synopsis</li>
	</ul>

	<div class="highlight"><pre class="highlight plaintext"><code>maven_builtin_personality_file_tests
	</code></pre></div>
	<ul>
	<li>Description</li>
	</ul>

	<p>maven default test triggers</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="maven_builtin_personality_modules"><code>maven_builtin_personality_modules</code></h3>

	<ul>
	<li>Synopsis</li>
	</ul>

	<div class="highlight"><pre class="highlight plaintext"><code>maven_builtin_personality_modules
	</code></pre></div>
	<ul>
	<li>Description</li>
	</ul>

	<p>maven personality handler</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="maven_docker_support"><code>maven_docker_support</code></h3>

	<ul>
	<li>Synopsis</li>
	</ul>

	<div class="highlight"><pre class="highlight plaintext"><code>maven_docker_support
	</code></pre></div>
	<ul>
	<li>Description</li>
	</ul>

	<p>set volumes and options as appropriate for maven</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>


	</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>