http://git-wip-us.apache.org/repos/asf/yetus/blob/d709aeb5/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 ce4a7f9..fb9e341 100644 --- a/documentation/in-progress/precommit-advanced/index.html +++ b/documentation/in-progress/precommit-advanced/index.html @@ -118,7 +118,7 @@ under the License. --> -<h1 id="test-patch">test-patch</h1> +<h1>test-patch</h1> <ul> <li><a href="#Docker_Support">Docker Support</a></li> @@ -127,11 +127,11 @@ <li><a href="#Important_Variables">Important Variables</a></li> </ul> -<h1 id="docker-support">Docker Support</h1> +<h1>Docker Support</h1> <p>By default, test-patch runs in the same shell where it was launched. It can alternatively use Docker to launch itself in a container. This is particularly useful if running under a QA environment that does not provide all the necessary binaries. For example, if the patch requires a newer version of Java than what is installed on a Jenkins instance.</p> -<p>The <code>--docker</code> parameter tells test-patch to run in Docker mode. The <code>--dockerfile</code> parameter allows one to provide a custom Dockerfile. The Dockerfile should contain all of the necessary binaries and tooling needed to run the test. test-patch will copy this file up until the text “YETUS CUT HERE” to a different directory and then append its necessary hooks to re-launch itself prior to executing docker.</p> +<p>The <code>--docker</code> parameter tells test-patch to run in Docker mode. The <code>--dockerfile</code> parameter allows one to provide a custom Dockerfile. The Dockerfile should contain all of the necessary binaries and tooling needed to run the test. test-patch will copy this file up until the text <q>YETUS CUT HERE</q> to a different directory and then append its necessary hooks to re-launch itself prior to executing docker.</p> <p>If a custom Dockerfile cannot be used or the docker executable does not work, test-patch will attempt to recover by switching to its bundled Dockerfile or disabling docker support and running locally. This behavior can be changed with the <code>--dockeronfail</code> option. It takes a list of comma-delimited settings:</p> @@ -141,35 +141,37 @@ <li>fail - fail the test</li> </ul> -<p>The ‘fail’ setting is always the last option that test-patch will use and may be omitted unless it is the only option.</p> +<p>The 'fail' setting is always the last option that test-patch will use and may be omitted unless it is the only option.</p> -<p>For example, <code>--dockeronfail=continue</code> means if the Dockerfile can’t be found, just turn off Docker support and continue running. <code>--dockeronfail=fallback</code> will switch to the bundled Dockerfile and then fail the build if docker fails to work. <code>--dockeronfail=fail</code> means to just fail the build and do not try any other mechanisms of recovery. The default is 'fallback,continue,fail’ which will allow test-patch to try to continue executing as much as it possibily can.</p> +<p>For example, <code>--dockeronfail=continue</code> means if the Dockerfile can't be found, just turn off Docker support and continue running. <code>--dockeronfail=fallback</code> will switch to the bundled Dockerfile and then fail the build if docker fails to work. <code>--dockeronfail=fail</code> means to just fail the build and do not try any other mechanisms of recovery. The default is 'fallback,continue,fail' which will allow test-patch to try to continue executing as much as it possibily can.</p> <p>Be aware that if the Dockerfile is found and the docker command works, test-patch will always fail the build if the Dockerfile itself fails the build. It will not attempt to continue in the non-Docker mode.</p> -<p>NOTE: If you are using Boot2Docker, you must use directories under /Users (OSX) or C:\Users (Windows) as the base and patchprocess directories (specified by the –basedir and –patch-dir options respectively), because automatically mountable directories are limited to them. See <a href="https://docs.docker.com/userguide/dockervolumes/#mount-a-host-directory-as-a-data-volume";>the Docker documentation</a>.</p> +<p>NOTE: If you are using Boot2Docker, you must use directories under /Users (OSX) or C:\Users (Windows) as the base and patchprocess directories (specified by the --basedir and --patch-dir options respectively), because automatically mountable directories are limited to them. See <a href="https://docs.docker.com/userguide/dockervolumes/#mount-a-host-directory-as-a-data-volume";>the Docker documentation</a>.</p> -<p>Dockerfile images will be named with a test-patch prefix and suffix with either a date or a git commit hash. By using this information, test-patch will automatically manage broken/stale container images that are hanging around if it is run in –robot mode. In this way, if Docker fails to build the image, the disk space should eventually be cleaned and returned back to the system. The docker mode can also be run in a “safe” mode that prevents deletions via the <code>--dockerdelrep</code> option. Specifying this option will cause test-patch to only report what it would have deleted, but not actually remove anything.</p> +<p>Dockerfile images will be named with a test-patch prefix and suffix with either a date or a git commit hash. By using this information, test-patch will automatically manage broken/stale container images that are hanging around if it is run in --robot mode. In this way, if Docker fails to build the image, the disk space should eventually be cleaned and returned back to the system. The docker mode can also be run in a <q>safe</q> mode that prevents deletions via the <code>--dockerdelrep</code> option. Specifying this option will cause test-patch to only report what it would have deleted, but not actually remove anything.</p> -<h1 id="plug-ins">Plug-ins</h1> +<h1>Plug-ins</h1> <p>test-patch allows one to add to its basic feature set via plug-ins. There is a directory called test-patch.d off of the directory where test-patch.sh lives. Inside this directory one may place some bash shell fragments that, if setup with proper functions, will allow for test-patch to call it as necessary. Different plug-ins have specific functions for that particular functionality. In this document, the common functions available to all/most plug-ins are covered. Test plugins are covered below. See other documentation for pertinent information for the other plug-in types.</p> -<h2 id="common-plug-in-functions">Common Plug-in Functions</h2> +<h2>Common Plug-in Functions</h2> -<p>Every plug-in must have one line in order to be recognized, usually an 'add’ statement. Test plug-ins, for example, have this statement:</p> -<pre class="highlight shell"><code>add_test_type <pluginname> +<p>Every plug-in must have one line in order to be recognized, usually an 'add' statement. Test plug-ins, for example, have this statement:</p> + +<pre><code class="bash">add_test_type <pluginname> </code></pre> -<p>This function call registers the <code>pluginname</code> so that test-patch knows that it exists. Plug-in names must be unique across all the different plug-in types. Additionally, the 'all’ plug-in is reserved. The <code>pluginname</code> also acts as the key to the custom functions that you can define. For example:</p> -<pre class="highlight shell"><code><span class="k">function </span>pluginname_filefilter +<p>This function call registers the <code>pluginname</code> so that test-patch knows that it exists. Plug-in names must be unique across all the different plug-in types. Additionally, the 'all' plug-in is reserved. The <code>pluginname</code> also acts as the key to the custom functions that you can define. For example:</p> + +<pre><code class="bash">function pluginname_filefilter </code></pre> <p>defines the filefilter for the <code>pluginname</code> plug-in.</p> <p>Similarly, there are other functions that may be defined during the test-patch run:</p> -<pre class="highlight plaintext"><code>HINT: It is recommended to make the pluginname relatively small, 10 characters at the most. Otherwise, the ASCII output table may be skewed. -</code></pre> + +<p>HINT: It is recommended to make the pluginname relatively small, 10 characters at the most. Otherwise, the ASCII output table may be skewed.</p> <ul> <li><p>pluginname_usage</p> @@ -214,7 +216,7 @@ </ul></li> </ul> -<h2 id="plug-in-importation">Plug-in Importation</h2> +<h2>Plug-in Importation</h2> <p>Plug-ins are imported from several key directories:</p> @@ -226,10 +228,11 @@ <p>If the <code>--skip-system-plugins</code> flag is passed, then only core.d is imported.</p> -<h2 id="test-plug-ins">Test Plug-ins</h2> +<h2>Test Plug-ins</h2> <p>Plug-ins geared towards independent tests are registered via:</p> -<pre class="highlight shell"><code>add_test_type <pluginname> + +<pre><code class="bash">add_test_type <pluginname> </code></pre> <ul> @@ -241,7 +244,7 @@ <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> +<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> @@ -261,13 +264,13 @@ <li><p>pluginname_calcdiffs</p> <ul> -<li>This allows for custom log file difference calculation used to determine the before and after views. The default is to use the last column of a colon delimited line of output and perform a diff. If the plug-in does not provide enough context, this may result in error skew. For example, if three lines in a row have “Missing period.” as the error, test-patch will not be able to determine exactly which line caused the error. Plug-ins that have this issue will want to use this or potentially modify the normal tool’s output (e.g., checkstyle) to provide a more accurate way to determine differences.</li> +<li>This allows for custom log file difference calculation used to determine the before and after views. The default is to use the last column of a colon delimited line of output and perform a diff. If the plug-in does not provide enough context, this may result in error skew. For example, if three lines in a row have <q>Missing period.</q> as the error, test-patch will not be able to determine exactly which line caused the error. Plug-ins that have this issue will want to use this or potentially modify the normal tool's output (e.g., checkstyle) to provide a more accurate way to determine differences.</li> </ul></li> </ul> -<h1 id="personalities">Personalities</h1> +<h1>Personalities</h1> -<h2 id="configuring-for-other-projects">Configuring for Other Projects</h2> +<h2>Configuring for Other Projects</h2> <p>It is impossible for any general framework to be predictive about what types of special rules any given project may have, especially when it comes to ordering and Maven profiles. In order to direct test-patch to do the correct action, a project <code>personality</code> should be added that enacts these custom rules.</p> @@ -275,41 +278,44 @@ <p>There can be only <strong>one</strong> of each personality function defined.</p> -<h2 id="global-definitions">Global Definitions</h2> +<h2>Global Definitions</h2> <p>Globals for personalities should be defined in the <code>personality_globals</code> function. This function is called <em>after</em> the other plug-ins have been imported. This allows one to configure any settings for plug-ins that have been imported safely:</p> -<pre class="highlight shell"><code>funciton personality_globals -<span class="o">{</span> - <span class="nv">PATCH_BRANCH_DEFAULT</span><span class="o">=</span>master - <span class="nv">GITHUB_REPO</span><span class="o">=</span><span class="s2">"apache/yetus"</span> -<span class="o">}</span> + +<pre><code class="bash">funciton personality_globals +{ + PATCH_BRANCH_DEFAULT=master + GITHUB_REPO="apache/yetus" +} </code></pre> -<h2 id="test-determination">Test Determination</h2> +<h2>Test Determination</h2> <p>The <code>personality_file_tests</code> function determines which tests to turn on based upon the file name. It is relatively simple. For example, to turn on a full suite of tests for Java files:</p> -<pre class="highlight shell"><code><span class="k">function </span>personality_file_tests -<span class="o">{</span> - <span class="nb">local </span><span class="nv">filename</span><span class="o">=</span><span class="nv">$1</span> - <span class="k">if</span> <span class="o">[[</span> <span class="k">${</span><span class="nv">filename</span><span class="k">}</span> <span class="o">=</span>~ <span class="se">\.</span>java<span class="nv">$ </span><span class="o">]]</span>; <span class="k">then - </span>add_test findbugs +<pre><code class="bash">function personality_file_tests +{ + local filename=$1 + + if [[ ${filename} =~ \.java$ ]]; then + add_test findbugs add_test javac add_test javadoc add_test mvninstall add_test unit - <span class="k">fi</span> + fi -<span class="o">}</span> +} </code></pre> <p>The <code>add_test</code> function is used to activate the standard tests. Additional plug-ins (such as checkstyle), will get queried on their own.</p> -<h2 id="module-amp-profile-determination">Module & Profile Determination</h2> +<h2>Module & Profile Determination</h2> + +<p>Once the tests are determined, it is now time to pick which <a href="precommit-glossary.md#genericoutside-definitions">modules</a> should get used. That's the job of the <code>personality_modules</code> function.</p> -<p>Once the tests are determined, it is now time to pick which <a href="precommit-glossary.md#genericoutside-definitions">modules</a> should get used. That’s the job of the <code>personality_modules</code> function.</p> -<pre class="highlight shell"><code><span class="k">function </span>personality_modules -<span class="o">{</span> +<pre><code class="bash">function personality_modules +{ clear_personality_queue @@ -317,7 +323,7 @@ personality_enqueue_module <module> <flags> -<span class="o">}</span> +} </code></pre> <p>It takes exactly two parameters <code>repostatus</code> and <code>testtype</code>.</p> @@ -328,37 +334,39 @@ <p>In order to communicate back to test-patch, there are two functions for the personality to use.</p> -<p>The first is <code>clear_personality_queue</code>. This removes the previous test’s configuration so that a new module queue may be built. Custom <code>personality_modules</code> will almost always want to do this as the first action.</p> +<p>The first is <code>clear_personality_queue</code>. This removes the previous test's configuration so that a new module queue may be built. Custom <code>personality_modules</code> will almost always want to do this as the first action.</p> -<p>The second is <code>personality_enqueue_module</code>. This function takes two parameters. The first parameter is the name of the module to add to this test’s queue. The second parameter is an option list of additional flags to pass to Maven when processing it. <code>personality_enqueue_module</code> may be called as many times as necessary for your project.</p> -<pre class="highlight plaintext"><code>NOTE: A module name of . signifies the root of the repository. -</code></pre> +<p>The second is <code>personality_enqueue_module</code>. This function takes two parameters. The first parameter is the name of the module to add to this test's queue. The second parameter is an option list of additional flags to pass to Maven when processing it. <code>personality_enqueue_module</code> may be called as many times as necessary for your project.</p> -<p>For example, let’s say your project uses a special configuration to skip unit tests (-DskipTests). Running unit tests during a javadoc build isn’t very useful and wastes a lot of time. We can write a simple personality check to disable the unit tests:</p> -<pre class="highlight shell"><code><span class="k">function </span>personality_modules -<span class="o">{</span> - <span class="nb">local </span><span class="nv">repostatus</span><span class="o">=</span><span class="nv">$1</span> - <span class="nb">local </span><span class="nv">testtype</span><span class="o">=</span><span class="nv">$2</span> +<p>NOTE: A module name of . signifies the root of the repository.</p> - <span class="k">if</span> <span class="o">[[</span> <span class="k">${</span><span class="nv">testtype</span><span class="k">}</span> <span class="o">==</span> <span class="s1">'javadoc'</span> <span class="o">]]</span>; <span class="k">then - </span>personality_enqueue_module . -DskipTests - <span class="k">return - fi</span> +<p>For example, let's say your project uses a special configuration to skip unit tests (-DskipTests). Running unit tests during a javadoc build isn't very useful and wastes a lot of time. We can write a simple personality check to disable the unit tests:</p> + +<pre><code class="bash">function personality_modules +{ + local repostatus=$1 + local testtype=$2 + + if [[ ${testtype} == 'javadoc' ]]; then + personality_enqueue_module . -DskipTests + return + fi ... </code></pre> <p>This function will tell test-patch that when the javadoc test is being run, do the documentation build at the base of the source repository and make sure the -DskipTests flag is passed to our build tool.</p> -<h2 id="enabling-plug-ins">Enabling Plug-ins</h2> +<h2>Enabling Plug-ins</h2> <p>Personalities can set the base list of plug-ins to enable and disable for their project via the <code>personality_plugins</code> function. Just call it with the same pattern as the <code>--plugins</code> command line option:</p> -<pre class="highlight shell"><code>personality_plugins <span class="s2">"all,-checkstyle,-findbugs,-asflicense"</span> + +<pre><code class="bash">personality_plugins "all,-checkstyle,-findbugs,-asflicense" </code></pre> <p>This list is used if the user does not provide a list of plug-ins.</p> -<h1 id="important-variables">Important Variables</h1> +<h1>Important Variables</h1> <p>There are a handful of extremely important system variables that make life easier for personality and plug-in writers. Other variables may be provided by individual plug-ins. Check their development documentation for more information.</p> @@ -366,13 +374,13 @@ <li><p>BUILD_NATIVE will be set to true if the system has requested that non-JVM-based code be built (e.g., JNI or other compiled C code). Under Jenkins, this is always true.</p></li> <li><p>BUILDTOOL specifies which tool is currently being used to drive compilation. Additionally, many build tools define xyz_ARGS to pass on to the build tool command line. (e.g., MAVEN_ARGS if maven is in use). Projects may set this in their personality. NOTE: today, only one build tool at a time is supported. This may change in the future.</p></li> <li><p>CHANGED_FILES is a list of all files that appear to be added, deleted, or modified in the patch.</p></li> -<li><p>CHANGED_MODULES is a list of all modules that house all of the CHANGED_FILES. Be aware that the root of the source tree is reported as ’.’.</p></li> +<li><p>CHANGED_MODULES is a list of all modules that house all of the CHANGED_FILES. Be aware that the root of the source tree is reported as '.'.</p></li> <li><p>GITHUB_REPO is to help test-patch when talking to Github. If test-patch is given just a number on the command line, it will default to using this repo to determine the pull request.</p></li> <li><p>JIRA_ISSUE_RE is to help test-patch when talking to JIRA. It helps determine if the given project is appropriate for the given JIRA issue.</p></li> <li><p>MODULE and other MODULE_* are arrays that contain which modules, the status, etc, to be operated upon. These should be treated as read-only by plug-ins.</p></li> <li><p>PATCH_BRANCH_DEFAULT is the name of the branch in the git repo that is considered the master. This is useful to set in personalities.</p></li> <li><p>PATCH_DIR is the name of the temporary directory that houses test-patch artifacts (such as logs and the patch file itself)</p></li> -<li><p>PATCH_NAMING_RULE should be a URL that points to a project’s on-boarding documentation for new users. It is used to suggest a review of patch naming guidelines. Since this should be project specific information, it is useful to set in a project’s personality.</p></li> +<li><p>PATCH_NAMING_RULE should be a URL that points to a project's on-boarding documentation for new users. It is used to suggest a review of patch naming guidelines. Since this should be project specific information, it is useful to set in a project's personality.</p></li> <li><p>TEST_PARALLEL if parallel unit tests have been requested. Project personalities are responsible for actually enabling or ignoring the request. TEST_THREADS is the number of threads that have been requested to run in parallel.</p></li> </ul> @@ -383,7 +391,7 @@ <div class="row-fluid"> <div class="span12 text-left"> <div class="span12"> - Copyright 2008-2015 <a href="http://www.apache.org/";>Apache Software Foundation</a>. Licensed under the <a href="http://www.apache.org/licenses/";>Apache License v2.0</a>. Apache Yetus and the Apache feather logo are trademarks of The Apache Software Foundation. + Copyright 2008-2016 <a href="http://www.apache.org/";>Apache Software Foundation</a>. Licensed under the <a href="http://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>
http://git-wip-us.apache.org/repos/asf/yetus/blob/d709aeb5/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 ee5542e..e443032 100644 --- a/documentation/in-progress/precommit-apidocs/core/index.html +++ b/documentation/in-progress/precommit-apidocs/core/index.html @@ -168,14 +168,15 @@ <hr> -<h2 id="public-stable-replaceable">Public/Stable/Replaceable</h2> +<h2>Public/Stable/Replaceable</h2> -<h3 id="add_bugsystem"><code>add_bugsystem</code></h3> +<h3><code>add_bugsystem</code></h3> <ul> <li>Synopsis</li> </ul> -<pre class="highlight plaintext"><code>add_bugsystem bugsystem + +<pre><code>add_bugsystem bugsystem </code></pre> <ul> @@ -189,14 +190,11 @@ </ul> <p>Nothing</p> - -<table><thead> -<tr> +<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> +</thead><tbody><tr> <td style="text-align: left">Audience</td> <td style="text-align: left">Public</td> </tr> @@ -209,13 +207,13 @@ <td style="text-align: left">Yes</td> </tr> </tbody></table> - -<h3 id="add_build_tool"><code>add_build_tool</code></h3> +<h3><code>add_build_tool</code></h3> <ul> <li>Synopsis</li> </ul> -<pre class="highlight plaintext"><code>add_build_tool build tool + +<pre><code>add_build_tool build tool </code></pre> <ul> @@ -229,14 +227,11 @@ </ul> <p>Nothing</p> - -<table><thead> -<tr> +<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> +</thead><tbody><tr> <td style="text-align: left">Audience</td> <td style="text-align: left">Public</td> </tr> @@ -249,13 +244,13 @@ <td style="text-align: left">Yes</td> </tr> </tbody></table> - -<h3 id="add_test"><code>add_test</code></h3> +<h3><code>add_test</code></h3> <ul> <li>Synopsis</li> </ul> -<pre class="highlight plaintext"><code>add_test test + +<pre><code>add_test test </code></pre> <ul> @@ -269,14 +264,11 @@ </ul> <p>Nothing</p> - -<table><thead> -<tr> +<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> +</thead><tbody><tr> <td style="text-align: left">Audience</td> <td style="text-align: left">Public</td> </tr> @@ -289,13 +281,13 @@ <td style="text-align: left">Yes</td> </tr> </tbody></table> - -<h3 id="add_test_format"><code>add_test_format</code></h3> +<h3><code>add_test_format</code></h3> <ul> <li>Synopsis</li> </ul> -<pre class="highlight plaintext"><code>add_test_format test format + +<pre><code>add_test_format test format </code></pre> <ul> @@ -309,14 +301,11 @@ </ul> <p>Nothing</p> - -<table><thead> -<tr> +<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> +</thead><tbody><tr> <td style="text-align: left">Audience</td> <td style="text-align: left">Public</td> </tr> @@ -329,13 +318,13 @@ <td style="text-align: left">Yes</td> </tr> </tbody></table> - -<h3 id="add_test_type"><code>add_test_type</code></h3> +<h3><code>add_test_type</code></h3> <ul> <li>Synopsis</li> </ul> -<pre class="highlight plaintext"><code>add_test_type plugin + +<pre><code>add_test_type plugin </code></pre> <ul> @@ -349,14 +338,11 @@ </ul> <p>Nothing</p> - -<table><thead> -<tr> +<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> +</thead><tbody><tr> <td style="text-align: left">Audience</td> <td style="text-align: left">Public</td> </tr> @@ -369,13 +355,13 @@ <td style="text-align: left">Yes</td> </tr> </tbody></table> - -<h3 id="delete_bugsystem"><code>delete_bugsystem</code></h3> +<h3><code>delete_bugsystem</code></h3> <ul> <li>Synopsis</li> </ul> -<pre class="highlight plaintext"><code>delete_bugsystem bugsystem + +<pre><code>delete_bugsystem bugsystem </code></pre> <ul> @@ -389,14 +375,11 @@ </ul> <p>Nothing</p> - -<table><thead> -<tr> +<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> +</thead><tbody><tr> <td style="text-align: left">Audience</td> <td style="text-align: left">Public</td> </tr> @@ -409,13 +392,13 @@ <td style="text-align: left">Yes</td> </tr> </tbody></table> - -<h3 id="delete_build_tool"><code>delete_build_tool</code></h3> +<h3><code>delete_build_tool</code></h3> <ul> <li>Synopsis</li> </ul> -<pre class="highlight plaintext"><code>delete_build_tool build tool + +<pre><code>delete_build_tool build tool </code></pre> <ul> @@ -429,14 +412,11 @@ </ul> <p>Nothing</p> - -<table><thead> -<tr> +<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> +</thead><tbody><tr> <td style="text-align: left">Audience</td> <td style="text-align: left">Public</td> </tr> @@ -449,13 +429,13 @@ <td style="text-align: left">Yes</td> </tr> </tbody></table> - -<h3 id="delete_test"><code>delete_test</code></h3> +<h3><code>delete_test</code></h3> <ul> <li>Synopsis</li> </ul> -<pre class="highlight plaintext"><code>delete_test test + +<pre><code>delete_test test </code></pre> <ul> @@ -469,14 +449,11 @@ </ul> <p>Nothing</p> - -<table><thead> -<tr> +<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> +</thead><tbody><tr> <td style="text-align: left">Audience</td> <td style="text-align: left">Public</td> </tr> @@ -489,13 +466,13 @@ <td style="text-align: left">Yes</td> </tr> </tbody></table> - -<h3 id="delete_test_format"><code>delete_test_format</code></h3> +<h3><code>delete_test_format</code></h3> <ul> <li>Synopsis</li> </ul> -<pre class="highlight plaintext"><code>delete_test_format test format + +<pre><code>delete_test_format test format </code></pre> <ul> @@ -509,14 +486,11 @@ </ul> <p>Nothing</p> - -<table><thead> -<tr> +<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> +</thead><tbody><tr> <td style="text-align: left">Audience</td> <td style="text-align: left">Public</td> </tr> @@ -529,13 +503,13 @@ <td style="text-align: left">Yes</td> </tr> </tbody></table> - -<h3 id="delete_test_type"><code>delete_test_type</code></h3> +<h3><code>delete_test_type</code></h3> <ul> <li>Synopsis</li> </ul> -<pre class="highlight plaintext"><code>delete_test_type plugin + +<pre><code>delete_test_type plugin </code></pre> <ul> @@ -549,14 +523,11 @@ </ul> <p>Nothing</p> - -<table><thead> -<tr> +<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> +</thead><tbody><tr> <td style="text-align: left">Audience</td> <td style="text-align: left">Public</td> </tr> @@ -569,13 +540,13 @@ <td style="text-align: left">Yes</td> </tr> </tbody></table> - -<h3 id="personality_plugins"><code>personality_plugins</code></h3> +<h3><code>personality_plugins</code></h3> <ul> <li>Synopsis</li> </ul> -<pre class="highlight plaintext"><code>personality_plugins plug-in list string + +<pre><code>personality_plugins plug-in list string </code></pre> <ul> @@ -589,14 +560,11 @@ </ul> <p>Nothing</p> - -<table><thead> -<tr> +<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> +</thead><tbody><tr> <td style="text-align: left">Audience</td> <td style="text-align: left">Public</td> </tr> @@ -609,13 +577,13 @@ <td style="text-align: left">Yes</td> </tr> </tbody></table> - -<h3 id="verify_needed_test"><code>verify_needed_test</code></h3> +<h3><code>verify_needed_test</code></h3> <ul> <li>Synopsis</li> </ul> -<pre class="highlight plaintext"><code>verify_needed_test test + +<pre><code>verify_needed_test test </code></pre> <ul> @@ -631,14 +599,11 @@ <p>1 = yes</p> <p>0 = no</p> - -<table><thead> -<tr> +<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> +</thead><tbody><tr> <td style="text-align: left">Audience</td> <td style="text-align: left">Public</td> </tr> @@ -651,13 +616,13 @@ <td style="text-align: left">Yes</td> </tr> </tbody></table> - -<h3 id="verify_plugin_enabled"><code>verify_plugin_enabled</code></h3> +<h3><code>verify_plugin_enabled</code></h3> <ul> <li>Synopsis</li> </ul> -<pre class="highlight plaintext"><code>verify_plugin_enabled test + +<pre><code>verify_plugin_enabled test </code></pre> <ul> @@ -671,14 +636,11 @@ </ul> <p>Nothing</p> - -<table><thead> -<tr> +<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> +</thead><tbody><tr> <td style="text-align: left">Audience</td> <td style="text-align: left">Public</td> </tr> @@ -691,15 +653,15 @@ <td style="text-align: left">Yes</td> </tr> </tbody></table> +<h2>Public/Stable/Not Replaceable</h2> -<h2 id="public-stable-not-replaceable">Public/Stable/Not Replaceable</h2> - -<h3 id="common_defaults"><code>common_defaults</code></h3> +<h3><code>common_defaults</code></h3> <ul> <li>Synopsis</li> </ul> -<pre class="highlight plaintext"><code>common_defaults + +<pre><code>common_defaults </code></pre> <ul> @@ -713,14 +675,11 @@ </ul> <p>Nothing</p> - -<table><thead> -<tr> +<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> +</thead><tbody><tr> <td style="text-align: left">Audience</td> <td style="text-align: left">Public</td> </tr> @@ -733,34 +692,31 @@ <td style="text-align: left">No</td> </tr> </tbody></table> - -<h3 id="patchfile_verify_zero"><code>patchfile_verify_zero</code></h3> +<h3><code>patchfile_verify_zero</code></h3> <ul> <li>Synopsis</li> </ul> -<pre class="highlight plaintext"><code>patchfile_verify_zero log filename + +<pre><code>patchfile_verify_zero log filename </code></pre> <ul> <li>Description</li> </ul> -<p>if patch-level zero, then verify we aren’t just adding files</p> +<p>if patch-level zero, then verify we aren't just adding files</p> <ul> <li>Returns</li> </ul> <p>$?</p> - -<table><thead> -<tr> +<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> +</thead><tbody><tr> <td style="text-align: left">Audience</td> <td style="text-align: left">Public</td> </tr> @@ -773,13 +729,13 @@ <td style="text-align: left">No</td> </tr> </tbody></table> - -<h3 id="yetus_abs"><code>yetus_abs</code></h3> +<h3><code>yetus_abs</code></h3> <ul> <li>Synopsis</li> </ul> -<pre class="highlight plaintext"><code>yetus_abs directory + +<pre><code>yetus_abs directory </code></pre> <ul> @@ -797,14 +753,11 @@ <p>1 failure</p> <p>stdout abspath</p> - -<table><thead> -<tr> +<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> +</thead><tbody><tr> <td style="text-align: left">Audience</td> <td style="text-align: left">Public</td> </tr> @@ -817,13 +770,13 @@ <td style="text-align: left">No</td> </tr> </tbody></table> - -<h3 id="yetus_add_entry"><code>yetus_add_entry</code></h3> +<h3><code>yetus_add_entry</code></h3> <ul> <li>Synopsis</li> </ul> -<pre class="highlight plaintext"><code>yetus_add_entry + +<pre><code>yetus_add_entry </code></pre> <ul> @@ -837,14 +790,11 @@ </ul> <p>Nothing</p> - -<table><thead> -<tr> +<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> +</thead><tbody><tr> <td style="text-align: left">Audience</td> <td style="text-align: left">Public</td> </tr> @@ -857,34 +807,31 @@ <td style="text-align: left">No</td> </tr> </tbody></table> - -<h3 id="yetus_debug"><code>yetus_debug</code></h3> +<h3><code>yetus_debug</code></h3> <ul> <li>Synopsis</li> </ul> -<pre class="highlight plaintext"><code>yetus_debug string + +<pre><code>yetus_debug string </code></pre> <ul> <li>Description</li> </ul> -<p>Print a message to stderr if –debug is turned on</p> +<p>Print a message to stderr if --debug is turned on</p> <ul> <li>Returns</li> </ul> <p>Nothing</p> - -<table><thead> -<tr> +<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> +</thead><tbody><tr> <td style="text-align: left">Audience</td> <td style="text-align: left">Public</td> </tr> @@ -897,13 +844,13 @@ <td style="text-align: left">No</td> </tr> </tbody></table> - -<h3 id="yetus_delete_entry"><code>yetus_delete_entry</code></h3> +<h3><code>yetus_delete_entry</code></h3> <ul> <li>Synopsis</li> </ul> -<pre class="highlight plaintext"><code>yetus_delete_entry + +<pre><code>yetus_delete_entry </code></pre> <ul> @@ -917,14 +864,11 @@ </ul> <p>Nothing</p> - -<table><thead> -<tr> +<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> +</thead><tbody><tr> <td style="text-align: left">Audience</td> <td style="text-align: left">Public</td> </tr> @@ -937,13 +881,13 @@ <td style="text-align: left">No</td> </tr> </tbody></table> - -<h3 id="yetus_error"><code>yetus_error</code></h3> +<h3><code>yetus_error</code></h3> <ul> <li>Synopsis</li> </ul> -<pre class="highlight plaintext"><code>yetus_error string + +<pre><code>yetus_error string </code></pre> <ul> @@ -957,14 +901,11 @@ </ul> <p>Nothing</p> - -<table><thead> -<tr> +<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> +</thead><tbody><tr> <td style="text-align: left">Audience</td> <td style="text-align: left">Public</td> </tr> @@ -977,13 +918,13 @@ <td style="text-align: left">No</td> </tr> </tbody></table> - -<h3 id="yetus_run_and_redirect"><code>yetus_run_and_redirect</code></h3> +<h3><code>yetus_run_and_redirect</code></h3> <ul> <li>Synopsis</li> </ul> -<pre class="highlight plaintext"><code>yetus_run_and_redirect filename command [..] + +<pre><code>yetus_run_and_redirect filename command [..] </code></pre> <ul> @@ -997,14 +938,11 @@ </ul> <p>$?</p> - -<table><thead> -<tr> +<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> +</thead><tbody><tr> <td style="text-align: left">Audience</td> <td style="text-align: left">Public</td> </tr> @@ -1017,13 +955,13 @@ <td style="text-align: left">No</td> </tr> </tbody></table> - -<h3 id="yetus_verify_entry"><code>yetus_verify_entry</code></h3> +<h3><code>yetus_verify_entry</code></h3> <ul> <li>Synopsis</li> </ul> -<pre class="highlight plaintext"><code>yetus_verify_entry + +<pre><code>yetus_verify_entry </code></pre> <ul> @@ -1037,14 +975,11 @@ </ul> <p>1 = yes, 0 = no</p> - -<table><thead> -<tr> +<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> +</thead><tbody><tr> <td style="text-align: left">Audience</td> <td style="text-align: left">Public</td> </tr> @@ -1057,15 +992,15 @@ <td style="text-align: left">No</td> </tr> </tbody></table> +<h2>Public/Evolving/Not Replaceable</h2> -<h2 id="public-evolving-not-replaceable">Public/Evolving/Not Replaceable</h2> - -<h3 id="list_plugins"><code>list_plugins</code></h3> +<h3><code>list_plugins</code></h3> <ul> <li>Synopsis</li> </ul> -<pre class="highlight plaintext"><code>list_plugins + +<pre><code>list_plugins </code></pre> <ul> @@ -1079,14 +1014,11 @@ </ul> <p>Nothing</p> - -<table><thead> -<tr> +<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> +</thead><tbody><tr> <td style="text-align: left">Audience</td> <td style="text-align: left">Public</td> </tr> @@ -1099,34 +1031,31 @@ <td style="text-align: left">No</td> </tr> </tbody></table> - -<h3 id="plugin_usage_output"><code>plugin_usage_output</code></h3> +<h3><code>plugin_usage_output</code></h3> <ul> <li>Synopsis</li> </ul> -<pre class="highlight plaintext"><code>plugin_usage_output array + +<pre><code>plugin_usage_output array </code></pre> <ul> <li>Description</li> </ul> -<p>Print the plugin’s usage info</p> +<p>Print the plugin's usage info</p> <ul> <li>Returns</li> </ul> <p>Nothing</p> - -<table><thead> -<tr> +<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> +</thead><tbody><tr> <td style="text-align: left">Audience</td> <td style="text-align: left">Public</td> </tr> @@ -1139,13 +1068,13 @@ <td style="text-align: left">No</td> </tr> </tbody></table> - -<h3 id="yetus_add_header"><code>yetus_add_header</code></h3> +<h3><code>yetus_add_header</code></h3> <ul> <li>Synopsis</li> </ul> -<pre class="highlight plaintext"><code>yetus_add_header header + +<pre><code>yetus_add_header header </code></pre> <ul> @@ -1159,14 +1088,11 @@ </ul> <p>Nothing</p> - -<table><thead> -<tr> +<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> +</thead><tbody><tr> <td style="text-align: left">Audience</td> <td style="text-align: left">Public</td> </tr> @@ -1179,13 +1105,13 @@ <td style="text-align: left">No</td> </tr> </tbody></table> - -<h3 id="yetus_add_option"><code>yetus_add_option</code></h3> +<h3><code>yetus_add_option</code></h3> <ul> <li>Synopsis</li> </ul> -<pre class="highlight plaintext"><code>yetus_add_option subcommand subcommanddesc + +<pre><code>yetus_add_option subcommand subcommanddesc </code></pre> <ul> @@ -1199,14 +1125,11 @@ </ul> <p>Nothing</p> - -<table><thead> -<tr> +<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> +</thead><tbody><tr> <td style="text-align: left">Audience</td> <td style="text-align: left">Public</td> </tr> @@ -1219,13 +1142,13 @@ <td style="text-align: left">No</td> </tr> </tbody></table> - -<h3 id="yetus_generic_columnprinter"><code>yetus_generic_columnprinter</code></h3> +<h3><code>yetus_generic_columnprinter</code></h3> <ul> <li>Synopsis</li> </ul> -<pre class="highlight plaintext"><code>yetus_generic_columnprinter array + +<pre><code>yetus_generic_columnprinter array </code></pre> <ul> @@ -1239,14 +1162,11 @@ </ul> <p>Nothing</p> - -<table><thead> -<tr> +<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> +</thead><tbody><tr> <td style="text-align: left">Audience</td> <td style="text-align: left">Public</td> </tr> @@ -1259,15 +1179,15 @@ <td style="text-align: left">No</td> </tr> </tbody></table> +<h2>None/None/Not Replaceable</h2> -<h2 id="none-none-not-replaceable">None/None/Not Replaceable</h2> - -<h3 id="docker_version"><code>docker_version</code></h3> +<h3><code>docker_version</code></h3> <ul> <li>Synopsis</li> </ul> -<pre class="highlight plaintext"><code>docker_version + +<pre><code>docker_version </code></pre> <ul> @@ -1281,14 +1201,11 @@ </ul> <p>Nothing</p> - -<table><thead> -<tr> +<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> +</thead><tbody><tr> <td style="text-align: left">Audience</td> <td style="text-align: left">None</td> </tr> @@ -1301,13 +1218,13 @@ <td style="text-align: left">No</td> </tr> </tbody></table> - -<h3 id="personality_file_tests"><code>personality_file_tests</code></h3> +<h3><code>personality_file_tests</code></h3> <ul> <li>Synopsis</li> </ul> -<pre class="highlight plaintext"><code>personality_file_tests + +<pre><code>personality_file_tests </code></pre> <ul> @@ -1321,14 +1238,11 @@ </ul> <p>Nothing</p> - -<table><thead> -<tr> +<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> +</thead><tbody><tr> <td style="text-align: left">Audience</td> <td style="text-align: left">None</td> </tr> @@ -1341,13 +1255,13 @@ <td style="text-align: left">No</td> </tr> </tbody></table> - -<h3 id="personality_modules"><code>personality_modules</code></h3> +<h3><code>personality_modules</code></h3> <ul> <li>Synopsis</li> </ul> -<pre class="highlight plaintext"><code>personality_modules + +<pre><code>personality_modules </code></pre> <ul> @@ -1361,14 +1275,11 @@ </ul> <p>Nothing</p> - -<table><thead> -<tr> +<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> +</thead><tbody><tr> <td style="text-align: left">Audience</td> <td style="text-align: left">None</td> </tr> @@ -1381,7 +1292,6 @@ <td style="text-align: left">No</td> </tr> </tbody></table> - </div> <div class="container"> <hr> @@ -1389,7 +1299,7 @@ <div class="row-fluid"> <div class="span12 text-left"> <div class="span12"> - Copyright 2008-2015 <a href="http://www.apache.org/";>Apache Software Foundation</a>. Licensed under the <a href="http://www.apache.org/licenses/";>Apache License v2.0</a>. Apache Yetus and the Apache feather logo are trademarks of The Apache Software Foundation. + Copyright 2008-2016 <a href="http://www.apache.org/";>Apache Software Foundation</a>. Licensed under the <a href="http://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> http://git-wip-us.apache.org/repos/asf/yetus/blob/d709aeb5/documentation/in-progress/precommit-apidocs/index.html ---------------------------------------------------------------------- diff --git a/documentation/in-progress/precommit-apidocs/index.html b/documentation/in-progress/precommit-apidocs/index.html index a5d5bc6..53ea1ed 100644 --- a/documentation/in-progress/precommit-apidocs/index.html +++ b/documentation/in-progress/precommit-apidocs/index.html @@ -118,7 +118,7 @@ under the License. --> -<h1 id="precommit-api-docs">Precommit API Docs</h1> +<h1>Precommit API Docs</h1> <p>Following gives the downstream consumable API for precommit components.</p> @@ -136,7 +136,7 @@ <div class="row-fluid"> <div class="span12 text-left"> <div class="span12"> - Copyright 2008-2015 <a href="http://www.apache.org/";>Apache Software Foundation</a>. Licensed under the <a href="http://www.apache.org/licenses/";>Apache License v2.0</a>. Apache Yetus and the Apache feather logo are trademarks of The Apache Software Foundation. + Copyright 2008-2016 <a href="http://www.apache.org/";>Apache Software Foundation</a>. Licensed under the <a href="http://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>
