You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@yetus.apache.org by aw...@apache.org on 2016/01/18 20:32:53 UTC
yetus git commit: git hash d6481ff4e679967c4209b05b4bff89d170660b8b
Repository: yetus
Updated Branches:
refs/heads/asf-site 4c370cc2a -> a3d1695dc
git hash d6481ff4e679967c4209b05b4bff89d170660b8b
Project: http://git-wip-us.apache.org/repos/asf/yetus/repo
Commit: http://git-wip-us.apache.org/repos/asf/yetus/commit/a3d1695d
Tree: http://git-wip-us.apache.org/repos/asf/yetus/tree/a3d1695d
Diff: http://git-wip-us.apache.org/repos/asf/yetus/diff/a3d1695d
Branch: refs/heads/asf-site
Commit: a3d1695dc6d9e2f0d81f2d3961c7c1f2f15d9474
Parents: 4c370cc
Author: Allen Wittenauer <aw...@apache.org>
Authored: Mon Jan 18 11:32:49 2016 -0800
Committer: Allen Wittenauer <aw...@apache.org>
Committed: Mon Jan 18 11:32:49 2016 -0800
----------------------------------------------------------------------
.../in-progress/precommit-advanced/index.html | 33 +++++---
.../precommit-apidocs/test-patch/index.html | 82 ++++++++++++++++++++
.../in-progress/precommit-buildtools/index.html | 9 ++-
3 files changed, 113 insertions(+), 11 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/yetus/blob/a3d1695d/documentation/in-progress/precommit-advanced/index.html
----------------------------------------------------------------------
diff --git a/documentation/in-progress/precommit-advanced/index.html b/documentation/in-progress/precommit-advanced/index.html
index 6ac68df..c0017f5 100644
--- a/documentation/in-progress/precommit-advanced/index.html
+++ b/documentation/in-progress/precommit-advanced/index.html
@@ -172,11 +172,6 @@
</code></pre>
<ul>
-<li><p>pluginname_initialize</p>
-
-<ul>
-<li>After argument parsing and prior to any other work, the initialize step allows a plug-in to do any precursor work, set internal defaults, etc.</li>
-</ul></li>
<li><p>pluginname_usage</p>
<ul>
@@ -187,20 +182,25 @@
<ul>
<li>executed prior to any other above functions except for pluginname_usage. This is useful for parsing the arguments passed from the user and setting up the execution environment.</li>
</ul></li>
+<li><p>pluginname_initialize</p>
+
+<ul>
+<li>After argument parsing and prior to any other work, the initialize step allows a plug-in to do any precursor work, set internal defaults, etc.</li>
+</ul></li>
<li><p>pluginname_precheck</p>
<ul>
<li>executed prior to the patch being applied but after the git repository is setup. Returning a fail status here will exit test-patch.</li>
</ul></li>
-<li><p>pluginname_precompile</p>
+<li><p>pluginname_patchfile</p>
<ul>
-<li>executed prior to the compilation part of the lifecycle. This is useful for doing setup work required by the compilation process.</li>
+<li>executed prior to the patch being applied but after the git repository is setup. This step is intended to perform tests on the content of the patch itself.</li>
</ul></li>
-<li><p>pluginname_compile</p>
+<li><p>pluginname_precompile</p>
<ul>
-<li>executed immediately after the actual compilation. This is step is intended to be used to verify the results and add extra checking of the compile phase and it’s stdout/stderr.</li>
+<li>executed prior to the compilation part of the lifecycle. This is useful for doing setup work required by the compilation process.</li>
</ul></li>
<li><p>pluginname_postcompile</p>
@@ -238,11 +238,26 @@
<ul>
<li>executed while determine which files trigger which tests. This function should use <code>add_test pluginname</code> to add the plug-in to the test list.</li>
</ul></li>
+<li><p>pluginname_compile</p>
+
+<ul>
+<li>executed immediately after the actual compilation. This step is intended to be used to verify the results and add extra checking of the compile phase and it’s stdout/stderr.</li>
+</ul></li>
<li><p>pluginname_tests</p>
<ul>
<li>executed after the unit tests have completed.</li>
</ul></li>
+<li><p>pluginname_clean</p>
+
+<ul>
+<li>executed to allow the plugin to remove all files that have been generate by this plugin.</li>
+</ul></li>
+<li><p>pluginname_logfilter</p>
+
+<ul>
+<li>This functions should filter all lines relevant to this test from the logfile. It is called in preparation for the <code>calcdiffs</code> function.</li>
+</ul></li>
<li><p>pluginname_calcdiffs</p>
<ul>
http://git-wip-us.apache.org/repos/asf/yetus/blob/a3d1695d/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 711d198..9cb994a 100644
--- a/documentation/in-progress/precommit-apidocs/test-patch/index.html
+++ b/documentation/in-progress/precommit-apidocs/test-patch/index.html
@@ -152,8 +152,10 @@
<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="#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>
@@ -1115,6 +1117,46 @@
</tr>
</tbody></table>
+<h3 id="dequeue_personality_module"><code>dequeue_personality_module</code></h3>
+
+<ul>
+<li>Synopsis</li>
+</ul>
+<pre class="highlight plaintext"><code>dequeue_personality_module modulenames
+</code></pre>
+
+<ul>
+<li>Description</li>
+</ul>
+
+<p>Remove a module</p>
+
+<ul>
+<li>Returns</li>
+</ul>
+
+<p>Nothing</p>
+
+<table><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="distclean"><code>distclean</code></h3>
<ul>
@@ -1197,6 +1239,46 @@
</tr>
</tbody></table>
+<h3 id="generic_calcdiff_status"><code>generic_calcdiff_status</code></h3>
+
+<ul>
+<li>Synopsis</li>
+</ul>
+<pre class="highlight plaintext"><code>generic_calcdiff_status totalbranchissues totalpatchissues newpatchissues
+</code></pre>
+
+<ul>
+<li>Description</li>
+</ul>
+
+<p>generate a standarized calcdiff status message</p>
+
+<ul>
+<li>Returns</li>
+</ul>
+
+<p>errorstring</p>
+
+<table><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="generic_logfilter"><code>generic_logfilter</code></h3>
<ul>
http://git-wip-us.apache.org/repos/asf/yetus/blob/a3d1695d/documentation/in-progress/precommit-buildtools/index.html
----------------------------------------------------------------------
diff --git a/documentation/in-progress/precommit-buildtools/index.html b/documentation/in-progress/precommit-buildtools/index.html
index 27a0e63..93ba89a 100644
--- a/documentation/in-progress/precommit-buildtools/index.html
+++ b/documentation/in-progress/precommit-buildtools/index.html
@@ -189,10 +189,15 @@
<ul>
<li>After argument parsing and prior to any other work, the initialize step allows a plug-in to do any precursor work, set internal defaults, etc.</li>
</ul></li>
-<li><p>pluginname_count_(test)_probs</p>
+<li><p>pluginname_reorder_modules</p>
<ul>
-<li>Certain language test plug-ins require assistance from the build tool to count problems in the compile log due to some tools having custom handling for those languages. The test plug-in name should be in the (test) part of the function name.</li>
+<li>This functions allows the plugin to (re-)order the modules (e.g. based on the output of the maven dependency plugin). When called CHANGED_MODULES already contains all changed modules. It must be altered to have an effect.</li>
+</ul></li>
+<li><p>pluginname_(test)_logfilter</p>
+
+<ul>
+<li>This functions should filter all lines relevant to this test from the logfile. It is called in preparation for the <code>calcdiffs</code> function. The test plug-in name should be in the (test) part of the function name.</li>
</ul></li>
<li><p>pluginname_(test)_calcdiffs</p>