yetus-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From bus...@apache.org
Subject [1/4] yetus git commit: git hash 90cd34ec098922853667436181e4c97e0d77bfdf
Date Wed, 29 Nov 2017 17:09:47 GMT
Repository: yetus
Updated Branches:
  refs/heads/asf-site 3c27a5590 -> b187b462f


http://git-wip-us.apache.org/repos/asf/yetus/blob/01a3e598/documentation/in-progress/precommit-apidocs/core/index.html
----------------------------------------------------------------------
diff --git a/documentation/in-progress/precommit-apidocs/core/index.html b/documentation/in-progress/precommit-apidocs/core/index.html
index 19cd6ae..43248c3 100644
--- a/documentation/in-progress/precommit-apidocs/core/index.html
+++ b/documentation/in-progress/precommit-apidocs/core/index.html
@@ -158,16 +158,35 @@
 <ul>
 <li><a href="#list_plugins">list_plugins</a></li>
 <li><a href="#plugin_usage_output">plugin_usage_output</a></li>
+<li><a href="#reaper_add_name">reaper_add_name</a></li>
 <li><a href="#yetus_add_header">yetus_add_header</a></li>
 <li><a href="#yetus_add_option">yetus_add_option</a></li>
 <li><a href="#yetus_comma_to_array">yetus_comma_to_array</a></li>
 <li><a href="#yetus_generic_columnprinter">yetus_generic_columnprinter</a></li>
 </ul></li>
+<li>Private/Stable/Replaceable
+
+<ul>
+<li><a href="#reaper_initialize">reaper_initialize</a></li>
+</ul></li>
+<li>Private/Evolving/Replaceable
+
+<ul>
+<li><a href="#pid_kill">pid_kill</a></li>
+</ul></li>
 <li>None/None/Not Replaceable
 
 <ul>
 <li><a href="#docker_version">docker_version</a></li>
 </ul></li>
+<li>Private/Evolving/Replaceable
+
+<ul>
+<li><a href="#reaper_coproc_func">reaper_coproc_func</a></li>
+<li><a href="#reaper_finalize_results">reaper_finalize_results</a></li>
+<li><a href="#reaper_post_exec">reaper_post_exec</a></li>
+<li><a href="#reaper_total_count">reaper_total_count</a></li>
+</ul></li>
 </ul>
 
 <hr>
@@ -1131,6 +1150,41 @@
 <td style="text-align: left">No</td>
 </tr>
 </tbody></table>
+<h3 id="reaper_add_name"><code>reaper_add_name</code></h3>
+
+<ul>
+<li>Synopsis</li>
+</ul>
+<pre class="highlight plaintext"><code>reaper_add_name
+</code></pre>
+<ul>
+<li>Description</li>
+</ul>
+
+<p>Add a regex to the reaper&rsquo;s checklist NOTE: Users WILL override anything
added before argument parsing!</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">No</td>
+</tr>
+</tbody></table>
 <h3 id="yetus_add_header"><code>yetus_add_header</code></h3>
 
 <ul>
@@ -1271,6 +1325,80 @@
 <td style="text-align: left">No</td>
 </tr>
 </tbody></table>
+<h2 id="private-stable-replaceable">Private/Stable/Replaceable</h2>
+
+<h3 id="reaper_initialize"><code>reaper_initialize</code></h3>
+
+<ul>
+<li>Synopsis</li>
+</ul>
+<pre class="highlight plaintext"><code>reaper_initialize ## @params       arguments
+</code></pre>
+<ul>
+<li>Description</li>
+</ul>
+
+<p>Initialize the reaper</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">Yes</td>
+</tr>
+</tbody></table>
+<h2 id="private-evolving-replaceable">Private/Evolving/Replaceable</h2>
+
+<h3 id="pid_kill"><code>pid_kill</code></h3>
+
+<ul>
+<li>Synopsis</li>
+</ul>
+<pre class="highlight plaintext"><code>pid_kill pid
+</code></pre>
+<ul>
+<li>Description</li>
+</ul>
+
+<p>Kill a process id</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">Yes</td>
+</tr>
+</tbody></table>
 <h2 id="none-none-not-replaceable">None/None/Not Replaceable</h2>
 
 <h3 id="docker_version"><code>docker_version</code></h3>
@@ -1308,6 +1436,148 @@
 <td style="text-align: left">No</td>
 </tr>
 </tbody></table>
+<h2 id="private-evolving-replaceable">Private/Evolving/Replaceable</h2>
+
+<h3 id="reaper_coproc_func"><code>reaper_coproc_func</code></h3>
+
+<ul>
+<li>Synopsis</li>
+</ul>
+<pre class="highlight plaintext"><code>reaper_coproc_func
+</code></pre>
+<ul>
+<li>Description</li>
+</ul>
+
+<p>Reaper coprocessor function that runs outside the law</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">Yes</td>
+</tr>
+</tbody></table>
+<h3 id="reaper_finalize_results"><code>reaper_finalize_results</code></h3>
+
+<ul>
+<li>Synopsis</li>
+</ul>
+<pre class="highlight plaintext"><code>reaper_finalize_results ## @params   
   jdkname
+</code></pre>
+<ul>
+<li>Description</li>
+</ul>
+
+<p>Reaper output to the user</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">Yes</td>
+</tr>
+</tbody></table>
+<h3 id="reaper_post_exec"><code>reaper_post_exec</code></h3>
+
+<ul>
+<li>Synopsis</li>
+</ul>
+<pre class="highlight plaintext"><code>reaper_post_exec ## @params       module
## @params       testlog ## @params       testfrag
+</code></pre>
+<ul>
+<li>Description</li>
+</ul>
+
+<p>Run the reaper</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">Yes</td>
+</tr>
+</tbody></table>
+<h3 id="reaper_total_count"><code>reaper_total_count</code></h3>
+
+<ul>
+<li>Synopsis</li>
+</ul>
+<pre class="highlight plaintext"><code>reaper_total_count ## @params       jdkname
+</code></pre>
+<ul>
+<li>Description</li>
+</ul>
+
+<p>Reaper output to the user</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">Yes</td>
+</tr>
+</tbody></table>
     </div>
       <div class="container">
     <hr>

http://git-wip-us.apache.org/repos/asf/yetus/blob/01a3e598/documentation/in-progress/precommit-apidocs/test-patch/index.html
----------------------------------------------------------------------
diff --git a/documentation/in-progress/precommit-apidocs/test-patch/index.html b/documentation/in-progress/precommit-apidocs/test-patch/index.html
index 551bafe..19309c1 100644
--- a/documentation/in-progress/precommit-apidocs/test-patch/index.html
+++ b/documentation/in-progress/precommit-apidocs/test-patch/index.html
@@ -185,6 +185,8 @@
 <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>
@@ -1835,6 +1837,76 @@
 </tbody></table>
 <h2 id="private-evolving-replaceable">Private/Evolving/Replaceable</h2>
 
+<h3 id="start_coprocessors"><code>start_coprocessors</code></h3>
+
+<ul>
+<li>Synopsis</li>
+</ul>
+<pre class="highlight plaintext"><code>start_coprocessors
+</code></pre>
+<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">Yes</td>
+</tr>
+</tbody></table>
+<h3 id="stop_coprocessors"><code>stop_coprocessors</code></h3>
+
+<ul>
+<li>Synopsis</li>
+</ul>
+<pre class="highlight plaintext"><code>stop_coprocessors
+</code></pre>
+<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">Yes</td>
+</tr>
+</tbody></table>
 <h3 id="verify_patchdir_still_exists"><code>verify_patchdir_still_exists</code></h3>
 
 <ul>

http://git-wip-us.apache.org/repos/asf/yetus/blob/01a3e598/documentation/in-progress/precommit-basic/index.html
----------------------------------------------------------------------
diff --git a/documentation/in-progress/precommit-basic/index.html b/documentation/in-progress/precommit-basic/index.html
index 32e0a7d..2af3137 100644
--- a/documentation/in-progress/precommit-basic/index.html
+++ b/documentation/in-progress/precommit-basic/index.html
@@ -156,7 +156,7 @@ as a whole.</p>
 
 <ul>
 <li>git-based project (and git 1.7.3 or higher installed)</li>
-<li>bash v3.2 or higher</li>
+<li>bash v3.2 or higher (bash v4.0 or higher is recommended)</li>
 <li>GNU diff</li>
 <li>GNU patch</li>
 <li>POSIX awk</li>
@@ -257,11 +257,13 @@ as a whole.</p>
 
 <h1 id="fork-bomb-protection">Fork Bomb Protection</h1>
 
-<p>By default, test-patch.sh will set the user soft limit (ulimit -Su) to a relatively
low 1,000 processes (and, on some operating systems, threads!). This is to prevent errant
processes from eating up all system resources.  If this limit is too low (e.g., highly threaded
Java processes), it may be necessary to use the <code>--proclimit</code> option.
 For example:</p>
+<p>By default, test-patch.sh will set the user soft limit (ulimit -Su) to a relatively
low 1,000 processes (and, on some operating systems with some languages such as Java, threads!).
This is to prevent errant processes from eating up all system resources.  If this limit is
too low, it may be necessary to use the <code>--proclimit</code> option.  For
example:</p>
 <pre class="highlight shell"><code><span class="gp">$ </span><span
class="nb">test</span>-patch --proclimit<span class="o">=</span>10000
 </code></pre>
 <p>&hellip; will set it to be 10,000 processes.</p>
 
+<p>NOTE: The actual implementation of this feature is dependent upon the version of
Bash.  For bash v4 and higher (most operating systems), the fork bomb protection is generally
only used for the build and QA tools.  This means Apache Yetus should continue to function.
For earlier versions of bash (e.g., OS X), the limit is applied to all of test-patch. If the
limit is hit, Apache Yetus will itself likely crash.</p>
+
 <h1 id="automation">Automation</h1>
 
 <p>After the tests have run, there is a directory that contains all of the test-patch
related artifacts.  This is generally referred to as the patchprocess directory.  By default,
test-patch tries to make something off of /tmp to contain this content.  Using the <code>--patch-dir</code>
option, one can specify exactly which directory to use.  This is helpful for automated precommit
testing so that Jenkins or other automated workflow system knows where to look to gather up
the output.</p>
@@ -303,7 +305,7 @@ have a location to look at the output artifacts:</p>
 <p>It is a fairly common practice within the Apache community to use Apache&rsquo;s
JIRA instance to store potential patches.  As a result, test-patch supports providing just
a JIRA issue number.  test-patch will find the <em>last</em> attachment, download
it, then process it.</p>
 
 <p><strong>NOTE: test-patch expects the patch files to follow a particular naming
convention. For complete details
- on the naming convention please refer to <a href="./precommit-patchnames/">patch-naming-conventions</a></strong></p>
+ on the naming convention please refer to <a href="../precommit-patchnames/">patch-naming-conventions</a></strong></p>
 
 <p>For example:</p>
 <pre class="highlight shell"><code><span class="gp">$ </span><span
class="nb">test</span>-patch.sh <span class="o">(</span>other options<span
class="o">)</span> HADOOP-9905
@@ -365,9 +367,9 @@ have a location to look at the output artifacts:</p>
 <p>test-patch also has a mode to utilize Docker:</p>
 <pre class="highlight shell"><code><span class="gp">$ </span><span
class="nb">test</span>-patch.sh <span class="o">(</span>other options<span
class="o">)</span> --docker
 </code></pre>
-<p>This will do some preliminary setup and then re-execute itself inside a Docker container.
 For more information on how to provide a custom Dockerfile, see the advanced guide.</p>
+<p>This will do some preliminary setup and then re-execute itself inside a Docker container.
 For more information on how to provide a custom Dockerfile and other Docker-specific features,
see the advanced guide.</p>
 
-<h2 id="in-closing">In Closing</h2>
+<h1 id="in-closing">In Closing</h1>
 
 <p>test-patch has many other features and command line options for the basic user.
 Many of these are self-explanatory.  To see the list of options, run test-patch.sh without
any options or with &ndash;help.</p>
 


Mime
View raw message