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 2020/09/13 17:40:20 UTC
[yetus] branch asf-site updated: git sha
906a2202ae72e2249233ac89588c6e5d48cbc3e8
This is an automated email from the ASF dual-hosted git repository.
aw pushed a commit to branch asf-site
in repository https://gitbox.apache.org/repos/asf/yetus.git
The following commit(s) were added to refs/heads/asf-site by this push:
new 6d04573 git sha 906a2202ae72e2249233ac89588c6e5d48cbc3e8
6d04573 is described below
commit 6d04573a06327c41f31bc3dc92c10a7d6694bc91
Author: Allen Wittenauer <aw...@apache.org>
AuthorDate: Sun Sep 13 10:39:50 2020 -0700
git sha 906a2202ae72e2249233ac89588c6e5d48cbc3e8
---
README.md | 2 +-
contribute/releases/index.html | 46 +-
contribute/website/index.html | 10 +-
.../interface-classification/index.html | 360 ---
.../0.13.0-SNAPSHOT/precommit-admin/index.html | 222 --
.../0.13.0-SNAPSHOT/precommit-advanced/index.html | 455 ----
.../precommit-apidocs/core/index.html | 2699 --------------------
.../0.13.0-SNAPSHOT/precommit-apidocs/index.html | 153 --
.../precommit-apidocs/plugins/index.html | 876 -------
.../precommit-apidocs/smart-apply-patch/index.html | 240 --
.../precommit-apidocs/test-patch/index.html | 2350 -----------------
.../precommit-architecture/index.html | 248 --
.../0.13.0-SNAPSHOT/precommit-basic/index.html | 514 ----
.../precommit-bugsystems/index.html | 268 --
.../precommit-buildtools/index.html | 338 ---
.../precommit-docker-cleanup/index.html | 185 --
.../0.13.0-SNAPSHOT/precommit-docker/index.html | 214 --
.../0.13.0-SNAPSHOT/precommit-glossary/index.html | 176 --
.../precommit-patchnames/index.html | 181 --
.../0.13.0-SNAPSHOT/precommit-qbt/index.html | 207 --
.../0.13.0-SNAPSHOT/precommit-robots/index.html | 418 ---
.../precommit-smart-apply-patch/index.html | 170 --
.../precommit-testformats/index.html | 172 --
.../0.13.0-SNAPSHOT/releasedocmaker/index.html | 347 ---
documentation/0.13.0-SNAPSHOT/shelldocs/index.html | 326 ---
.../0.13.0-SNAPSHOT/yetus-maven-plugin/index.html | 542 ----
documentation/in-progress/CHANGELOG | 18 +-
.../in-progress/javadocs/allclasses-frame.html | 4 +-
.../javadocs/allclasses-frame/index.html | 4 +-
.../in-progress/javadocs/allclasses-noframe.html | 4 +-
.../javadocs/allclasses-noframe/index.html | 4 +-
.../in-progress/javadocs/constant-values.html | 4 +-
.../javadocs/constant-values/index.html | 4 +-
.../in-progress/javadocs/deprecated-list.html | 4 +-
.../javadocs/deprecated-list/index.html | 4 +-
documentation/in-progress/javadocs/help-doc.html | 4 +-
.../in-progress/javadocs/help-doc/index.html | 4 +-
documentation/in-progress/javadocs/index-all.html | 4 +-
.../in-progress/javadocs/index-all/index.html | 4 +-
documentation/in-progress/javadocs/index.html | 2 +-
.../audience/InterfaceAudience.LimitedPrivate.html | 4 +-
.../InterfaceAudience.LimitedPrivate/index.html | 4 +-
.../yetus/audience/InterfaceAudience.Private.html | 4 +-
.../audience/InterfaceAudience.Private/index.html | 4 +-
.../yetus/audience/InterfaceAudience.Public.html | 4 +-
.../audience/InterfaceAudience.Public/index.html | 4 +-
.../apache/yetus/audience/InterfaceAudience.html | 4 +-
.../yetus/audience/InterfaceAudience/index.html | 4 +-
.../audience/InterfaceStability.Evolving.html | 4 +-
.../InterfaceStability.Evolving/index.html | 4 +-
.../yetus/audience/InterfaceStability.Stable.html | 4 +-
.../audience/InterfaceStability.Stable/index.html | 4 +-
.../audience/InterfaceStability.Unstable.html | 4 +-
.../InterfaceStability.Unstable/index.html | 4 +-
.../apache/yetus/audience/InterfaceStability.html | 4 +-
.../yetus/audience/InterfaceStability/index.html | 4 +-
.../InterfaceAudience.LimitedPrivate.html | 4 +-
.../InterfaceAudience.LimitedPrivate/index.html | 4 +-
.../class-use/InterfaceAudience.Private.html | 4 +-
.../class-use/InterfaceAudience.Private/index.html | 4 +-
.../class-use/InterfaceAudience.Public.html | 4 +-
.../class-use/InterfaceAudience.Public/index.html | 4 +-
.../audience/class-use/InterfaceAudience.html | 4 +-
.../class-use/InterfaceAudience/index.html | 4 +-
.../class-use/InterfaceStability.Evolving.html | 4 +-
.../InterfaceStability.Evolving/index.html | 4 +-
.../class-use/InterfaceStability.Stable.html | 4 +-
.../class-use/InterfaceStability.Stable/index.html | 4 +-
.../class-use/InterfaceStability.Unstable.html | 4 +-
.../InterfaceStability.Unstable/index.html | 4 +-
.../audience/class-use/InterfaceStability.html | 4 +-
.../class-use/InterfaceStability/index.html | 4 +-
.../org/apache/yetus/audience/package-frame.html | 4 +-
.../apache/yetus/audience/package-frame/index.html | 4 +-
.../org/apache/yetus/audience/package-summary.html | 4 +-
.../yetus/audience/package-summary/index.html | 4 +-
.../org/apache/yetus/audience/package-tree.html | 4 +-
.../apache/yetus/audience/package-tree/index.html | 4 +-
.../org/apache/yetus/audience/package-use.html | 4 +-
.../apache/yetus/audience/package-use/index.html | 4 +-
.../ExcludePrivateAnnotationsJDiffDoclet.html | 4 +-
.../index.html | 4 +-
.../ExcludePrivateAnnotationsStandardDoclet.html | 4 +-
.../index.html | 4 +-
.../IncludePublicAnnotationsStandardDoclet.html | 4 +-
.../index.html | 4 +-
.../ExcludePrivateAnnotationsJDiffDoclet.html | 4 +-
.../index.html | 4 +-
.../ExcludePrivateAnnotationsStandardDoclet.html | 4 +-
.../index.html | 4 +-
.../IncludePublicAnnotationsStandardDoclet.html | 4 +-
.../index.html | 4 +-
.../apache/yetus/audience/tools/package-frame.html | 4 +-
.../yetus/audience/tools/package-frame/index.html | 4 +-
.../yetus/audience/tools/package-summary.html | 4 +-
.../audience/tools/package-summary/index.html | 4 +-
.../apache/yetus/audience/tools/package-tree.html | 4 +-
.../yetus/audience/tools/package-tree/index.html | 4 +-
.../apache/yetus/audience/tools/package-use.html | 4 +-
.../yetus/audience/tools/package-use/index.html | 4 +-
.../yetus/maven/plugin/fileops/package-frame.html | 4 +-
.../maven/plugin/fileops/package-frame/index.html | 4 +-
.../maven/plugin/fileops/package-summary.html | 4 +-
.../plugin/fileops/package-summary/index.html | 4 +-
.../yetus/maven/plugin/fileops/package-tree.html | 4 +-
.../maven/plugin/fileops/package-tree/index.html | 4 +-
.../yetus/maven/plugin/fileops/package-use.html | 4 +-
.../maven/plugin/fileops/package-use/index.html | 4 +-
.../yetus/maven/plugin/rdm/package-frame.html | 4 +-
.../maven/plugin/rdm/package-frame/index.html | 4 +-
.../yetus/maven/plugin/rdm/package-summary.html | 4 +-
.../maven/plugin/rdm/package-summary/index.html | 4 +-
.../yetus/maven/plugin/rdm/package-tree.html | 4 +-
.../yetus/maven/plugin/rdm/package-tree/index.html | 4 +-
.../apache/yetus/maven/plugin/rdm/package-use.html | 4 +-
.../yetus/maven/plugin/rdm/package-use/index.html | 4 +-
.../maven/plugin/shelldocs/package-frame.html | 4 +-
.../plugin/shelldocs/package-frame/index.html | 4 +-
.../maven/plugin/shelldocs/package-summary.html | 4 +-
.../plugin/shelldocs/package-summary/index.html | 4 +-
.../yetus/maven/plugin/shelldocs/package-tree.html | 4 +-
.../maven/plugin/shelldocs/package-tree/index.html | 4 +-
.../yetus/maven/plugin/shelldocs/package-use.html | 4 +-
.../maven/plugin/shelldocs/package-use/index.html | 4 +-
.../yetus/maven/plugin/utils/package-frame.html | 4 +-
.../maven/plugin/utils/package-frame/index.html | 4 +-
.../yetus/maven/plugin/utils/package-summary.html | 4 +-
.../maven/plugin/utils/package-summary/index.html | 4 +-
.../yetus/maven/plugin/utils/package-tree.html | 4 +-
.../maven/plugin/utils/package-tree/index.html | 4 +-
.../yetus/maven/plugin/utils/package-use.html | 4 +-
.../maven/plugin/utils/package-use/index.html | 4 +-
.../yetus/releasedocmaker/ReleaseDocMaker.html | 4 +-
.../releasedocmaker/ReleaseDocMaker/index.html | 4 +-
.../releasedocmaker/class-use/ReleaseDocMaker.html | 4 +-
.../class-use/ReleaseDocMaker/index.html | 4 +-
.../yetus/releasedocmaker/package-frame.html | 4 +-
.../yetus/releasedocmaker/package-frame/index.html | 4 +-
.../yetus/releasedocmaker/package-summary.html | 4 +-
.../releasedocmaker/package-summary/index.html | 4 +-
.../apache/yetus/releasedocmaker/package-tree.html | 4 +-
.../yetus/releasedocmaker/package-tree/index.html | 4 +-
.../apache/yetus/releasedocmaker/package-use.html | 4 +-
.../yetus/releasedocmaker/package-use/index.html | 4 +-
.../org/apache/yetus/shelldocs/ShellDocs.html | 4 +-
.../apache/yetus/shelldocs/ShellDocs/index.html | 4 +-
.../yetus/shelldocs/class-use/ShellDocs.html | 4 +-
.../yetus/shelldocs/class-use/ShellDocs/index.html | 4 +-
.../org/apache/yetus/shelldocs/package-frame.html | 4 +-
.../yetus/shelldocs/package-frame/index.html | 4 +-
.../apache/yetus/shelldocs/package-summary.html | 4 +-
.../yetus/shelldocs/package-summary/index.html | 4 +-
.../org/apache/yetus/shelldocs/package-tree.html | 4 +-
.../apache/yetus/shelldocs/package-tree/index.html | 4 +-
.../org/apache/yetus/shelldocs/package-use.html | 4 +-
.../apache/yetus/shelldocs/package-use/index.html | 4 +-
.../in-progress/javadocs/overview-frame.html | 4 +-
.../in-progress/javadocs/overview-frame/index.html | 4 +-
.../in-progress/javadocs/overview-summary.html | 4 +-
.../javadocs/overview-summary/index.html | 4 +-
.../in-progress/javadocs/overview-tree.html | 4 +-
.../in-progress/javadocs/overview-tree/index.html | 4 +-
.../in-progress/precommit-advanced/index.html | 4 +-
.../in-progress/precommit-basic/index.html | 4 +-
.../in-progress/precommit-robots/index.html | 18 +-
.../in-progress/precommit-testformats/index.html | 2 +-
downloads/index.html | 2 +-
project-reports.html | 4 +-
yetus-docker-image/index.html | 2 +-
169 files changed, 333 insertions(+), 11978 deletions(-)
diff --git a/README.md b/README.md
index 94bc0ab..1c31819 100644
--- a/README.md
+++ b/README.md
@@ -74,7 +74,7 @@ After executing one or more of the Apache Maven commands, artifacts will be in `
## Container Quickstart
-The project makes available two convenience container images on <https://hub.docker.com> for both tagged releases and for the master branch. It is highly recommended that casual users use a tagged release so as to not be surprised by incompatible changes that are still rolling through the master branch.
+The project makes available two convenience container images on <https://hub.docker.com> for both tagged releases and for the main branch. It is highly recommended that casual users use a tagged release so as to not be surprised by incompatible changes that are still rolling through the main branch.
### apache/yetus-base
diff --git a/contribute/releases/index.html b/contribute/releases/index.html
index c94b1a8..765d726 100644
--- a/contribute/releases/index.html
+++ b/contribute/releases/index.html
@@ -235,23 +235,23 @@ For example, on the 0.7.0 release, you would use <code>https://issues.apache.org
<h3 id="work-in-git">Work in Git</h3>
-<p>Once you have an issue to track things, you can create the git branch for staging our release. This separate branch will allow you to polish the release while regular work continues on the master branch. You will need to update master for the next SNAPSHOT version and the branch for the release.</p>
+<p>Once you have an issue to track things, you can create the git branch for staging our release. This separate branch will allow you to polish the release while regular work continues on the main branch. You will need to update main for the next SNAPSHOT version and the branch for the release.</p>
<p>Example commands, presuming the release under management is <strong>0.7.0</strong> and the JIRA issue is <strong>YETUS-XXX</strong>:</p>
-<div class="highlight"><pre class="highlight shell"><code><span class="nv">$ </span><span class="c"># Ensure master is up to date</span>
+<div class="highlight"><pre class="highlight shell"><code><span class="nv">$ </span><span class="c"># Ensure main is up to date</span>
<span class="nv">$ </span>mvn clean
<span class="nv">$ </span>git fetch origin
<span class="nv">$ </span>git status
-<span class="c"># On branch master</span>
-<span class="c"># Your branch is behind 'origin/master' by 6 commits, and can be fast-forwarded.</span>
+<span class="c"># On branch main</span>
+<span class="c"># Your branch is behind 'origin/main' by 6 commits, and can be fast-forwarded.</span>
<span class="c">#</span>
nothing to commit <span class="o">(</span>working directory clean<span class="o">)</span>
-<span class="nv">$ </span>git rebase origin/master
+<span class="nv">$ </span>git rebase origin/main
First, rewinding <span class="nb">head </span>to replay your work on top of it...
-Fast-forwarded master to origin/master.
+Fast-forwarded main to origin/main.
<span class="nv">$ </span>git status
-<span class="c"># On branch master</span>
+<span class="c"># On branch main</span>
nothing to commit <span class="o">(</span>working directory clean<span class="o">)</span>
<span class="nv">$ </span><span class="c"># create a branch and push without changes</span>
<span class="nv">$ </span>git checkout <span class="nt">-b</span> YETUS-XXX
@@ -275,12 +275,12 @@ yetus-minimaven-plugin/pom.xml
<div class="highlight"><pre class="highlight shell"><code><span class="nv">$ </span>perl <span class="nt">-pi</span> <span class="nt">-e</span> <span class="s1">'s,0.7.0-SNAPSHOT,0.7.0,g'</span> <span class="si">$(</span>find <span class="nb">.</span> <span class="nt">-type</span> f<span class="si">)</span>
</code></pre></div>
-<p>After you are done, create a branch-specific patch and then prepare to update the master branch.</p>
+<p>After you are done, create a branch-specific patch and then prepare to update the main branch.</p>
<div class="highlight"><pre class="highlight shell"><code><span class="nv">$ </span>git add <span class="nt">-p</span>
<span class="nv">$ </span>git commit <span class="nt">-m</span> <span class="s2">"YETUS-XXX. Stage version 0.7.0."</span>
<span class="nv">$ </span>git format-patch <span class="nt">--stdout</span> origin/YETUS-XXX <span class="o">></span> path/to/patches/YETUS-XXX-YETUS-XXX.1.patch
-<span class="nv">$ </span>git checkout master
+<span class="nv">$ </span>git checkout main
<span class="nv">$ </span><span class="nb">grep</span> <span class="nt">-rl</span> <span class="s2">"0.7.0-SNAPSHOT"</span> <span class="k">*</span> 2>/dev/null
asf-site-src/pom.xml
audience-annotations-component/audience-annotations/pom.xml
@@ -301,8 +301,8 @@ yetus-minimaven-plugin/pom.xml
<p>After you are done, create a patch.</p>
<div class="highlight"><pre class="highlight shell"><code><span class="nv">$ </span>git add <span class="nt">-p</span>
-<span class="nv">$ </span>git commit <span class="nt">-m</span> <span class="s2">"YETUS-XXX. bump master version to 0.8.0-SNAPSHOT"</span>
-<span class="nv">$ </span>git format-patch <span class="nt">--stdout</span> origin/master <span class="o">></span> path/to/patches/YETUS-XXX.1.patch
+<span class="nv">$ </span>git commit <span class="nt">-m</span> <span class="s2">"YETUS-XXX. bump main version to 0.8.0-SNAPSHOT"</span>
+<span class="nv">$ </span>git format-patch <span class="nt">--stdout</span> origin/main <span class="o">></span> path/to/patches/YETUS-XXX.1.patch
</code></pre></div>
<p>Both of these patch files should be uploaded to your release issue for review. Push them to the repository once the patches get approval.</p>
@@ -502,20 +502,20 @@ gpg: Good signature from <span class="s2">"Sean Busbey (CODE SIGNING KEY) <bu
| | | | tags.
| +1 | test4tests | 0m 0s | The patch appears to include 2 new or
| | | | modified <span class="nb">test </span>files.
- | +1 | mvninstall | 4m 41s | master passed
- | +1 | compile | 1m 4s | master passed with JDK v1.8.0_72
- | +1 | compile | 0m 57s | master passed with JDK v1.7.0_95
- | +1 | checkstyle | 0m 36s | master passed
- | +1 | mvneclipse | 0m 35s | master passed
- | <span class="nt">-1</span> | findbugs | 1m 6s | hbase-client <span class="k">in </span>master has 19 extant
+ | +1 | mvninstall | 4m 41s | main passed
+ | +1 | compile | 1m 4s | main passed with JDK v1.8.0_72
+ | +1 | compile | 0m 57s | main passed with JDK v1.7.0_95
+ | +1 | checkstyle | 0m 36s | main passed
+ | +1 | mvneclipse | 0m 35s | main passed
+ | <span class="nt">-1</span> | findbugs | 1m 6s | hbase-client <span class="k">in </span>main has 19 extant
| | | | Findbugs warnings.
- | <span class="nt">-1</span> | findbugs | 2m 8s | hbase-server <span class="k">in </span>master has 84 extant
+ | <span class="nt">-1</span> | findbugs | 2m 8s | hbase-server <span class="k">in </span>main has 84 extant
| | | | Findbugs warnings.
- | <span class="nt">-1</span> | javadoc | 0m 23s | hbase-client <span class="k">in </span>master failed with JDK
+ | <span class="nt">-1</span> | javadoc | 0m 23s | hbase-client <span class="k">in </span>main failed with JDK
| | | | v1.8.0_72.
- | <span class="nt">-1</span> | javadoc | 0m 34s | hbase-server <span class="k">in </span>master failed with JDK
+ | <span class="nt">-1</span> | javadoc | 0m 34s | hbase-server <span class="k">in </span>main failed with JDK
| | | | v1.8.0_72.
- | +1 | javadoc | 0m 57s | master passed with JDK v1.7.0_95
+ | +1 | javadoc | 0m 57s | main passed with JDK v1.7.0_95
| +1 | mvninstall | 1m 3s | the patch passed
| +1 | compile | 0m 59s | the patch passed with JDK v1.8.0_72
| +1 | javac | 0m 59s | the patch passed
@@ -559,7 +559,7 @@ gpg: Good signature from <span class="s2">"Sean Busbey (CODE SIGNING KEY) <bu
| <span class="nb">uname</span> | Linux 67e02eb9aeea 3.13.0-36-lowlatency <span class="c">#63-Ubuntu SMP PREEMPT Wed Sep 3 21:56:12 UTC 2014 x86_64 x86_64 x86_64 GNU/Linux |</span>
| Build tool | maven |
| Personality | /testptch/patchprocess/precommit/personality/hbase.sh |
- | git revision | master / 81a6fff |
+ | git revision | main / 81a6fff |
| findbugs | v2.0.1 |
| findbugs | /testptch/patchprocess/branch-findbugs-hbase-client-warnings.html |
| findbugs | /testptch/patchprocess/branch-findbugs-hbase-server-warnings.html |
@@ -678,7 +678,7 @@ gpg: Good signature from <span class="s2">"Sean Busbey (CODE SIGNING KEY) <bu
<span class="nv">$ </span>brew upgrade <span class="nt">--build-from-source</span> Formula/yetus.rb
</code></pre></div> </li>
<li>
- <p>Update the documentation in the git master branch for the new release. Remove the oldest release and add the latest.</p>
+ <p>Update the documentation in the git main branch for the new release. Remove the oldest release and add the latest.</p>
<div class="highlight"><pre class="highlight shell"><code><span class="nv">$ </span><span class="nb">cd </span>asf-site-src
<span class="nv">$ </span><span class="c"># Add the release to the releases data file</span>
diff --git a/contribute/website/index.html b/contribute/website/index.html
index dfde895..fa3bb49 100644
--- a/contribute/website/index.html
+++ b/contribute/website/index.html
@@ -195,8 +195,8 @@ bundle <span class="nb">exec </span>middleman
<span class="nv">$ </span><span class="c"># Now build in the normal yetus check out</span>
<span class="nv">$ </span><span class="nb">cd </span>yetus
<span class="nv">$ </span>git fetch origin
-<span class="nv">$ </span>git checkout master
-<span class="nv">$ </span>git reset <span class="nt">--hard</span> origin/master
+<span class="nv">$ </span>git checkout main
+<span class="nv">$ </span>git reset <span class="nt">--hard</span> origin/main
<span class="nv">$ </span>git clean <span class="nt">-xdf</span>
<span class="nv">$ </span>mvn <span class="nt">--batch-mode</span> <span class="nb">install</span>
<span class="nv">$ </span>mvn <span class="nt">--batch-mode</span> site site:stage
@@ -206,13 +206,13 @@ bundle <span class="nb">exec </span>middleman
<span class="nv">$ </span>git add <span class="nt">-p</span>
<span class="nv">$ </span><span class="c"># Verify any new files are also added</span>
<span class="nv">$ </span>git status
-<span class="nv">$ </span><span class="c"># Try to reference the commit hash on master that this publication assures we include</span>
+<span class="nv">$ </span><span class="c"># Try to reference the commit hash on main that this publication assures we include</span>
<span class="nv">$ </span>git commit <span class="nt">-m</span> <span class="s2">"git hash 6c6f6f6b696e6720746f6f20686172642c20796f"</span>
<span class="nv">$ </span><span class="c"># Finally publish</span>
<span class="nv">$ </span>git push origin asf-site
</code></pre></div>
-<p>Publishing the website should be possible from the HEAD of the master branch under most circumstances. (See the <a href="releases">Guide for Release Managing</a> for a notable time period where this won't be true.)<br />
-Documentation changes will be reviewed as they make their way into the master branch; updates to the <code>asf-site</code> branch are handled without further review.</p>
+<p>Publishing the website should be possible from the HEAD of the main branch under most circumstances. (See the <a href="releases">Guide for Release Managing</a> for a notable time period where this won't be true.)<br />
+Documentation changes will be reviewed as they make their way into the main branch; updates to the <code>asf-site</code> branch are handled without further review.</p>
</div>
diff --git a/documentation/0.13.0-SNAPSHOT/interface-classification/index.html b/documentation/0.13.0-SNAPSHOT/interface-classification/index.html
deleted file mode 100644
index 7189deb..0000000
--- a/documentation/0.13.0-SNAPSHOT/interface-classification/index.html
+++ /dev/null
@@ -1,360 +0,0 @@
-<!---
- 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.10.0/">Docs for v0.10.0</a></li>
- <li><a href="/documentation/0.11.1/">Docs for v0.11.1</a></li>
- <li><a href="/documentation/0.12.0/">Docs for v0.12.0</a></li>
- <li><a href="/documentation/in-progress/">In Progress Docs for Contributors</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 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. See accompanying LICENSE file.
--->
-
-<h1 id="apache-yetus-interface-taxonomy-audience-and-stability-classification">Apache Yetus Interface Taxonomy: Audience and Stability Classification</h1>
-
-<!-- MarkdownTOC levels="1,2,3" autolink="true" -->
-
-<ul>
- <li><a href="#motivation">Motivation</a></li>
- <li><a href="#interface-classification">Interface Classification</a>
- <ul>
- <li><a href="#audience">Audience</a>
- <ul>
- <li><a href="#private">Private</a></li>
- <li><a href="#limited-private">Limited-Private</a></li>
- <li><a href="#public">Public</a></li>
- </ul>
- </li>
- <li><a href="#stability">Stability</a>
- <ul>
- <li><a href="#stable">Stable</a></li>
- <li><a href="#evolving">Evolving</a></li>
- <li><a href="#deprecated">Deprecated</a></li>
- </ul>
- </li>
- </ul>
- </li>
- <li><a href="#how-are-the-classifications-recorded">How are the Classifications Recorded</a></li>
- <li><a href="#faq">FAQ</a></li>
-</ul>
-
-<!-- /MarkdownTOC -->
-
-<h1 id="motivation">Motivation</h1>
-
-<p>The interface taxonomy classification provided by Apache Yetus annotations is for guidance to developers and users of interfaces. The classification guides a developer to declare the targeted audience or users of an interface and also its stability.</p>
-
-<ul>
- <li>
- <p>Benefits to the user of an interface: Knows which interfaces to use or not use and their stability.</p>
- </li>
- <li>
- <p>Benefits to the developer: to prevent accidental changes of interfaces and<br />
-hence accidental impact on users or other components or system. This is<br />
-particularly useful in large systems with many developers who may not all have a shared state/history of the project.</p>
- </li>
-</ul>
-
-<h1 id="interface-classification">Interface Classification</h1>
-
-<p>Yetus provides the following interface classification, derived from the<br />
-<a href="https://web.archive.org/web/20061013114610/http://opensolaris.org/os/community/arc/policies/interface-taxonomy/">OpenSolaris taxonomy</a><br />
-and, to some extent, from taxonomy used inside Yahoo.<br />
-Interfaces have two main attributes: Audience and Stability</p>
-
-<h2 id="audience">Audience</h2>
-
-<p>Audience denotes the potential consumers of the interface. While many interfaces are internal/private to the implementation, others are public/external interfaces and are meant for wider consumption by applications and/or clients. For example, POSIX definitions in libc are external, while large parts of the kernel are internal or private interfaces. Also, some interfaces are targeted towards other specific subsystems.</p>
-
-<p>Identifying the audience of an interface helps define the impact of breaking<br />
-it. For instance, it might be okay to break the compatibility of an interface<br />
-whose audience is a small number of specific subsystems. On the other hand, it<br />
-is probably not okay to break a protocol interfaces that millions of Internet<br />
-users depend on.</p>
-
-<p>Yetus uses the following kinds of audience in order of increasing/wider visibility:</p>
-
-<h3 id="private">Private</h3>
-
-<p>The interface is for internal use within a project(such as Apache Hadoop)<br />
-and should not be used by applications or by other projects. It is subject to<br />
-change at anytime without notice. Most interfaces of a project are Private (also referred to as project-private).</p>
-
-<h3 id="limited-private">Limited-Private</h3>
-
-<p>The interface is used by a specified set of projects or systems (typically<br />
-closely related projects). Other projects or systems should not use the<br />
-interface. Changes to the interface will be communicated/ negotiated with the<br />
-specified projects. For example, in the Apache Hadoop project, some interfaces are LimitedPrivate{HDFS, MapReduce} in that they are private to the HDFS and<br />
-MapReduce subprojects.</p>
-
-<h3 id="public">Public</h3>
-
-<p>The interface is for general use by any application.</p>
-
-<h2 id="stability">Stability</h2>
-
-<p>Stability denotes how stable an interface is, as in when incompatible changes to<br />
-the interface are allowed. Yetus provides the following levels of stability.</p>
-
-<h3 id="stable">Stable</h3>
-
-<p>Can evolve while retaining compatibility for minor release boundaries; in other<br />
-words, incompatible changes to APIs marked Stable are generally only allowed<br />
-at major releases (i.e. at m.0).</p>
-
-<h3 id="evolving">Evolving</h3>
-
-<p>Evolving, but incompatible changes are allowed at minor release (i.e. m .x)</p>
-
-<h4 id="unstable">Unstable</h4>
-
-<p>Incompatible changes to Unstable APIs are allowed any time. This usually makes<br />
-sense for only private interfaces.</p>
-
-<p>However one may call this out for a supposedly public interface to highlight<br />
-that it should not be used as an interface; for public interfaces, labeling it<br />
-as Not-an-interface is probably more appropriate than "Unstable".</p>
-
-<p>Examples of publicly visible interfaces that are unstable<br />
-(i.e. not-an-interface): GUI, CLIs whose output format will change</p>
-
-<h3 id="deprecated">Deprecated</h3>
-
-<p>APIs that could potentially be removed in the future and should not be used.</p>
-
-<h1 id="how-are-the-classifications-recorded">How are the Classifications Recorded</h1>
-
-<p>How should the classification be recorded for the annotated APIs?</p>
-
-<ul>
- <li>Each interface or class will have the audience and stability recorded using<br />
-annotations in org.apache.yetus.classification package.</li>
- <li>The javadoc generated by the maven target javadoc:javadoc lists only the public API.</li>
- <li>One can derive the audience of Java classes and Java interfaces by the<br />
-audience of the package in which they are contained. Hence it is useful to<br />
-declare the audience of each Java package as public or private (along with the private audience variations).</li>
-</ul>
-
-<h1 id="faq">FAQ</h1>
-
-<ul>
- <li>Why aren't the Java scopes (private, package private and public) good enough?
- <ul>
- <li>Java's scoping is not very complete. One is often forced to make a class public in order for other internal components to use it. It does not have friends or sub-package-private like C++.</li>
- </ul>
- </li>
- <li>But I can easily access a private implementation interface if it is Java public. Where is the protection and control?
- <ul>
- <li>The purpose of this is not providing absolute access control. Its purpose<br />
-is to communicate to users and developers. One can access private<br />
-implementation functions in libc; however if they change the internal<br />
-implementation details, your application will break and you will have<br />
-little sympathy from the folks who are supplying libc. If you use a<br />
-non-public interface you understand the risks.</li>
- </ul>
- </li>
- <li>Why bother declaring the stability of a private interface?<br />
-Aren't private interfaces always unstable?
- <ul>
- <li>Private interfaces are not always unstable. In the cases where they are<br />
-stable they capture internal properties of the system and can communicate<br />
-these properties to its internal users and to developers of the interface.
- <ul>
- <li>e.g. In HDFS, NN-DN protocol is private but stable and can help<br />
-implement rolling upgrades. It communicates that this interface should<br />
-not be changed in incompatible ways even though it is private.</li>
- <li>e.g. In HDFS, FSImage stability can help provide more flexible roll backs.</li>
- </ul>
- </li>
- </ul>
- </li>
- <li>What is the harm in applications using a private interface that is stable? How is it different than a public stable interface?
- <ul>
- <li>While a private interface marked as stable is targeted to change only at<br />
-major releases, it may break at other times if the providers of that<br />
-interface are willing to changes the internal users of that<br />
-interface. Further, a public stable interface is less likely to break even<br />
-at major releases (even though it is allowed to break compatibility)<br />
-because the impact of the change is larger. If you use a private interface<br />
-(regardless of its stability) you run the risk of incompatibility.</li>
- </ul>
- </li>
- <li>Why bother with Limited-private? Isn't it giving special treatment to some projects? That is not fair.
- <ul>
- <li>First, most interfaces should be public or private; actually let us state<br />
-it even stronger: make it private unless you really want to expose it to<br />
-public for general use.</li>
- <li>Limited-private is for interfaces that are not intended for general<br />
-use. They are exposed to related projects that need special hooks. Such a<br />
-classification has a cost to both the supplier and consumer of the limited<br />
-interface. Both will have to work together if ever there is a need to<br />
-break the interface in the future; for example the supplier and the<br />
-consumers will have to work together to get coordinated releases of their<br />
-respective projects. This should not be taken lightly - if you can get<br />
-away with private then do so; if the interface is really for general use<br />
-for all applications then you should consider making it public. But remember<br />
-that making an interface public has huge responsibility. Sometimes<br />
-Limited-private is just right.</li>
- <li>A good example of a limited-private interface is BlockLocations in the Apache<br />
-Hadoop Project, This is fairly low-level interface that they are willing to<br />
-expose to MR and perhaps HBase. They are likely to change it down the road<br />
-and at that time they will have to get a coordinated effort with the MR<br />
-team to release matching releases. While MR and HDFS are always released<br />
-in sync today, they may change down the road.</li>
- <li>If you have a limited-private interface with many projects listed then you are fooling yourself. It is practically public.</li>
- <li>It might be worth declaring a special audience classification called<br />
-{YourProjectName}-Private for your closely related projects.</li>
- </ul>
- </li>
- <li>Can't a private interface be treated as project-private also? For example what is the harm in projects in the Apache Hadoop extended ecosystem, having access to private classes?
- <ul>
- <li>Do we want MR accessing class files that are implementation details inside<br />
-HDFS? There used to be many such layer violations in the Apache Hadoop<br />
-project that they have been cleaning up over the last few years. It is highly<br />
-undesirable for such layer violations to creep back in by no separation<br />
-between the major components like HDFS and MR.</li>
- </ul>
- </li>
- <li>Aren't all public interfaces stable?
- <ul>
- <li>One may mark a public interface as evolving in its early days. Here one is<br />
-promising to make an effort to make compatible changes but may need to<br />
-break it at minor releases.</li>
- <li>One example of a public interface that is unstable is where one is<br />
-providing an implementation of a standards-body based interface that is<br />
-still under development. For example, many companies, in an attempt to be<br />
-first to market, have provided implementations of a new NFS protocol even<br />
-when the protocol was not fully completed by IETF. The implementor cannot<br />
-evolve the interface in a fashion that causes least disruption because<br />
-the stability is controlled by the standards body. Hence it is appropriate<br />
-to label the interface as unstable.</li>
- </ul>
- </li>
-</ul>
-
- </div>
-
-<div class="container">
- <hr>
- <footer class="footer">
- <div class="row-fluid">
- <div class="span12 text-left">
- <div class="span12">
- Copyright 2008-2020 <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>
diff --git a/documentation/0.13.0-SNAPSHOT/precommit-admin/index.html b/documentation/0.13.0-SNAPSHOT/precommit-admin/index.html
deleted file mode 100644
index fd14dbc..0000000
--- a/documentation/0.13.0-SNAPSHOT/precommit-admin/index.html
+++ /dev/null
@@ -1,222 +0,0 @@
-<!---
- 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.10.0/">Docs for v0.10.0</a></li>
- <li><a href="/documentation/0.11.1/">Docs for v0.11.1</a></li>
- <li><a href="/documentation/0.12.0/">Docs for v0.12.0</a></li>
- <li><a href="/documentation/in-progress/">In Progress Docs for Contributors</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.
--->
-
-<h1 id="overview">Overview</h1>
-
-<!-- MarkdownTOC levels="1,2" autolink="true" -->
-
-<ul>
- <li><a href="#project-specifc-builds">Project-Specifc Builds</a></li>
- <li><a href="#jenkins-job-tokens">Jenkins Job Tokens</a></li>
-</ul>
-
-<!-- /MarkdownTOC -->
-
-<p>The jenkins-admin script is an automated way to submit JIRA issues to the Apache Yetus precommit testing framework. It works by:</p>
-
-<ul>
- <li>Grab the XML output of a JIRA filter that contains all the issues that should be tested by the system. In general, the filter should comprise issues from relevant JIRA projects that are currently in Patch Available state.</li>
- <li>Process the XML into a list of <code><project-issue>, <attachment id></code> pairs, where attachment id is the id for the <em>newest</em> attachment on the issue. Pulling the newest attachment implies that if multiple attachments are uploaded to an issue, the last one is the one that will be processed and other attachments will be <em>ignored</em>.</li>
- <li>Grab the single build artifact that this job keeps, <code>patch_tested.txt</code>. This file contains the list of <code><project-issue>, <attachment id></code> pairs that have already been submitted for testing.</li>
- <li>For each pair from the processed XML, see if the pair is in <code>patch_tested.txt</code>. If not, start a new project build and append the pair to the file.</li>
- <li>When this admin job completes, archive the latest <code>patch_tested.txt</code> file.</li>
-</ul>
-
-<p>All communication to Jenkins is currently done with the Remote Access API using tokens where necessary (see below). JIRA communication is currently unauthenticated.</p>
-
-<p>The JIRA filter is a required value provided via the <code>--jira-filter</code> parameter. It should be the full URL as provided by the JIRA UI.</p>
-
-<p>In order to prevent accidents, the <code>--live</code> parameter is required when jenkins-admin is used for production purposes. Without this flag, jobs are not launched but the <code>patch_tested.txt</code> file is created/updated.</p>
-
-<p>By default, jenkins-admin expects that the <code>JOB_NAME</code> environment variable will be set by Jenkins. If it is not or it needs to be overridden, that can be done with the <code>--jenkins-jobname</code> parameter.</p>
-
-<p>Additionally, the URL of the Jenkins server is expected to be in the <code>JENKINS_URL</code> environment variable, also usually set by Jenkins. This value may be overridden with the <code>--jenkins-url</code> option.</p>
-
-<p>The very first run of the job should be done with the <code>--initialize</code> parameter to create the first <code>patch_tested.txt</code> file. Otherwise, the job will fail because a previous version of it cannot be downloaded from previous runs.</p>
-
-<h1 id="project-specifc-builds">Project-Specifc Builds</h1>
-
-<p>New builds are started via buildWithParameters call. Three parameters are added to the URL:</p>
-
-<ul>
- <li>token = Jenkins security token (see below)</li>
- <li>ISSUE_NUM = JIRA issue number</li>
- <li>ATTACHMENT_ID = JIRA attachment id</li>
-</ul>
-
-<p>By default, the Jenkins job name is expected to be <code>PreCommit-{project}</code>, where the project name matches the JIRA project name. Using the JIRA issue YETUS-1 with an attachment number of 2345 would result in the following URL:</p>
-
-<p>{JENKINS_URL}/job/PreCommit-YETUS/buildWithParameters?token=YETUS-token&ISSUE_NUM=1&ATTACHMENT_ID=2345</p>
-
-<p>The <code>{JENKINS_URL}</code> can be overridden on a per project basis using the <code>--jenkins-url-override</code> option. This parameter allows for one job on one Jenkins server to direct different projects to different Jenkins servers. For example:</p>
-
-<div class="highlight"><pre class="highlight shell"><code> jenkins-admin <span class="nt">--jenkins-url-override</span><span class="o">=</span><span class="nv">PROJ1</span><span class="o">=</span>https://example.com/1 <span class="nt">--jenkins-url-override</span><span class="o">=</span><span class="nv">PROJ2</span><span class="o">=</span>https://example.com/1
-</code></pre></div>
-<p>would send all PROJ1 Jenkins jobs to the first URL and all PROJ2 jobs to the second URL. The <code>--jenkins-url-override</code> option may be listed as many times as necessary.</p>
-
-<p>The job name can be overridden via the <code>--jenkins-project-template</code> option. For example, using <code>--jenkins-project-template='{project}-Build'</code>would change the above URL to be:</p>
-
-<p>…/job/PreCommit-YETUS-Build/buildwithParameters?…</p>
-
-<h1 id="jenkins-job-tokens">Jenkins Job Tokens</h1>
-
-<p>Currently, jenkins-admin supports the usage of Jenkins tokens for authentication via the <code>--jenkins-token</code> option. This option provides two ways to do tokens</p>
-
-<ul>
- <li>Flat tokens</li>
- <li>Template tokens</li>
-</ul>
-
-<p>Flat tokens are a simple string. For example, <code>--jenkins-tokens=yetus</code> would require the <code>yetus</code> string to be listed as the token in the Jenkins job configuration that is being requested.</p>
-
-<p>On the other hand, template tokens perform some simple string substitution before being used. This exchange includes:</p>
-
-<ul>
- <li>{project} for the JIRA project name</li>
- <li>{issue} for the JIRA issue number</li>
- <li>{attachment} for the JIRA issue attachment id</li>
-</ul>
-
-<p>For example, if JIRA issue YETUS-1 has an attachment of 2345, then <code>{project}</code> becomes <code>YETUS</code>, <code>{issue}</code> becomes <code>1</code>, and <code>{attachment}</code> becomes 2345.</p>
-
-<p>By default, the token is set to <code>{project}-token</code>. The token then becomes <code>YETUS-token</code> using the above values.</p>
-
- </div>
-
-<div class="container">
- <hr>
- <footer class="footer">
- <div class="row-fluid">
- <div class="span12 text-left">
- <div class="span12">
- Copyright 2008-2020 <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>
diff --git a/documentation/0.13.0-SNAPSHOT/precommit-advanced/index.html b/documentation/0.13.0-SNAPSHOT/precommit-advanced/index.html
deleted file mode 100644
index b478f4b..0000000
--- a/documentation/0.13.0-SNAPSHOT/precommit-advanced/index.html
+++ /dev/null
@@ -1,455 +0,0 @@
-<!---
- 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.10.0/">Docs for v0.10.0</a></li>
- <li><a href="/documentation/0.11.1/">Docs for v0.11.1</a></li>
- <li><a href="/documentation/0.12.0/">Docs for v0.12.0</a></li>
- <li><a href="/documentation/in-progress/">In Progress Docs for Contributors</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.
--->
-
-<h1 id="advanced-precommit">Advanced Precommit</h1>
-
-<!-- MarkdownTOC levels="1,2" autolink="true" -->
-
-<ul>
- <li><a href="#process-reaper">Process Reaper</a></li>
- <li><a href="#plug-ins">Plug-ins</a>
- <ul>
- <li><a href="#common-plug-in-functions">Common Plug-in Functions</a></li>
- <li><a href="#plug-in-importation">Plug-in Importation</a></li>
- <li><a href="#test-plug-ins">Test Plug-ins</a></li>
- </ul>
- </li>
- <li><a href="#personalities">Personalities</a>
- <ul>
- <li><a href="#configuring-for-other-projects">Configuring for Other Projects</a></li>
- <li><a href="#global-definitions">Global Definitions</a></li>
- <li><a href="#test-determination">Test Determination</a></li>
- <li><a href="#module--profile-determination">Module & Profile Determination</a></li>
- <li><a href="#enabling-plug-ins">Enabling Plug-ins</a></li>
- </ul>
- </li>
- <li><a href="#important-variables">Important Variables</a></li>
-</ul>
-
-<!-- /MarkdownTOC -->
-
-<h1 id="process-reaper">Process Reaper</h1>
-
-<p>A common problem is the 'stuck' unit test. If bash v4.0 or higher is in use, Apache Yetus may be told to turn on the process reaper functionality. Using the <code>--reapearmode</code> option, this feature may be configured to either report and even kill left over processes that match provided regular expressions.</p>
-
-<p>WARNING: Using <code>--reapermode</code> outside of Docker will report or kill ALL matching processes on the system. It is recommended to only use those options whilst in Docker mode.</p>
-
-<p>The reaper will run after every 'external' command that is printed on the console. This includes almost all build tool commands and individual test commands.</p>
-
-<h1 id="plug-ins">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 inside 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 ar [...]
-
-<h2 id="common-plug-in-functions">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>
-
-<div class="highlight"><pre class="highlight shell"><code>add_test_type <pluginname>
-</code></pre></div>
-<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>
-
-<div class="highlight"><pre class="highlight shell"><code><span class="k">function </span>pluginname_filefilter
-</code></pre></div>
-<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>
-
-<div class="highlight"><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></div>
-<ul>
- <li>pluginname_usage
- <ul>
- <li>executed when the help message is displayed. This is used to display the plug-in specific options for the user.</li>
- </ul>
- </li>
- <li>pluginname_parse_args
- <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>pluginname_initialize
- <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>pluginname_docker_support
- <ul>
- <li>Perform any necessary setup to configure Docker support for the given plugin. Typically this means adding parameters to the docker run command line via adding to the DOCKER_EXTRAARGS array.</li>
- </ul>
- </li>
- <li>pluginname_precheck
- <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>pluginname_postcleanup
- <ul>
- <li>executed on test-patch shutdown.</li>
- </ul>
- </li>
- <li>pluginname_patchfile
- <ul>
- <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>pluginname_precompile
- <ul>
- <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>pluginname_postcompile
- <ul>
- <li>This step happens after the compile phase.</li>
- </ul>
- </li>
- <li>pluginname_rebuild
- <ul>
- <li>Any non-unit tests that require the source to be rebuilt in a destructive way should be run here.</li>
- </ul>
- </li>
-</ul>
-
-<h2 id="plug-in-importation">Plug-in Importation</h2>
-
-<p>Plug-ins are imported from several key directories:</p>
-
-<ul>
- <li>
- <p>core.d is an internal-to-Yetus directory that first loads the basic Apache Yetus library, followed by the common routines used by all of the precommit shell code. This order is dictated by prefixing the plug-in files with a number. Other files in this directory are loaded in shell collated order.</p>
- </li>
- <li>
- <p>personality contains bundled personalities for various projects. These will be imported individually based upon either a project name or if specifically identified with the <code>--personality</code> flag.</p>
- </li>
- <li>
- <p>test-patch.d contains all of the optional, bundled plug-ins. These are imported last and in shell collated order.</p>
- </li>
-</ul>
-
-<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>
-
-<p>Plug-ins geared towards independent tests are registered via:</p>
-
-<div class="highlight"><pre class="highlight shell"><code>add_test_type <pluginname>
-</code></pre></div>
-<ul>
- <li>pluginname_filefilter
- <ul>
- <li>executed while determining 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>pluginname_compile
- <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>pluginname_tests
- <ul>
- <li>executed after the unit tests have completed.</li>
- </ul>
- </li>
- <li>pluginname_clean
- <ul>
- <li>executed to allow the plugin to remove all files that have been generate by this plugin.</li>
- </ul>
- </li>
- <li>pluginname_logfilter
- <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>pluginname_calcdiffs
- <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 o [...]
- </ul>
-
- <p>NOTE: If the plug-in has support for maven, the maven_add_install <code>pluginname</code> should be executed. See more information in Custom Maven Tests in the build tool documentation.</p>
- </li>
-</ul>
-
-<h1 id="personalities">Personalities</h1>
-
-<h2 id="configuring-for-other-projects">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>
-
-<p>A personality consists of two functions. One that determines which test types to run and another that allows a project to dictate ordering rules, flags, and profiles on a per-module, per-test run.</p>
-
-<p>There can be only <strong>one</strong> of each personality function defined.</p>
-
-<h2 id="global-definitions">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>
-
-<div class="highlight"><pre class="highlight shell"><code><span class="k">function </span>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>
-</code></pre></div>
-<p>Additionally, a personality may require some outside help from the user. The <code>personality_parse_args</code><br />
-function is called almost immediately after the personality is loaded and plug-ins parse arguments.</p>
-
-<div class="highlight"><pre class="highlight shell"><code><span class="k">function </span>personality_parse_args
-<span class="o">{</span>
- <span class="nb">echo</span> <span class="s2">"</span><span class="nv">$*</span><span class="s2">"</span>
-<span class="o">}</span>
-</code></pre></div>
-<p>It is important to note that this function is called AFTER personality_globals.</p>
-
-<h2 id="test-determination">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>
-
-<div class="highlight"><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="p">;</span> <span class="k">then
- </span>add_test findbugs
- add_test javac
- add_test javadoc
- add_test mvninstall
- add_test unit
- <span class="k">fi</span>
-
-<span class="o">}</span>
-</code></pre></div>
-<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--profile-determination">Module & Profile Determination</h2>
-
-<p>Once the tests are determined, it is now time to pick which <a href="../precommit-glossary#genericoutside-definitions">modules</a> should get used. That's the job of the <code>personality_modules</code> function.</p>
-
-<div class="highlight"><pre class="highlight shell"><code><span class="k">function </span>personality_modules
-<span class="o">{</span>
-
- clear_personality_queue
-
-...
-
- personality_enqueue_module <module> <flags>
-
-<span class="o">}</span>
-</code></pre></div>
-<p>It takes exactly two parameters <code>repostatus</code> and <code>testtype</code>.</p>
-
-<p>The <code>repostatus</code> parameter tells the <code>personality</code> function exactly what state the source repository is in. It can only be in one of two states: <code>branch</code> or <code>patch</code>. <code>branch</code> means the patch has not been applied. The <code>patch</code> state is after the patch has been applied.</p>
-
-<p>The <code>testtype</code> state tells the personality exactly which test is about to be executed.</p>
-
-<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 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>
-
-<div class="highlight"><pre class="highlight plaintext"><code>NOTE: A module name of . signifies the root of the repository.
-</code></pre></div>
-<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>
-
-<div class="highlight"><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>
-
- <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="p">;</span> <span class="k">then
- </span>personality_enqueue_module <span class="nb">.</span> <span class="nt">-DskipTests</span>
- <span class="k">return
- fi</span>
- ...
-
-</code></pre></div>
-<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>
-
-<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>
-
-<div class="highlight"><pre class="highlight shell"><code>personality_plugins <span class="s2">"all,-checkstyle,-findbugs,-asflicense"</span>
-</code></pre></div>
-<p>This list is used if the user does not provide a list of plug-ins.</p>
-
-<h1 id="important-variables">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>
-
-<ul>
- <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). For <a href="../precommit-robots">robots</a>, 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 an array of all files that appear to be added, deleted, or modified in the patch.</p>
- </li>
- <li>
- <p>CHANGED_MODULES[@] is an array 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>DOCKER_EXTRAARGS[@] is an array of command line arguments to apply to the <code>docker run</code> command.</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>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. For <a href="../precommit-robots">robots</a>, this is always true.</p>
- </li>
-</ul>
-
- </div>
-
-<div class="container">
- <hr>
- <footer class="footer">
- <div class="row-fluid">
- <div class="span12 text-left">
- <div class="span12">
- Copyright 2008-2020 <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>
diff --git a/documentation/0.13.0-SNAPSHOT/precommit-apidocs/core/index.html b/documentation/0.13.0-SNAPSHOT/precommit-apidocs/core/index.html
deleted file mode 100644
index 0bf1221..0000000
--- a/documentation/0.13.0-SNAPSHOT/precommit-apidocs/core/index.html
+++ /dev/null
@@ -1,2699 +0,0 @@
-<!---
- 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.10.0/">Docs for v0.10.0</a></li>
- <li><a href="/documentation/0.11.1/">Docs for v0.11.1</a></li>
- <li><a href="/documentation/0.12.0/">Docs for v0.12.0</a></li>
- <li><a href="/documentation/in-progress/">In Progress Docs for Contributors</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="#add_bugsystem">add_bugsystem</a></li>
- <li><a href="#add_build_tool">add_build_tool</a></li>
- <li><a href="#add_docker_build_arg">add_docker_build_arg</a></li>
- <li><a href="#add_docker_env">add_docker_env</a></li>
- <li><a href="#add_test">add_test</a></li>
- <li><a href="#add_test_format">add_test_format</a></li>
- <li><a href="#add_test_type">add_test_type</a></li>
- <li><a href="#delete_bugsystem">delete_bugsystem</a></li>
- <li><a href="#delete_build_tool">delete_build_tool</a></li>
- <li><a href="#delete_test">delete_test</a></li>
- <li><a href="#delete_test_format">delete_test_format</a></li>
- <li><a href="#delete_test_type">delete_test_type</a></li>
- <li><a href="#personality_plugins">personality_plugins</a></li>
- <li><a href="#replace_test_type">replace_test_type</a></li>
- <li><a href="#verify_needed_test">verify_needed_test</a></li>
- <li><a href="#verify_plugin_enabled">verify_plugin_enabled</a></li>
- <li><a href="#yetus_add_array_element">yetus_add_array_element</a></li>
- <li><a href="#yetus_del_array_element">yetus_del_array_element</a></li>
- <li><a href="#yetus_relative_dir">yetus_relative_dir</a></li>
- <li><a href="#yetus_sort_and_unique_array">yetus_sort_and_unique_array</a></li>
- <li><a href="#yetus_sort_array">yetus_sort_array</a></li>
- <li><a href="#yetus_ver_array_element">yetus_ver_array_element</a></li>
- </ul>
- </li>
- <li>Public/Stable/Not Replaceable
- <ul>
- <li><a href="#add_version_data">add_version_data</a></li>
- <li><a href="#common_defaults">common_defaults</a></li>
- <li><a href="#delete_parameter">delete_parameter</a></li>
- <li><a href="#escape_html">escape_html</a></li>
- <li><a href="#generate_stack">generate_stack</a></li>
- <li><a href="#module_file_fragment">module_file_fragment</a></li>
- <li><a href="#patchfile_verify_zero">patchfile_verify_zero</a></li>
- <li><a href="#unescape_html">unescape_html</a></li>
- <li><a href="#yetus_abs">yetus_abs</a></li>
- <li><a href="#yetus_debug">yetus_debug</a></li>
- <li><a href="#yetus_error">yetus_error</a></li>
- <li><a href="#yetus_find_deepest_directory">yetus_find_deepest_directory</a></li>
- <li><a href="#yetus_run_and_redirect">yetus_run_and_redirect</a></li>
- <li><a href="#yetus_get_ctime">yetus_get_ctime</a></li>
- </ul>
- </li>
- <li>Public/Evolving/Replaceable
- <ul>
- <li><a href="#get_artifact_url">get_artifact_url</a></li>
- </ul>
- </li>
- <li>Public/Evolving/Not Replaceable
- <ul>
- <li><a href="#guess_build_tool">guess_build_tool</a></li>
- <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_array_to_comma">yetus_array_to_comma</a></li>
- <li><a href="#yetus_comma_to_array">yetus_comma_to_array</a></li>
- <li><a href="#yetus_file_to_array">yetus_file_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="#docker_do_env_adds">docker_do_env_adds</a></li>
- <li><a href="#reaper_initialize">reaper_initialize</a></li>
- <li><a href="#yetus_array_contains">yetus_array_contains</a></li>
- </ul>
- </li>
- <li>Private/Evolving/Replaceable
- <ul>
- <li><a href="#activate_robots">activate_robots</a></li>
- <li><a href="#pid_kill">pid_kill</a></li>
- <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>
- <li><a href="#set_yetus_version">set_yetus_version</a></li>
- </ul>
- </li>
-</ul>
-
-<hr />
-
-<h2 id="publicstablereplaceable">Public/Stable/Replaceable</h2>
-<h3 id="add_bugsystem"><code>add_bugsystem</code></h3>
-
-<ul>
- <li>Synopsis</li>
-</ul>
-
-<div class="highlight"><pre class="highlight plaintext"><code>add_bugsystem bugsystem
-</code></pre></div>
-<ul>
- <li>Description</li>
-</ul>
-
-<p>Add the given bugsystem type</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">Yes</td>
- </tr>
- </tbody>
-</table>
-
-<h3 id="add_build_tool"><code>add_build_tool</code></h3>
-
-<ul>
- <li>Synopsis</li>
-</ul>
-
-<div class="highlight"><pre class="highlight plaintext"><code>add_build_tool build tool
-</code></pre></div>
-<ul>
- <li>Description</li>
-</ul>
-
-<p>Add the given build tool type</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">Yes</td>
- </tr>
- </tbody>
-</table>
-
-<h3 id="add_docker_build_arg"><code>add_docker_build_arg</code></h3>
-
-<ul>
- <li>Synopsis</li>
-</ul>
-
-<div class="highlight"><pre class="highlight plaintext"><code>add_docker_build_arg envname value
-</code></pre></div>
-<ul>
- <li>Description</li>
-</ul>
-
-<p>Queue Docker build-args to add to the docker build</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">Yes</td>
- </tr>
- </tbody>
-</table>
-
-<h3 id="add_docker_env"><code>add_docker_env</code></h3>
-
-<ul>
- <li>Synopsis</li>
-</ul>
-
-<div class="highlight"><pre class="highlight plaintext"><code>add_docker_env envname ...
-</code></pre></div>
-<ul>
- <li>Description</li>
-</ul>
-
-<p>Queue env vars to add to the docker env</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">Yes</td>
- </tr>
- </tbody>
-</table>
-
-<h3 id="add_test"><code>add_test</code></h3>
-
-<ul>
- <li>Synopsis</li>
-</ul>
-
-<div class="highlight"><pre class="highlight plaintext"><code>add_test test
-</code></pre></div>
-<ul>
- <li>Description</li>
-</ul>
-
-<p>Add the given test type</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">Yes</td>
- </tr>
- </tbody>
-</table>
-
-<h3 id="add_test_format"><code>add_test_format</code></h3>
-
-<ul>
- <li>Synopsis</li>
-</ul>
-
-<div class="highlight"><pre class="highlight plaintext"><code>add_test_format test format
-</code></pre></div>
-<ul>
- <li>Description</li>
-</ul>
-
-<p>Add the given test format type</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">Yes</td>
- </tr>
- </tbody>
-</table>
-
-<h3 id="add_test_type"><code>add_test_type</code></h3>
-
-<ul>
- <li>Synopsis</li>
-</ul>
-
-<div class="highlight"><pre class="highlight plaintext"><code>add_test_type plugin
-</code></pre></div>
-<ul>
- <li>Description</li>
-</ul>
-
-<p>Add the given test type</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">Yes</td>
- </tr>
- </tbody>
-</table>
-
-<h3 id="delete_bugsystem"><code>delete_bugsystem</code></h3>
-
-<ul>
- <li>Synopsis</li>
-</ul>
-
-<div class="highlight"><pre class="highlight plaintext"><code>delete_bugsystem bugsystem
-</code></pre></div>
-<ul>
- <li>Description</li>
-</ul>
-
-<p>Remove the given bugsystem type</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">Yes</td>
- </tr>
- </tbody>
-</table>
-
-<h3 id="delete_build_tool"><code>delete_build_tool</code></h3>
-
-<ul>
- <li>Synopsis</li>
-</ul>
-
-<div class="highlight"><pre class="highlight plaintext"><code>delete_build_tool build tool
-</code></pre></div>
-<ul>
- <li>Description</li>
-</ul>
-
-<p>Remove the given build tool type</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">Yes</td>
- </tr>
- </tbody>
-</table>
-
-<h3 id="delete_test"><code>delete_test</code></h3>
-
-<ul>
- <li>Synopsis</li>
-</ul>
-
-<div class="highlight"><pre class="highlight plaintext"><code>delete_test test
-</code></pre></div>
-<ul>
- <li>Description</li>
-</ul>
-
-<p>Remove the given test type</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">Yes</td>
- </tr>
- </tbody>
-</table>
-
-<h3 id="delete_test_format"><code>delete_test_format</code></h3>
-
-<ul>
- <li>Synopsis</li>
-</ul>
-
-<div class="highlight"><pre class="highlight plaintext"><code>delete_test_format test format
-</code></pre></div>
-<ul>
- <li>Description</li>
-</ul>
-
-<p>Remove the given test format type</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">Yes</td>
- </tr>
- </tbody>
-</table>
-
-<h3 id="delete_test_type"><code>delete_test_type</code></h3>
-
-<ul>
- <li>Synopsis</li>
-</ul>
-
-<div class="highlight"><pre class="highlight plaintext"><code>delete_test_type plugin
-</code></pre></div>
-<ul>
- <li>Description</li>
-</ul>
-
-<p>Remove the given test type</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">Yes</td>
- </tr>
- </tbody>
-</table>
-
-<h3 id="personality_plugins"><code>personality_plugins</code></h3>
-
-<ul>
- <li>Synopsis</li>
-</ul>
-
-<div class="highlight"><pre class="highlight plaintext"><code>personality_plugins plug-in list string
-</code></pre></div>
-<ul>
- <li>Description</li>
-</ul>
-
-<p>Personality-defined plug-in list</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">Yes</td>
- </tr>
- </tbody>
-</table>
-
-<h3 id="replace_test_type"><code>replace_test_type</code></h3>
-
-<ul>
- <li>Synopsis</li>
-</ul>
-
-<div class="highlight"><pre class="highlight plaintext"><code>replace_test_type plugin
-</code></pre></div>
-<ul>
- <li>Description</li>
-</ul>
-
-<p>Add the given test type</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">Yes</td>
- </tr>
- </tbody>
-</table>
-
-<h3 id="verify_needed_test"><code>verify_needed_test</code></h3>
-
-<ul>
- <li>Synopsis</li>
-</ul>
-
-<div class="highlight"><pre class="highlight plaintext"><code>verify_needed_test test
-</code></pre></div>
-<ul>
- <li>Description</li>
-</ul>
-
-<p>Verify if a given test was requested</p>
-
-<ul>
- <li>Returns</li>
-</ul>
-
-<p>0 = yes</p>
-
-<p>1 = no</p>
-
-<table class="table table-bordered table-striped">
- <thead>
- <tr>
- <th style="text-align: left">Classification</th>
- <th style="text-align: left">Level</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td style="text-align: left">Audience</td>
- <td style="text-align: left">Public</td>
- </tr>
- <tr>
- <td style="text-align: left">Stability</td>
- <td style="text-align: left">Stable</td>
- </tr>
- <tr>
- <td style="text-align: left">Replaceable</td>
- <td style="text-align: left">Yes</td>
- </tr>
- </tbody>
-</table>
-
-<h3 id="verify_plugin_enabled"><code>verify_plugin_enabled</code></h3>
-
-<ul>
- <li>Synopsis</li>
-</ul>
-
-<div class="highlight"><pre class="highlight plaintext"><code>verify_plugin_enabled test
-</code></pre></div>
-<ul>
- <li>Description</li>
-</ul>
-
-<p>Determine if a plugin was enabled by the user ENABLED_PLUGINS must be defined</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">Yes</td>
- </tr>
- </tbody>
-</table>
-
-<h3 id="yetus_add_array_element"><code>yetus_add_array_element</code></h3>
-
-<ul>
- <li>Synopsis</li>
-</ul>
-
-<div class="highlight"><pre class="highlight plaintext"><code>yetus_add_array_element arrayname element
-</code></pre></div>
-<ul>
- <li>Description</li>
-</ul>
-
-<p>Add the element if it is not present in the given array</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">Yes</td>
- </tr>
- </tbody>
-</table>
-
-<h3 id="yetus_del_array_element"><code>yetus_del_array_element</code></h3>
-
-<ul>
- <li>Synopsis</li>
-</ul>
-
-<div class="highlight"><pre class="highlight plaintext"><code>yetus_del_array_element arrayname element
-</code></pre></div>
-<ul>
- <li>Description</li>
-</ul>
-
-<p>Check if an array has a given value</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">Yes</td>
- </tr>
- </tbody>
-</table>
-
-<h3 id="yetus_relative_dir"><code>yetus_relative_dir</code></h3>
-
-<ul>
- <li>Synopsis</li>
-</ul>
-
-<div class="highlight"><pre class="highlight plaintext"><code>yetus_relative_dir dirpath filepath
-</code></pre></div>
-<ul>
- <li>Description</li>
-</ul>
-
-<p>is a given path relative to given dirpath?</p>
-
-<ul>
- <li>Returns</li>
-</ul>
-
-<p>1 - no, path</p>
-
-<p>0 - yes, path - dirpath</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">Yes</td>
- </tr>
- </tbody>
-</table>
-
-<h3 id="yetus_sort_and_unique_array"><code>yetus_sort_and_unique_array</code></h3>
-
-<ul>
- <li>Synopsis</li>
-</ul>
-
-<div class="highlight"><pre class="highlight plaintext"><code>yetus_sort_and_unique_array arrayvar
-</code></pre></div>
-<ul>
- <li>Description</li>
-</ul>
-
-<p>Sort and unique an array by its elements</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">Yes</td>
- </tr>
- </tbody>
-</table>
-
-<h3 id="yetus_sort_array"><code>yetus_sort_array</code></h3>
-
-<ul>
- <li>Synopsis</li>
-</ul>
-
-<div class="highlight"><pre class="highlight plaintext"><code>yetus_sort_array arrayvar
-</code></pre></div>
-<ul>
- <li>Description</li>
-</ul>
-
-<p>Sort an array by its elements</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">Yes</td>
- </tr>
- </tbody>
-</table>
-
-<h3 id="yetus_ver_array_element"><code>yetus_ver_array_element</code></h3>
-
-<ul>
- <li>Synopsis</li>
-</ul>
-
-<div class="highlight"><pre class="highlight plaintext"><code>yetus_ver_array_element arrayname element
-</code></pre></div>
-<ul>
- <li>Description</li>
-</ul>
-
-<p>Check if an arrayname has a given value</p>
-
-<ul>
- <li>Returns</li>
-</ul>
-
-<h2 id="returns------0--yes">@returns 0 = yes</h2>
-
-<h2 id="returns------1--no">@returns 1 = no</h2>
-
-<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">Yes</td>
- </tr>
- </tbody>
-</table>
-
-<h2 id="publicstablenot-replaceable">Public/Stable/Not Replaceable</h2>
-<h3 id="add_version_data"><code>add_version_data</code></h3>
-
-<ul>
- <li>Synopsis</li>
-</ul>
-
-<div class="highlight"><pre class="highlight plaintext"><code>add_version_data executable name version
-</code></pre></div>
-<ul>
- <li>Description</li>
-</ul>
-
-<p>Report on executable versions</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">No</td>
- </tr>
- </tbody>
-</table>
-
-<h3 id="common_defaults"><code>common_defaults</code></h3>
-
-<ul>
- <li>Synopsis</li>
-</ul>
-
-<div class="highlight"><pre class="highlight plaintext"><code>common_defaults
-</code></pre></div>
-<ul>
- <li>Description</li>
-</ul>
-
-<p>Setup the default global variables</p>
-
-<ul>
- <li>Returns</li>
-</ul>
-
-<p>Nothing</p>
-
-<table class="table table-bordered table-striped">
- <thead>
- <tr>
- <th style="text-align: left">Classification</th>
- <th style="text-align: left">Level</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td style="text-align: left">Audience</td>
- <td style="text-align: left">Public</td>
- </tr>
- <tr>
- <td style="text-align: left">Stability</td>
- <td style="text-align: left">Stable</td>
- </tr>
- <tr>
- <td style="text-align: left">Replaceable</td>
- <td style="text-align: left">No</td>
- </tr>
- </tbody>
-</table>
-
-<h3 id="delete_parameter"><code>delete_parameter</code></h3>
-
-<ul>
- <li>Synopsis</li>
-</ul>
-
-<div class="highlight"><pre class="highlight plaintext"><code>delete_parameter parameter
-</code></pre></div>
-<ul>
- <li>Description</li>
-</ul>
-
-<p>remove entries from paramater tracker</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">No</td>
- </tr>
- </tbody>
-</table>
-
-<h3 id="escape_html"><code>escape_html</code></h3>
-
-<ul>
- <li>Synopsis</li>
-</ul>
-
-<div class="highlight"><pre class="highlight plaintext"><code>escape_html parameter
-</code></pre></div>
-<ul>
- <li>Description</li>
-</ul>
-
-<p>escape common HTML entities</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">No</td>
- </tr>
- </tbody>
-</table>
-
-<h3 id="generate_stack"><code>generate_stack</code></h3>
-
-<ul>
- <li>Synopsis</li>
-</ul>
-
-<div class="highlight"><pre class="highlight plaintext"><code>generate_stack
-</code></pre></div>
-<ul>
- <li>Description</li>
-</ul>
-
-<p>generate a stack trace when in debug mode</p>
-
-<ul>
- <li>Returns</li>
-</ul>
-
-<p>exits</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">No</td>
- </tr>
- </tbody>
-</table>
-
-<h3 id="module_file_fragment"><code>module_file_fragment</code></h3>
-
-<ul>
- <li>Synopsis</li>
-</ul>
-
-<div class="highlight"><pre class="highlight plaintext"><code>module_file_fragment module
-</code></pre></div>
-<ul>
- <li>Description</li>
-</ul>
-
-<p>Convert the given module name to a file fragment</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">No</td>
- </tr>
- </tbody>
-</table>
-
-<h3 id="patchfile_verify_zero"><code>patchfile_verify_zero</code></h3>
-
-<ul>
- <li>Synopsis</li>
-</ul>
-
-<div class="highlight"><pre class="highlight plaintext"><code>patchfile_verify_zero log filename
-</code></pre></div>
-<ul>
- <li>Description</li>
-</ul>
-
-<p>if patch-level zero, then verify we aren't just adding files</p>
-
-<ul>
- <li>Returns</li>
-</ul>
-
-<p>$?</p>
-
-<table class="table table-bordered table-striped">
- <thead>
- <tr>
- <th style="text-align: left">Classification</th>
- <th style="text-align: left">Level</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td style="text-align: left">Audience</td>
- <td style="text-align: left">Public</td>
- </tr>
- <tr>
- <td style="text-align: left">Stability</td>
- <td style="text-align: left">Stable</td>
- </tr>
- <tr>
- <td style="text-align: left">Replaceable</td>
- <td style="text-align: left">No</td>
- </tr>
- </tbody>
-</table>
-
-<h3 id="unescape_html"><code>unescape_html</code></h3>
-
-<ul>
- <li>Synopsis</li>
-</ul>
-
-<div class="highlight"><pre class="highlight plaintext"><code>unescape_html parameter
-</code></pre></div>
-<ul>
- <li>Description</li>
-</ul>
-
-<p>unescape common HTML entities</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">No</td>
- </tr>
- </tbody>
-</table>
-
-<h3 id="yetus_abs"><code>yetus_abs</code></h3>
-
-<ul>
- <li>Synopsis</li>
-</ul>
-
-<div class="highlight"><pre class="highlight plaintext"><code>yetus_abs fsobj
-</code></pre></div>
-<ul>
- <li>Description</li>
-</ul>
-
-<p>Given a filename or dir, return the absolute version of it</p>
-
-<ul>
- <li>Returns</li>
-</ul>
-
-<p>0 success</p>
-
-<p>1 failure</p>
-
-<p>stdout abspath</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">No</td>
- </tr>
- </tbody>
-</table>
-
-<h3 id="yetus_debug"><code>yetus_debug</code></h3>
-
-<ul>
- <li>Synopsis</li>
-</ul>
-
-<div class="highlight"><pre class="highlight plaintext"><code>yetus_debug string
-</code></pre></div>
-<ul>
- <li>Description</li>
-</ul>
-
-<p>Print a message to stderr if –debug is turned on</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">No</td>
- </tr>
- </tbody>
-</table>
-
-<h3 id="yetus_error"><code>yetus_error</code></h3>
-
-<ul>
- <li>Synopsis</li>
-</ul>
-
-<div class="highlight"><pre class="highlight plaintext"><code>yetus_error string
-</code></pre></div>
-<ul>
- <li>Description</li>
-</ul>
-
-<p>Print a message to stderr</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">No</td>
- </tr>
- </tbody>
-</table>
-
-<h3 id="yetus_find_deepest_directory"><code>yetus_find_deepest_directory</code></h3>
-
-<ul>
- <li>Synopsis</li>
-</ul>
-
-<div class="highlight"><pre class="highlight plaintext"><code>yetus_find_deepest_directory array fn
-</code></pre></div>
-<ul>
- <li>Description</li>
-</ul>
-
-<p>find the deepest entry of a directory array NOTE: array and filename MUST be absolute paths</p>
-
-<ul>
- <li>Returns</li>
-</ul>
-
-<p>dir if match</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">No</td>
- </tr>
- </tbody>
-</table>
-
-<h3 id="yetus_run_and_redirect"><code>yetus_run_and_redirect</code></h3>
-
-<ul>
- <li>Synopsis</li>
-</ul>
-
-<div class="highlight"><pre class="highlight plaintext"><code>yetus_run_and_redirect filename command [..]
-</code></pre></div>
-<ul>
- <li>Description</li>
-</ul>
-
-<p>run the command, sending stdout and stderr to the given filename</p>
-
-<ul>
- <li>Returns</li>
-</ul>
-
-<p>$?</p>
-
-<table class="table table-bordered table-striped">
- <thead>
- <tr>
- <th style="text-align: left">Classification</th>
- <th style="text-align: left">Level</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td style="text-align: left">Audience</td>
- <td style="text-align: left">Public</td>
- </tr>
- <tr>
- <td style="text-align: left">Stability</td>
- <td style="text-align: left">Stable</td>
- </tr>
- <tr>
- <td style="text-align: left">Replaceable</td>
- <td style="text-align: left">No</td>
- </tr>
- </tbody>
-</table>
-
-<h3 id="yetus_get_ctime"><code>yetus_get_ctime</code></h3>
-
-<ul>
- <li>Synopsis</li>
-</ul>
-
-<div class="highlight"><pre class="highlight plaintext"><code>yetus_get_ctime
-</code></pre></div>
-<ul>
- <li>Description</li>
-</ul>
-
-<p>Get the date in ctime format</p>
-
-<ul>
- <li>Returns</li>
-</ul>
-
-<p>ctime</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">No</td>
- </tr>
- </tbody>
-</table>
-
-<h2 id="publicevolvingreplaceable">Public/Evolving/Replaceable</h2>
-<h3 id="get_artifact_url"><code>get_artifact_url</code></h3>
-
-<ul>
- <li>Synopsis</li>
-</ul>
-
-<div class="highlight"><pre class="highlight plaintext"><code>get_artifact_url
-</code></pre></div>
-<ul>
- <li>Description</li>
-</ul>
-
-<p>Get the base URL of the artifacts</p>
-
-<ul>
- <li>Returns</li>
-</ul>
-
-<p>urlstring</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">Yes</td>
- </tr>
- </tbody>
-</table>
-
-<h2 id="publicevolvingnot-replaceable">Public/Evolving/Not Replaceable</h2>
-<h3 id="guess_build_tool"><code>guess_build_tool</code></h3>
-
-<ul>
- <li>Synopsis</li>
-</ul>
-
-<div class="highlight"><pre class="highlight plaintext"><code>guess_build_tool
-</code></pre></div>
-<ul>
- <li>Description</li>
-</ul>
-
-<p>attempt to guess what the build tool should be</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="list_plugins"><code>list_plugins</code></h3>
-
-<ul>
- <li>Synopsis</li>
-</ul>
-
-<div class="highlight"><pre class="highlight plaintext"><code>list_plugins
-</code></pre></div>
-<ul>
- <li>Description</li>
-</ul>
-
-<p>List all installed plug-ins, regardless of whether they have been enabled</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="plugin_usage_output"><code>plugin_usage_output</code></h3>
-
-<ul>
- <li>Synopsis</li>
-</ul>
-
-<div class="highlight"><pre class="highlight plaintext"><code>plugin_usage_output array
-</code></pre></div>
-<ul>
- <li>Description</li>
-</ul>
-
-<p>Print the plugin's usage info</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="reaper_add_name"><code>reaper_add_name</code></h3>
-
-<ul>
- <li>Synopsis</li>
-</ul>
-
-<div class="highlight"><pre class="highlight plaintext"><code>reaper_add_name
-</code></pre></div>
-<ul>
- <li>Description</li>
-</ul>
-
-<p>Add a regex to the reaper'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>
- <li>Synopsis</li>
-</ul>
-
-<div class="highlight"><pre class="highlight plaintext"><code>yetus_add_header header
-</code></pre></div>
-<ul>
- <li>Description</li>
-</ul>
-
-<p>Add a header to the usage output</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_option"><code>yetus_add_option</code></h3>
-
-<ul>
- <li>Synopsis</li>
-</ul>
-
-<div class="highlight"><pre class="highlight plaintext"><code>yetus_add_option subcommand subcommanddesc
-</code></pre></div>
-<ul>
- <li>Description</li>
-</ul>
-
-<p>Add an option to the usage output</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_array_to_comma"><code>yetus_array_to_comma</code></h3>
-
-<ul>
- <li>Synopsis</li>
-</ul>
-
-<div class="highlight"><pre class="highlight plaintext"><code>yetus_array_to_comma arrayname string
-</code></pre></div>
-<ul>
- <li>Description</li>
-</ul>
-
-<p>Convert an array to a comma-delimited string</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_comma_to_array"><code>yetus_comma_to_array</code></h3>
-
-<ul>
- <li>Synopsis</li>
-</ul>
-
-<div class="highlight"><pre class="highlight plaintext"><code>yetus_comma_to_array arrayname string
-</code></pre></div>
-<ul>
- <li>Description</li>
-</ul>
-
-<p>Convert a comma-delimited string to an array</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_file_to_array"><code>yetus_file_to_array</code></h3>
-
-<ul>
- <li>Synopsis</li>
-</ul>
-
-<div class="highlight"><pre class="highlight plaintext"><code>yetus_file_to_array arrayname file
-</code></pre></div>
-<ul>
- <li>Description</li>
-</ul>
-
-<p>Convert a file to an array. Comments on the beginning of the line are stripped.</p>
-
-<ul>
- <li>Returns</li>
-</ul>
-
-<p>0 for success</p>
-
-<p>1+ for failure</p>
-
-<table class="table table-bordered table-striped">
- <thead>
- <tr>
- <th style="text-align: left">Classification</th>
- <th style="text-align: left">Level</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td style="text-align: left">Audience</td>
- <td style="text-align: left">Public</td>
- </tr>
- <tr>
- <td style="text-align: left">Stability</td>
- <td style="text-align: left">Evolving</td>
- </tr>
- <tr>
- <td style="text-align: left">Replaceable</td>
- <td style="text-align: left">No</td>
- </tr>
- </tbody>
-</table>
-
-<h3 id="yetus_generic_columnprinter"><code>yetus_generic_columnprinter</code></h3>
-
-<ul>
- <li>Synopsis</li>
-</ul>
-
-<div class="highlight"><pre class="highlight plaintext"><code>yetus_generic_columnprinter array
-</code></pre></div>
-<ul>
- <li>Description</li>
-</ul>
-
-<p>Print a screen-size aware two-column output</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>
-
-<h2 id="privatestablereplaceable">Private/Stable/Replaceable</h2>
-<h3 id="docker_do_env_adds"><code>docker_do_env_adds</code></h3>
-
-<ul>
- <li>Synopsis</li>
-</ul>
-
-<div class="highlight"><pre class="highlight plaintext"><code>docker_do_env_adds
-</code></pre></div>
-<ul>
- <li>Description</li>
-</ul>
-
-<p>Do the work to add the env vars onto the Docker cmd</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>
-
-<h3 id="reaper_initialize"><code>reaper_initialize</code></h3>
-
-<ul>
- <li>Synopsis</li>
-</ul>
-
-<div class="highlight"><pre class="highlight plaintext"><code>reaper_initialize arguments
-</code></pre></div>
-<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>
-
-<h3 id="yetus_array_contains"><code>yetus_array_contains</code></h3>
-
-<ul>
- <li>Synopsis</li>
-</ul>
-
-<div class="highlight"><pre class="highlight plaintext"><code>yetus_array_contains element array
-</code></pre></div>
-<ul>
- <li>Description</li>
-</ul>
-
-<p>Check if an array has a given value</p>
-
-<ul>
- <li>Returns</li>
-</ul>
-
-<h2 id="returns------0--yes-1">@returns 0 = yes</h2>
-
-<h2 id="returns------1--no-1">@returns 1 = no</h2>
-
-<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="privateevolvingreplaceable">Private/Evolving/Replaceable</h2>
-<h3 id="activate_robots"><code>activate_robots</code></h3>
-
-<ul>
- <li>Synopsis</li>
-</ul>
-
-<div class="highlight"><pre class="highlight plaintext"><code>activate_robots
-</code></pre></div>
-<ul>
- <li>Description</li>
-</ul>
-
-<p>import and set defaults based upon any auto-detected automation</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="pid_kill"><code>pid_kill</code></h3>
-
-<ul>
- <li>Synopsis</li>
-</ul>
-
-<div class="highlight"><pre class="highlight plaintext"><code>pid_kill pid
-</code></pre></div>
-<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>
-
-<h3 id="reaper_coproc_func"><code>reaper_coproc_func</code></h3>
-
-<ul>
- <li>Synopsis</li>
-</ul>
-
-<div class="highlight"><pre class="highlight plaintext"><code>reaper_coproc_func
-</code></pre></div>
-<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>
-
-<div class="highlight"><pre class="highlight plaintext"><code>reaper_finalize_results jdkname
-</code></pre></div>
-<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>
-
-<div class="highlight"><pre class="highlight plaintext"><code>reaper_post_exec module testlog testfrag
-</code></pre></div>
-<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>
-
-<div class="highlight"><pre class="highlight plaintext"><code>reaper_total_count jdkname
-</code></pre></div>
-<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="set_yetus_version"><code>set_yetus_version</code></h3>
-
-<ul>
- <li>Synopsis</li>
-</ul>
-
-<div class="highlight"><pre class="highlight plaintext"><code>set_yetus_version
-</code></pre></div>
-<ul>
- <li>Description</li>
-</ul>
-
-<p>set VERSION to the current version if not set</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>
- <footer class="footer">
- <div class="row-fluid">
- <div class="span12 text-left">
- <div class="span12">
- Copyright 2008-2020 <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>
diff --git a/documentation/0.13.0-SNAPSHOT/precommit-apidocs/index.html b/documentation/0.13.0-SNAPSHOT/precommit-apidocs/index.html
deleted file mode 100644
index 8730d15..0000000
--- a/documentation/0.13.0-SNAPSHOT/precommit-apidocs/index.html
+++ /dev/null
@@ -1,153 +0,0 @@
-<!---
- 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.10.0/">Docs for v0.10.0</a></li>
- <li><a href="/documentation/0.11.1/">Docs for v0.11.1</a></li>
- <li><a href="/documentation/0.12.0/">Docs for v0.12.0</a></li>
- <li><a href="/documentation/in-progress/">In Progress Docs for Contributors</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.
--->
-
-<h1 id="precommit-api-docs">Precommit API Docs</h1>
-
-<p>Following gives the downstream consumable API for precommit components.</p>
-
-<ul>
- <li><a href="core/">Core Functions</a>, common to both smart-apply-patch and test-patch.</li>
- <li><a href="smart-apply-patch/">Smart Apply Patch</a> available to all plugins when running under smart-apply-patch.</li>
- <li><a href="test-patch/">Test Patch</a>, available to all plugins when running under test-patch.</li>
- <li><a href="plugins/">Precommit Plugins</a> APIs available when they are also enabled.</li>
-</ul>
-
- </div>
-
-<div class="container">
- <hr>
- <footer class="footer">
- <div class="row-fluid">
- <div class="span12 text-left">
- <div class="span12">
- Copyright 2008-2020 <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>
diff --git a/documentation/0.13.0-SNAPSHOT/precommit-apidocs/plugins/index.html b/documentation/0.13.0-SNAPSHOT/precommit-apidocs/plugins/index.html
deleted file mode 100644
index 237b677..0000000
--- a/documentation/0.13.0-SNAPSHOT/precommit-apidocs/plugins/index.html
+++ /dev/null
@@ -1,876 +0,0 @@
-<!---
- 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.10.0/">Docs for v0.10.0</a></li>
- <li><a href="/documentation/0.11.1/">Docs for v0.11.1</a></li>
- <li><a href="/documentation/0.12.0/">Docs for v0.12.0</a></li>
- <li><a href="/documentation/in-progress/">In Progress Docs for Contributors</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">Yes</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">Yes</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">Yes</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">Yes</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">No</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">Yes</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">Yes</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">Yes</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">Yes</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">Yes</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">Yes</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">Yes</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">Yes</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">Yes</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">Yes</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">Yes</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-2020 <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>
diff --git a/documentation/0.13.0-SNAPSHOT/precommit-apidocs/smart-apply-patch/index.html b/documentation/0.13.0-SNAPSHOT/precommit-apidocs/smart-apply-patch/index.html
deleted file mode 100644
index 4bf6818..0000000
--- a/documentation/0.13.0-SNAPSHOT/precommit-apidocs/smart-apply-patch/index.html
+++ /dev/null
@@ -1,240 +0,0 @@
-<!---
- 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.10.0/">Docs for v0.10.0</a></li>
- <li><a href="/documentation/0.11.1/">Docs for v0.11.1</a></li>
- <li><a href="/documentation/0.12.0/">Docs for v0.12.0</a></li>
- <li><a href="/documentation/in-progress/">In Progress Docs for Contributors</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/Not Replaceable
- <ul>
- <li><a href="#setup_defaults">setup_defaults</a></li>
- <li><a href="#yetus_usage">yetus_usage</a></li>
- </ul>
- </li>
-</ul>
-
-<hr />
-
-<h2 id="publicstablenot-replaceable">Public/Stable/Not Replaceable</h2>
-<h3 id="setup_defaults"><code>setup_defaults</code></h3>
-
-<ul>
- <li>Synopsis</li>
-</ul>
-
-<div class="highlight"><pre class="highlight plaintext"><code>setup_defaults
-</code></pre></div>
-<ul>
- <li>Description</li>
-</ul>
-
-<p>Setup the default global variables</p>
-
-<ul>
- <li>Returns</li>
-</ul>
-
-<p>Nothing</p>
-
-<table class="table table-bordered table-striped">
- <thead>
- <tr>
- <th style="text-align: left">Classification</th>
- <th style="text-align: left">Level</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td style="text-align: left">Audience</td>
- <td style="text-align: left">Public</td>
- </tr>
- <tr>
- <td style="text-align: left">Stability</td>
- <td style="text-align: left">Stable</td>
- </tr>
- <tr>
- <td style="text-align: left">Replaceable</td>
- <td style="text-align: left">No</td>
- </tr>
- </tbody>
-</table>
-
-<h3 id="yetus_usage"><code>yetus_usage</code></h3>
-
-<ul>
- <li>Synopsis</li>
-</ul>
-
-<div class="highlight"><pre class="highlight plaintext"><code>yetus_usage
-</code></pre></div>
-<ul>
- <li>Description</li>
-</ul>
-
-<p>Print the usage information</p>
-
-<ul>
- <li>Returns</li>
-</ul>
-
-<p>Nothing</p>
-
-<table class="table table-bordered table-striped">
- <thead>
- <tr>
- <th style="text-align: left">Classification</th>
- <th style="text-align: left">Level</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td style="text-align: left">Audience</td>
- <td style="text-align: left">Public</td>
- </tr>
- <tr>
- <td style="text-align: left">Stability</td>
- <td style="text-align: left">Stable</td>
- </tr>
- <tr>
- <td style="text-align: left">Replaceable</td>
- <td style="text-align: left">No</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-2020 <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>
diff --git a/documentation/0.13.0-SNAPSHOT/precommit-apidocs/test-patch/index.html b/documentation/0.13.0-SNAPSHOT/precommit-apidocs/test-patch/index.html
deleted file mode 100644
index c41e257..0000000
--- a/documentation/0.13.0-SNAPSHOT/precommit-apidocs/test-patch/index.html
+++ /dev/null
@@ -1,2350 +0,0 @@
-<!---
- 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.10.0/">Docs for v0.10.0</a></li>
- <li><a href="/documentation/0.11.1/">Docs for v0.11.1</a></li>
- <li><a href="/documentation/0.12.0/">Docs for v0.12.0</a></li>
- <li><a href="/documentation/in-progress/">In Progress Docs for Contributors</a>
- </li>
- </ul>
- </li>
- <li class="dropdown">
- <a class="dropdown-toggle" data-toggle="dropdown" href="#">Get Involved <span class="caret"></span></a>
- <ul class="dropdown-menu" role="menu" aria-labelledby="drop1">
- <li role="presentation"><a role="menuitem" tabindex="-1" href="/mailinglists"><i class="fa fa-commenting"></i> Mailing Lists</a>
- </li>
- <li role="presentation"><a role="menuitem" tabindex="-1" href="https://issues.apache.org/jira/browse/YETUS"><i class="fa fa-bug"></i> JIRA (Bugs)</a>
- </li>
- <li role="presentation"><a role="menuitem" tabindex="-1" href="https://gitbox.apache.org/repos/asf/yetus.git"><i class="fa fa-code"></i> Source (Apache)</a>
- </li>
- <li role="presentation"><a role="menuitem" tabindex="-1" href="https://github.com/apache/yetus"><i class="fa fa-github-alt"></i> Source (GitHub)</a>
- </li>
- <li role="presentation"><a role="menuitem" tabindex="-1" href="/contribute/"><i class="fa fa-code-fork"></i> Contributing</a>
- </li>
- <li role="presentation"><a role="menuitem" tabindex="-1" href="https://twitter.com/ApacheYetus"><i class="fa fa-twitter"></i> @ApacheYetus</a>
- </li>
- </ul>
- </li>
- <li>
- <li class="dropdown">
- <a class="dropdown-toggle" data-toggle="dropdown" href="#">Apache Software Foundation <b class="caret"></b></a>
- <ul class="dropdown-menu" role="menu">
- <li><a href="https://www.apache.org">Apache Homepage</a>
- </li>
- <li><a href="https://www.apache.org/licenses/">Apache License</a>
- </li>
- <li><a href="https://www.apache.org/foundation/sponsorship.html">Sponsorship</a>
- </li>
- <li><a href="https://www.apache.org/foundation/thanks.html">Thanks</a>
- </li>
- <li><a href="https://www.apache.org/security/">Security</a>
- </li>
- </ul>
- </li>
- </li>
- </ul>
- </div>
- <!--/.nav-collapse -->
- </div>
-</div>
-
- <div class="container">
-
-<!---
-# Licensed to the Apache Software Foundation (ASF) under one
-# or more contributor license agreements. See the NOTICE file
-# distributed with this work for additional information
-# regarding copyright ownership. The ASF licenses this file
-# to you under the Apache License, Version 2.0 (the
-# "License"); you may not use this file except in compliance
-# with the License. You may obtain a copy of the License at
-#
-# http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
--->
-<ul>
- <li>Public/Stable/Replaceable
- <ul>
- <li><a href="#verify_multijdk_test">verify_multijdk_test</a></li>
- </ul>
- </li>
- <li>Public/Stable/Not Replaceable
- <ul>
- <li><a href="#add_footer_table">add_footer_table</a></li>
- <li><a href="#add_header_line">add_header_line</a></li>
- <li><a href="#add_test_table">add_test_table</a></li>
- <li><a href="#add_vote_table">add_vote_table</a></li>
- <li><a href="#big_console_header">big_console_header</a></li>
- <li><a href="#clock_display">clock_display</a></li>
- <li><a href="#echo_and_redirect">echo_and_redirect</a></li>
- <li><a href="#git_checkout_force">git_checkout_force</a></li>
- <li><a href="#git_clean">git_clean</a></li>
- <li><a href="#offset_clock">offset_clock</a></li>
- <li><a href="#setup_defaults">setup_defaults</a></li>
- <li><a href="#start_clock">start_clock</a></li>
- <li><a href="#stop_clock">stop_clock</a></li>
- <li><a href="#write_comment">write_comment</a></li>
- <li><a href="#yetus_usage">yetus_usage</a></li>
- </ul>
- </li>
- <li>Public/Evolving/Not Replaceable
- <ul>
- <li><a href="#archive">archive</a></li>
- <li><a href="#bugsystem_linecomments_queue">bugsystem_linecomments_queue</a></li>
- <li><a href="#bugsystem_linecomments_trigger">bugsystem_linecomments_trigger</a></li>
- <li><a href="#buildtool_cwd">buildtool_cwd</a></li>
- <li><a href="#calcdiffs">calcdiffs</a></li>
- <li><a href="#clear_personality_queue">clear_personality_queue</a></li>
- <li><a href="#column_calcdiffs">column_calcdiffs</a></li>
- <li><a href="#compile">compile</a></li>
- <li><a href="#compile_cycle">compile_cycle</a></li>
- <li><a href="#compile_jvm">compile_jvm</a></li>
- <li><a href="#compile_nonjvm">compile_nonjvm</a></li>
- <li><a href="#dequeue_personality_module">dequeue_personality_module</a></li>
- <li><a href="#distclean">distclean</a></li>
- <li><a href="#error_calcdiffs">error_calcdiffs</a></li>
- <li><a href="#generic_calcdiff_status">generic_calcdiff_status</a></li>
- <li><a href="#generic_logfilter">generic_logfilter</a></li>
- <li><a href="#generic_post_handler">generic_post_handler</a></li>
- <li><a href="#generic_postlog_compare">generic_postlog_compare</a></li>
- <li><a href="#generic_pre_handler">generic_pre_handler</a></li>
- <li><a href="#initialize">initialize</a></li>
- <li><a href="#module_status">module_status</a></li>
- <li><a href="#modules_backup">modules_backup</a></li>
- <li><a href="#modules_messages">modules_messages</a></li>
- <li><a href="#modules_reset">modules_reset</a></li>
- <li><a href="#modules_restore">modules_restore</a></li>
- <li><a href="#modules_workers">modules_workers</a></li>
- <li><a href="#patchfiletests">patchfiletests</a></li>
- <li><a href="#personality_enqueue_module">personality_enqueue_module</a></li>
- </ul>
- </li>
- <li>Private/Stable/Replaceable
- <ul>
- <li><a href="#prepopulate_footer">prepopulate_footer</a></li>
- <li><a href="#report_jvm_version">report_jvm_version</a></li>
- </ul>
- </li>
- <li>Private/Evolving/Replaceable
- <ul>
- <li><a href="#start_coprocessors">start_coprocessors</a></li>
- <li><a href="#stop_coprocessors">stop_coprocessors</a></li>
- <li><a href="#verify_patchdir_still_exists">verify_patchdir_still_exists</a></li>
- </ul>
- </li>
-</ul>
-
-<hr />
-
-<h2 id="publicstablereplaceable">Public/Stable/Replaceable</h2>
-<h3 id="verify_multijdk_test"><code>verify_multijdk_test</code></h3>
-
-<ul>
- <li>Synopsis</li>
-</ul>
-
-<div class="highlight"><pre class="highlight plaintext"><code>verify_multijdk_test test
-</code></pre></div>
-<ul>
- <li>Description</li>
-</ul>
-
-<p>Verify if a given test is multijdk</p>
-
-<ul>
- <li>Returns</li>
-</ul>
-
-<p>0 = yes</p>
-
-<p>1 = no</p>
-
-<table class="table table-bordered table-striped">
- <thead>
- <tr>
- <th style="text-align: left">Classification</th>
- <th style="text-align: left">Level</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td style="text-align: left">Audience</td>
- <td style="text-align: left">Public</td>
- </tr>
- <tr>
- <td style="text-align: left">Stability</td>
- <td style="text-align: left">Stable</td>
- </tr>
- <tr>
- <td style="text-align: left">Replaceable</td>
- <td style="text-align: left">Yes</td>
- </tr>
- </tbody>
-</table>
-
-<h2 id="publicstablenot-replaceable">Public/Stable/Not Replaceable</h2>
-<h3 id="add_footer_table"><code>add_footer_table</code></h3>
-
-<ul>
- <li>Synopsis</li>
-</ul>
-
-<div class="highlight"><pre class="highlight plaintext"><code>add_footer_table subsystem string
-</code></pre></div>
-<ul>
- <li>Description</li>
-</ul>
-
-<p>Add to the footer of the display. @@BASE@@ will get replaced with the correct location for the local filesystem in dev mode or the URL for Jenkins mode.</p>
-
-<ul>
- <li>Returns</li>
-</ul>
-
-<p>Nothing</p>
-
-<table class="table table-bordered table-striped">
- <thead>
- <tr>
- <th style="text-align: left">Classification</th>
- <th style="text-align: left">Level</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td style="text-align: left">Audience</td>
- <td style="text-align: left">Public</td>
- </tr>
- <tr>
- <td style="text-align: left">Stability</td>
- <td style="text-align: left">Stable</td>
- </tr>
- <tr>
- <td style="text-align: left">Replaceable</td>
- <td style="text-align: left">No</td>
- </tr>
- </tbody>
-</table>
-
-<h3 id="add_header_line"><code>add_header_line</code></h3>
-
-<ul>
- <li>Synopsis</li>
-</ul>
-
-<div class="highlight"><pre class="highlight plaintext"><code>add_header_line string
-</code></pre></div>
-<ul>
- <li>Description</li>
-</ul>
-
-<p>Add to the header of the display</p>
-
-<ul>
- <li>Returns</li>
-</ul>
-
-<p>Nothing</p>
-
-<table class="table table-bordered table-striped">
- <thead>
- <tr>
- <th style="text-align: left">Classification</th>
- <th style="text-align: left">Level</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td style="text-align: left">Audience</td>
- <td style="text-align: left">Public</td>
- </tr>
- <tr>
- <td style="text-align: left">Stability</td>
- <td style="text-align: left">Stable</td>
- </tr>
- <tr>
- <td style="text-align: left">Replaceable</td>
- <td style="text-align: left">No</td>
- </tr>
- </tbody>
-</table>
-
-<h3 id="add_test_table"><code>add_test_table</code></h3>
-
-<ul>
- <li>Synopsis</li>
-</ul>
-
-<div class="highlight"><pre class="highlight plaintext"><code>add_test_table failurereason testlist
-</code></pre></div>
-<ul>
- <li>Description</li>
-</ul>
-
-<p>Special table just for unit test failures</p>
-
-<ul>
- <li>Returns</li>
-</ul>
-
-<p>Nothing</p>
-
-<table class="table table-bordered table-striped">
- <thead>
- <tr>
- <th style="text-align: left">Classification</th>
- <th style="text-align: left">Level</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td style="text-align: left">Audience</td>
- <td style="text-align: left">Public</td>
- </tr>
- <tr>
- <td style="text-align: left">Stability</td>
- <td style="text-align: left">Stable</td>
- </tr>
- <tr>
- <td style="text-align: left">Replaceable</td>
- <td style="text-align: left">No</td>
- </tr>
- </tbody>
-</table>
-
-<h3 id="add_vote_table"><code>add_vote_table</code></h3>
-
-<ul>
- <li>Synopsis</li>
-</ul>
-
-<div class="highlight"><pre class="highlight plaintext"><code>add_vote_table +1/0/-1/H subsystem string
-</code></pre></div>
-<ul>
- <li>Description</li>
-</ul>
-
-<p>Add to the output table. If the first parameter is a number that is the vote for that column and calculates the elapsed time based upon the last start_clock(). The second parameter is the reporting subsystem (or test) that is providing the vote. The second parameter is always required. The third parameter is any extra verbage that goes with that subsystem. if the vote is H, then that designates that "subsystem" should be a header in the vote table comment output. The other paramete [...]
-
-<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">No</td>
- </tr>
- </tbody>
-</table>
-
-<h3 id="big_console_header"><code>big_console_header</code></h3>
-
-<ul>
- <li>Synopsis</li>
-</ul>
-
-<div class="highlight"><pre class="highlight plaintext"><code>big_console_header string
-</code></pre></div>
-<ul>
- <li>Description</li>
-</ul>
-
-<p>Large display for the user console</p>
-
-<ul>
- <li>Returns</li>
-</ul>
-
-<p>large chunk of text</p>
-
-<table class="table table-bordered table-striped">
- <thead>
- <tr>
- <th style="text-align: left">Classification</th>
- <th style="text-align: left">Level</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td style="text-align: left">Audience</td>
- <td style="text-align: left">Public</td>
- </tr>
- <tr>
- <td style="text-align: left">Stability</td>
- <td style="text-align: left">Stable</td>
- </tr>
- <tr>
- <td style="text-align: left">Replaceable</td>
- <td style="text-align: left">No</td>
- </tr>
- </tbody>
-</table>
-
-<h3 id="clock_display"><code>clock_display</code></h3>
-
-<ul>
- <li>Synopsis</li>
-</ul>
-
-<div class="highlight"><pre class="highlight plaintext"><code>clock_display seconds
-</code></pre></div>
-<ul>
- <li>Description</li>
-</ul>
-
-<p>Convert time in seconds to m + s</p>
-
-<ul>
- <li>Returns</li>
-</ul>
-
-<p>Nothing</p>
-
-<table class="table table-bordered table-striped">
- <thead>
- <tr>
- <th style="text-align: left">Classification</th>
- <th style="text-align: left">Level</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td style="text-align: left">Audience</td>
- <td style="text-align: left">Public</td>
- </tr>
- <tr>
- <td style="text-align: left">Stability</td>
- <td style="text-align: left">Stable</td>
- </tr>
- <tr>
- <td style="text-align: left">Replaceable</td>
- <td style="text-align: left">No</td>
- </tr>
- </tbody>
-</table>
-
-<h3 id="echo_and_redirect"><code>echo_and_redirect</code></h3>
-
-<ul>
- <li>Synopsis</li>
-</ul>
-
-<div class="highlight"><pre class="highlight plaintext"><code>echo_and_redirect filename command [..]
-</code></pre></div>
-<ul>
- <li>Description</li>
-</ul>
-
-<p>Print the command to be executing to the screen. Then run the command, sending stdout and stderr to the given filename This will also ensure that any directories in ${BASEDIR} have the exec bit set as a pre-exec step.</p>
-
-<ul>
- <li>Returns</li>
-</ul>
-
-<p>$?</p>
-
-<table class="table table-bordered table-striped">
- <thead>
- <tr>
- <th style="text-align: left">Classification</th>
- <th style="text-align: left">Level</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td style="text-align: left">Audience</td>
- <td style="text-align: left">Public</td>
- </tr>
- <tr>
- <td style="text-align: left">Stability</td>
- <td style="text-align: left">Stable</td>
- </tr>
- <tr>
- <td style="text-align: left">Replaceable</td>
- <td style="text-align: left">No</td>
- </tr>
- </tbody>
-</table>
-
-<h3 id="git_checkout_force"><code>git_checkout_force</code></h3>
-
-<ul>
- <li>Synopsis</li>
-</ul>
-
-<div class="highlight"><pre class="highlight plaintext"><code>git_checkout_force
-</code></pre></div>
-<ul>
- <li>Description</li>
-</ul>
-
-<p>Forcibly reset the tree back to it's original state</p>
-
-<ul>
- <li>Returns</li>
-</ul>
-
-<p>0 on success</p>
-
-<table class="table table-bordered table-striped">
- <thead>
- <tr>
- <th style="text-align: left">Classification</th>
- <th style="text-align: left">Level</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td style="text-align: left">Audience</td>
- <td style="text-align: left">Public</td>
- </tr>
- <tr>
- <td style="text-align: left">Stability</td>
- <td style="text-align: left">Stable</td>
- </tr>
- <tr>
- <td style="text-align: left">Replaceable</td>
- <td style="text-align: left">No</td>
- </tr>
- </tbody>
-</table>
-
-<h3 id="git_clean"><code>git_clean</code></h3>
-
-<ul>
- <li>Synopsis</li>
-</ul>
-
-<div class="highlight"><pre class="highlight plaintext"><code>git_clean
-</code></pre></div>
-<ul>
- <li>Description</li>
-</ul>
-
-<p>git clean the repository</p>
-
-<ul>
- <li>Returns</li>
-</ul>
-
-<p>0 on success</p>
-
-<table class="table table-bordered table-striped">
- <thead>
- <tr>
- <th style="text-align: left">Classification</th>
- <th style="text-align: left">Level</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td style="text-align: left">Audience</td>
- <td style="text-align: left">Public</td>
- </tr>
- <tr>
- <td style="text-align: left">Stability</td>
- <td style="text-align: left">Stable</td>
- </tr>
- <tr>
- <td style="text-align: left">Replaceable</td>
- <td style="text-align: left">No</td>
- </tr>
- </tbody>
-</table>
-
-<h3 id="offset_clock"><code>offset_clock</code></h3>
-
-<ul>
- <li>Synopsis</li>
-</ul>
-
-<div class="highlight"><pre class="highlight plaintext"><code>offset_clock seconds
-</code></pre></div>
-<ul>
- <li>Description</li>
-</ul>
-
-<p>Add time to the local timer</p>
-
-<ul>
- <li>Returns</li>
-</ul>
-
-<p>Nothing</p>
-
-<table class="table table-bordered table-striped">
- <thead>
- <tr>
- <th style="text-align: left">Classification</th>
- <th style="text-align: left">Level</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td style="text-align: left">Audience</td>
- <td style="text-align: left">Public</td>
- </tr>
- <tr>
- <td style="text-align: left">Stability</td>
- <td style="text-align: left">Stable</td>
- </tr>
- <tr>
- <td style="text-align: left">Replaceable</td>
- <td style="text-align: left">No</td>
- </tr>
- </tbody>
-</table>
-
-<h3 id="setup_defaults"><code>setup_defaults</code></h3>
-
-<ul>
- <li>Synopsis</li>
-</ul>
-
-<div class="highlight"><pre class="highlight plaintext"><code>setup_defaults
-</code></pre></div>
-<ul>
- <li>Description</li>
-</ul>
-
-<p>Setup the default global variables</p>
-
-<ul>
- <li>Returns</li>
-</ul>
-
-<p>Nothing</p>
-
-<table class="table table-bordered table-striped">
- <thead>
- <tr>
- <th style="text-align: left">Classification</th>
- <th style="text-align: left">Level</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td style="text-align: left">Audience</td>
- <td style="text-align: left">Public</td>
- </tr>
- <tr>
- <td style="text-align: left">Stability</td>
- <td style="text-align: left">Stable</td>
- </tr>
- <tr>
- <td style="text-align: left">Replaceable</td>
- <td style="text-align: left">No</td>
- </tr>
- </tbody>
-</table>
-
-<h3 id="start_clock"><code>start_clock</code></h3>
-
-<ul>
- <li>Synopsis</li>
-</ul>
-
-<div class="highlight"><pre class="highlight plaintext"><code>start_clock
-</code></pre></div>
-<ul>
- <li>Description</li>
-</ul>
-
-<p>Activate the local timer</p>
-
-<ul>
- <li>Returns</li>
-</ul>
-
-<p>Nothing</p>
-
-<table class="table table-bordered table-striped">
- <thead>
- <tr>
- <th style="text-align: left">Classification</th>
- <th style="text-align: left">Level</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td style="text-align: left">Audience</td>
- <td style="text-align: left">Public</td>
- </tr>
- <tr>
- <td style="text-align: left">Stability</td>
- <td style="text-align: left">Stable</td>
- </tr>
- <tr>
- <td style="text-align: left">Replaceable</td>
- <td style="text-align: left">No</td>
- </tr>
- </tbody>
-</table>
-
-<h3 id="stop_clock"><code>stop_clock</code></h3>
-
-<ul>
- <li>Synopsis</li>
-</ul>
-
-<div class="highlight"><pre class="highlight plaintext"><code>stop_clock
-</code></pre></div>
-<ul>
- <li>Description</li>
-</ul>
-
-<p>Print the elapsed time in seconds since the start of the local timer</p>
-
-<ul>
- <li>Returns</li>
-</ul>
-
-<p>Nothing</p>
-
-<table class="table table-bordered table-striped">
- <thead>
- <tr>
- <th style="text-align: left">Classification</th>
- <th style="text-align: left">Level</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td style="text-align: left">Audience</td>
- <td style="text-align: left">Public</td>
- </tr>
- <tr>
- <td style="text-align: left">Stability</td>
- <td style="text-align: left">Stable</td>
- </tr>
- <tr>
- <td style="text-align: left">Replaceable</td>
- <td style="text-align: left">No</td>
- </tr>
- </tbody>
-</table>
-
-<h3 id="write_comment"><code>write_comment</code></h3>
-
-<ul>
- <li>Synopsis</li>
-</ul>
-
-<div class="highlight"><pre class="highlight plaintext"><code>write_comment filename
-</code></pre></div>
-<ul>
- <li>Description</li>
-</ul>
-
-<p>Write the contents of a file to all of the bug systems (so content should avoid special formatting)</p>
-
-<ul>
- <li>Returns</li>
-</ul>
-
-<p>Nothing</p>
-
-<table class="table table-bordered table-striped">
- <thead>
- <tr>
- <th style="text-align: left">Classification</th>
- <th style="text-align: left">Level</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td style="text-align: left">Audience</td>
- <td style="text-align: left">Public</td>
- </tr>
- <tr>
- <td style="text-align: left">Stability</td>
- <td style="text-align: left">Stable</td>
- </tr>
- <tr>
- <td style="text-align: left">Replaceable</td>
- <td style="text-align: left">No</td>
- </tr>
- </tbody>
-</table>
-
-<h3 id="yetus_usage"><code>yetus_usage</code></h3>
-
-<ul>
- <li>Synopsis</li>
-</ul>
-
-<div class="highlight"><pre class="highlight plaintext"><code>yetus_usage
-</code></pre></div>
-<ul>
- <li>Description</li>
-</ul>
-
-<p>Print the usage information</p>
-
-<ul>
- <li>Returns</li>
-</ul>
-
-<p>Nothing</p>
-
-<table class="table table-bordered table-striped">
- <thead>
- <tr>
- <th style="text-align: left">Classification</th>
- <th style="text-align: left">Level</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td style="text-align: left">Audience</td>
- <td style="text-align: left">Public</td>
- </tr>
- <tr>
- <td style="text-align: left">Stability</td>
- <td style="text-align: left">Stable</td>
- </tr>
- <tr>
- <td style="text-align: left">Replaceable</td>
- <td style="text-align: left">No</td>
- </tr>
- </tbody>
-</table>
-
-<h2 id="publicevolvingnot-replaceable">Public/Evolving/Not Replaceable</h2>
-<h3 id="archive"><code>archive</code></h3>
-
-<ul>
- <li>Synopsis</li>
-</ul>
-
-<div class="highlight"><pre class="highlight plaintext"><code>archive
-</code></pre></div>
-<ul>
- <li>Description</li>
-</ul>
-
-<p>Save file names and directory to the patch dir</p>
-
-<ul>
- <li>Returns</li>
-</ul>
-
-<p>Nothing</p>
-
-<table class="table table-bordered table-striped">
- <thead>
- <tr>
- <th style="text-align: left">Classification</th>
- <th style="text-align: left">Level</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td style="text-align: left">Audience</td>
- <td style="text-align: left">Public</td>
- </tr>
- <tr>
- <td style="text-align: left">Stability</td>
- <td style="text-align: left">Evolving</td>
- </tr>
- <tr>
- <td style="text-align: left">Replaceable</td>
- <td style="text-align: left">No</td>
- </tr>
- </tbody>
-</table>
-
-<h3 id="bugsystem_linecomments_queue"><code>bugsystem_linecomments_queue</code></h3>
-
-<ul>
- <li>Synopsis</li>
-</ul>
-
-<div class="highlight"><pre class="highlight plaintext"><code>bugsystem_linecomments_queue plugin filename
-</code></pre></div>
-<ul>
- <li>Description</li>
-</ul>
-
-<p>Queue up comments to write into bug systems that have code review support, if such support enabled/available. File should be in the form of "file:line:comment"</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="bugsystem_linecomments_trigger"><code>bugsystem_linecomments_trigger</code></h3>
-
-<ul>
- <li>Synopsis</li>
-</ul>
-
-<div class="highlight"><pre class="highlight plaintext"><code>bugsystem_linecomments_trigger
-</code></pre></div>
-<ul>
- <li>Description</li>
-</ul>
-
-<p>Write all of the bugsystem linecomments</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="buildtool_cwd"><code>buildtool_cwd</code></h3>
-
-<ul>
- <li>Synopsis</li>
-</ul>
-
-<div class="highlight"><pre class="highlight plaintext"><code>buildtool_cwd MODULE_ index
-</code></pre></div>
-<ul>
- <li>Description</li>
-</ul>
-
-<p>change the working directory to execute the buildtool</p>
-
-<ul>
- <li>Returns</li>
-</ul>
-
-<p>Nothing</p>
-
-<table class="table table-bordered table-striped">
- <thead>
- <tr>
- <th style="text-align: left">Classification</th>
- <th style="text-align: left">Level</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td style="text-align: left">Audience</td>
- <td style="text-align: left">Public</td>
- </tr>
- <tr>
- <td style="text-align: left">Stability</td>
- <td style="text-align: left">Evolving</td>
- </tr>
- <tr>
- <td style="text-align: left">Replaceable</td>
- <td style="text-align: left">No</td>
- </tr>
- </tbody>
-</table>
-
-<h3 id="calcdiffs"><code>calcdiffs</code></h3>
-
-<ul>
- <li>Synopsis</li>
-</ul>
-
-<div class="highlight"><pre class="highlight plaintext"><code>calcdiffs branchlog patchlog testtype
-</code></pre></div>
-<ul>
- <li>Description</li>
-</ul>
-
-<p>Wrapper to call specific version of calcdiffs if available otherwise calls error_calcdiffs</p>
-
-<ul>
- <li>Returns</li>
-</ul>
-
-<p>differences</p>
-
-<table class="table table-bordered table-striped">
- <thead>
- <tr>
- <th style="text-align: left">Classification</th>
- <th style="text-align: left">Level</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td style="text-align: left">Audience</td>
- <td style="text-align: left">Public</td>
- </tr>
- <tr>
- <td style="text-align: left">Stability</td>
- <td style="text-align: left">Evolving</td>
- </tr>
- <tr>
- <td style="text-align: left">Replaceable</td>
- <td style="text-align: left">No</td>
- </tr>
- </tbody>
-</table>
-
-<h3 id="clear_personality_queue"><code>clear_personality_queue</code></h3>
-
-<ul>
- <li>Synopsis</li>
-</ul>
-
-<div class="highlight"><pre class="highlight plaintext"><code>clear_personality_queue
-</code></pre></div>
-<ul>
- <li>Description</li>
-</ul>
-
-<p>Reset the queue for tests</p>
-
-<ul>
- <li>Returns</li>
-</ul>
-
-<p>Nothing</p>
-
-<table class="table table-bordered table-striped">
- <thead>
- <tr>
- <th style="text-align: left">Classification</th>
- <th style="text-align: left">Level</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td style="text-align: left">Audience</td>
- <td style="text-align: left">Public</td>
- </tr>
- <tr>
- <td style="text-align: left">Stability</td>
- <td style="text-align: left">Evolving</td>
- </tr>
- <tr>
- <td style="text-align: left">Replaceable</td>
- <td style="text-align: left">No</td>
- </tr>
- </tbody>
-</table>
-
-<h3 id="column_calcdiffs"><code>column_calcdiffs</code></h3>
-
-<ul>
- <li>Synopsis</li>
-</ul>
-
-<div class="highlight"><pre class="highlight plaintext"><code>column_calcdiffs branchlog patchlog
-</code></pre></div>
-<ul>
- <li>Description</li>
-</ul>
-
-<p>Calculate the differences between the specified files using just the column+ messages (third+ column in a</p>
-
-<ul>
- <li>Returns</li>
-</ul>
-
-<p>differences</p>
-
-<table class="table table-bordered table-striped">
- <thead>
- <tr>
- <th style="text-align: left">Classification</th>
- <th style="text-align: left">Level</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td style="text-align: left">Audience</td>
- <td style="text-align: left">Public</td>
- </tr>
- <tr>
- <td style="text-align: left">Stability</td>
- <td style="text-align: left">Evolving</td>
- </tr>
- <tr>
- <td style="text-align: left">Replaceable</td>
- <td style="text-align: left">No</td>
- </tr>
- </tbody>
-</table>
-
-<h3 id="compile"><code>compile</code></h3>
-
-<ul>
- <li>Synopsis</li>
-</ul>
-
-<div class="highlight"><pre class="highlight plaintext"><code>compile branch|patch
-</code></pre></div>
-<ul>
- <li>Description</li>
-</ul>
-
-<p>Execute the compile phase. This will callout to _compile</p>
-
-<ul>
- <li>Returns</li>
-</ul>
-
-<p>0 on success</p>
-
-<p>1 on failure</p>
-
-<table class="table table-bordered table-striped">
- <thead>
- <tr>
- <th style="text-align: left">Classification</th>
- <th style="text-align: left">Level</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td style="text-align: left">Audience</td>
- <td style="text-align: left">Public</td>
- </tr>
- <tr>
- <td style="text-align: left">Stability</td>
- <td style="text-align: left">Evolving</td>
- </tr>
- <tr>
- <td style="text-align: left">Replaceable</td>
- <td style="text-align: left">No</td>
- </tr>
- </tbody>
-</table>
-
-<h3 id="compile_cycle"><code>compile_cycle</code></h3>
-
-<ul>
- <li>Synopsis</li>
-</ul>
-
-<div class="highlight"><pre class="highlight plaintext"><code>compile_cycle branch|patch
-</code></pre></div>
-<ul>
- <li>Description</li>
-</ul>
-
-<p>Execute the static analysis test cycle. This will callout to _precompile, compile, _postcompile and _rebuild</p>
-
-<ul>
- <li>Returns</li>
-</ul>
-
-<p>0 on success</p>
-
-<p>1 on failure</p>
-
-<table class="table table-bordered table-striped">
- <thead>
- <tr>
- <th style="text-align: left">Classification</th>
- <th style="text-align: left">Level</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td style="text-align: left">Audience</td>
- <td style="text-align: left">Public</td>
- </tr>
- <tr>
- <td style="text-align: left">Stability</td>
- <td style="text-align: left">Evolving</td>
- </tr>
- <tr>
- <td style="text-align: left">Replaceable</td>
- <td style="text-align: left">No</td>
- </tr>
- </tbody>
-</table>
-
-<h3 id="compile_jvm"><code>compile_jvm</code></h3>
-
-<ul>
- <li>Synopsis</li>
-</ul>
-
-<div class="highlight"><pre class="highlight plaintext"><code>compile_jvm branch|patch
-</code></pre></div>
-<ul>
- <li>Description</li>
-</ul>
-
-<p>Execute the compile phase. This will callout to _compile</p>
-
-<ul>
- <li>Returns</li>
-</ul>
-
-<p>0 on success</p>
-
-<p>1 on failure</p>
-
-<table class="table table-bordered table-striped">
- <thead>
- <tr>
- <th style="text-align: left">Classification</th>
- <th style="text-align: left">Level</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td style="text-align: left">Audience</td>
- <td style="text-align: left">Public</td>
- </tr>
- <tr>
- <td style="text-align: left">Stability</td>
- <td style="text-align: left">Evolving</td>
- </tr>
- <tr>
- <td style="text-align: left">Replaceable</td>
- <td style="text-align: left">No</td>
- </tr>
- </tbody>
-</table>
-
-<h3 id="compile_nonjvm"><code>compile_nonjvm</code></h3>
-
-<ul>
- <li>Synopsis</li>
-</ul>
-
-<div class="highlight"><pre class="highlight plaintext"><code>compile_nonjvm branch|patch
-</code></pre></div>
-<ul>
- <li>Description</li>
-</ul>
-
-<p>Execute the compile phase. This will callout to _compile</p>
-
-<ul>
- <li>Returns</li>
-</ul>
-
-<p>0 on success</p>
-
-<p>1 on failure</p>
-
-<table class="table table-bordered table-striped">
- <thead>
- <tr>
- <th style="text-align: left">Classification</th>
- <th style="text-align: left">Level</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td style="text-align: left">Audience</td>
- <td style="text-align: left">Public</td>
- </tr>
- <tr>
- <td style="text-align: left">Stability</td>
- <td style="text-align: left">Evolving</td>
- </tr>
- <tr>
- <td style="text-align: left">Replaceable</td>
- <td style="text-align: left">No</td>
- </tr>
- </tbody>
-</table>
-
-<h3 id="dequeue_personality_module"><code>dequeue_personality_module</code></h3>
-
-<ul>
- <li>Synopsis</li>
-</ul>
-
-<div class="highlight"><pre class="highlight plaintext"><code>dequeue_personality_module modulenames
-</code></pre></div>
-<ul>
- <li>Description</li>
-</ul>
-
-<p>Remove a module</p>
-
-<ul>
- <li>Returns</li>
-</ul>
-
-<p>Nothing</p>
-
-<table class="table table-bordered table-striped">
- <thead>
- <tr>
- <th style="text-align: left">Classification</th>
- <th style="text-align: left">Level</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td style="text-align: left">Audience</td>
- <td style="text-align: left">Public</td>
- </tr>
- <tr>
- <td style="text-align: left">Stability</td>
- <td style="text-align: left">Evolving</td>
- </tr>
- <tr>
- <td style="text-align: left">Replaceable</td>
- <td style="text-align: left">No</td>
- </tr>
- </tbody>
-</table>
-
-<h3 id="distclean"><code>distclean</code></h3>
-
-<ul>
- <li>Synopsis</li>
-</ul>
-
-<div class="highlight"><pre class="highlight plaintext"><code>distclean
-</code></pre></div>
-<ul>
- <li>Description</li>
-</ul>
-
-<p>Wipe the repo clean to not invalidate tests</p>
-
-<ul>
- <li>Returns</li>
-</ul>
-
-<p>0 on success</p>
-
-<p>1 on failure</p>
-
-<table class="table table-bordered table-striped">
- <thead>
- <tr>
- <th style="text-align: left">Classification</th>
- <th style="text-align: left">Level</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td style="text-align: left">Audience</td>
- <td style="text-align: left">Public</td>
- </tr>
- <tr>
- <td style="text-align: left">Stability</td>
- <td style="text-align: left">Evolving</td>
- </tr>
- <tr>
- <td style="text-align: left">Replaceable</td>
- <td style="text-align: left">No</td>
- </tr>
- </tbody>
-</table>
-
-<h3 id="error_calcdiffs"><code>error_calcdiffs</code></h3>
-
-<ul>
- <li>Synopsis</li>
-</ul>
-
-<div class="highlight"><pre class="highlight plaintext"><code>error_calcdiffs branchlog patchlog
-</code></pre></div>
-<ul>
- <li>Description</li>
-</ul>
-
-<p>Calculate the differences between the specified files using just the error messages (last column in a</p>
-
-<ul>
- <li>Returns</li>
-</ul>
-
-<p>differences</p>
-
-<table class="table table-bordered table-striped">
- <thead>
- <tr>
- <th style="text-align: left">Classification</th>
- <th style="text-align: left">Level</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td style="text-align: left">Audience</td>
- <td style="text-align: left">Public</td>
- </tr>
- <tr>
- <td style="text-align: left">Stability</td>
- <td style="text-align: left">Evolving</td>
- </tr>
- <tr>
- <td style="text-align: left">Replaceable</td>
- <td style="text-align: left">No</td>
- </tr>
- </tbody>
-</table>
-
-<h3 id="generic_calcdiff_status"><code>generic_calcdiff_status</code></h3>
-
-<ul>
- <li>Synopsis</li>
-</ul>
-
-<div class="highlight"><pre class="highlight plaintext"><code>generic_calcdiff_status totalbranchissues totalpatchissues newpatchissues
-</code></pre></div>
-<ul>
- <li>Description</li>
-</ul>
-
-<p>generate a standarized calcdiff status message</p>
-
-<ul>
- <li>Returns</li>
-</ul>
-
-<p>errorstring</p>
-
-<table class="table table-bordered table-striped">
- <thead>
- <tr>
- <th style="text-align: left">Classification</th>
- <th style="text-align: left">Level</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td style="text-align: left">Audience</td>
- <td style="text-align: left">Public</td>
- </tr>
- <tr>
- <td style="text-align: left">Stability</td>
- <td style="text-align: left">Evolving</td>
- </tr>
- <tr>
- <td style="text-align: left">Replaceable</td>
- <td style="text-align: left">No</td>
- </tr>
- </tbody>
-</table>
-
-<h3 id="generic_logfilter"><code>generic_logfilter</code></h3>
-
-<ul>
- <li>Synopsis</li>
-</ul>
-
-<div class="highlight"><pre class="highlight plaintext"><code>generic_logfilter
-</code></pre></div>
-<ul>
- <li>Description</li>
-</ul>
-
-<p>Helper routine for plugins to ask projects, etc to count problems in a log file and output it to stdout.</p>
-
-<ul>
- <li>Returns</li>
-</ul>
-
-<p>number of issues</p>
-
-<table class="table table-bordered table-striped">
- <thead>
- <tr>
- <th style="text-align: left">Classification</th>
- <th style="text-align: left">Level</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td style="text-align: left">Audience</td>
- <td style="text-align: left">Public</td>
- </tr>
- <tr>
- <td style="text-align: left">Stability</td>
- <td style="text-align: left">Evolving</td>
- </tr>
- <tr>
- <td style="text-align: left">Replaceable</td>
- <td style="text-align: left">No</td>
- </tr>
- </tbody>
-</table>
-
-<h3 id="generic_post_handler"><code>generic_post_handler</code></h3>
-
-<ul>
- <li>Synopsis</li>
-</ul>
-
-<div class="highlight"><pre class="highlight plaintext"><code>generic_post_handler origlog testtype multijdkmode run commands
-</code></pre></div>
-<ul>
- <li>Description</li>
-</ul>
-
-<p>Generic post-patch handler</p>
-
-<ul>
- <li>Returns</li>
-</ul>
-
-<p>0 on success</p>
-
-<p>1 on failure</p>
-
-<table class="table table-bordered table-striped">
- <thead>
- <tr>
- <th style="text-align: left">Classification</th>
- <th style="text-align: left">Level</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td style="text-align: left">Audience</td>
- <td style="text-align: left">Public</td>
- </tr>
- <tr>
- <td style="text-align: left">Stability</td>
- <td style="text-align: left">Evolving</td>
- </tr>
- <tr>
- <td style="text-align: left">Replaceable</td>
- <td style="text-align: left">No</td>
- </tr>
- </tbody>
-</table>
-
-<h3 id="generic_postlog_compare"><code>generic_postlog_compare</code></h3>
-
-<ul>
- <li>Synopsis</li>
-</ul>
-
-<div class="highlight"><pre class="highlight plaintext"><code>generic_postlog_compare origlog testtype multijdkmode
-</code></pre></div>
-<ul>
- <li>Description</li>
-</ul>
-
-<p>Generic post-patch log handler</p>
-
-<ul>
- <li>Returns</li>
-</ul>
-
-<p>0 on success</p>
-
-<p>1 on failure</p>
-
-<table class="table table-bordered table-striped">
- <thead>
- <tr>
- <th style="text-align: left">Classification</th>
- <th style="text-align: left">Level</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td style="text-align: left">Audience</td>
- <td style="text-align: left">Public</td>
- </tr>
- <tr>
- <td style="text-align: left">Stability</td>
- <td style="text-align: left">Evolving</td>
- </tr>
- <tr>
- <td style="text-align: left">Replaceable</td>
- <td style="text-align: left">No</td>
- </tr>
- </tbody>
-</table>
-
-<h3 id="generic_pre_handler"><code>generic_pre_handler</code></h3>
-
-<ul>
- <li>Synopsis</li>
-</ul>
-
-<div class="highlight"><pre class="highlight plaintext"><code>generic_pre_handler testype multijdk
-</code></pre></div>
-<ul>
- <li>Description</li>
-</ul>
-
-<p>Helper routine for plugins to do a pre-patch prun</p>
-
-<ul>
- <li>Returns</li>
-</ul>
-
-<p>1 on failure</p>
-
-<p>0 on success</p>
-
-<table class="table table-bordered table-striped">
- <thead>
- <tr>
- <th style="text-align: left">Classification</th>
- <th style="text-align: left">Level</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td style="text-align: left">Audience</td>
- <td style="text-align: left">Public</td>
- </tr>
- <tr>
- <td style="text-align: left">Stability</td>
- <td style="text-align: left">Evolving</td>
- </tr>
- <tr>
- <td style="text-align: left">Replaceable</td>
- <td style="text-align: left">No</td>
- </tr>
- </tbody>
-</table>
-
-<h3 id="initialize"><code>initialize</code></h3>
-
-<ul>
- <li>Synopsis</li>
-</ul>
-
-<div class="highlight"><pre class="highlight plaintext"><code>initialize $@
-</code></pre></div>
-<ul>
- <li>Description</li>
-</ul>
-
-<p>Setup to execute</p>
-
-<ul>
- <li>Returns</li>
-</ul>
-
-<p>0 on success</p>
-
-<p>1 on failure</p>
-
-<table class="table table-bordered table-striped">
- <thead>
- <tr>
- <th style="text-align: left">Classification</th>
- <th style="text-align: left">Level</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td style="text-align: left">Audience</td>
- <td style="text-align: left">Public</td>
- </tr>
- <tr>
- <td style="text-align: left">Stability</td>
- <td style="text-align: left">Evolving</td>
- </tr>
- <tr>
- <td style="text-align: left">Replaceable</td>
- <td style="text-align: left">No</td>
- </tr>
- </tbody>
-</table>
-
-<h3 id="module_status"><code>module_status</code></h3>
-
-<ul>
- <li>Synopsis</li>
-</ul>
-
-<div class="highlight"><pre class="highlight plaintext"><code>module_status moduleindex -1-0|0|+1 logvalue message
-</code></pre></div>
-<ul>
- <li>Description</li>
-</ul>
-
-<p>Add or update a test result. Update requires at least the first two parameters. WARNING: If the message is updated, then the JDK version is also calculated to match the current JAVA_HOME.</p>
-
-<ul>
- <li>Returns</li>
-</ul>
-
-<p>Nothing</p>
-
-<table class="table table-bordered table-striped">
- <thead>
- <tr>
- <th style="text-align: left">Classification</th>
- <th style="text-align: left">Level</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td style="text-align: left">Audience</td>
- <td style="text-align: left">Public</td>
- </tr>
- <tr>
- <td style="text-align: left">Stability</td>
- <td style="text-align: left">Evolving</td>
- </tr>
- <tr>
- <td style="text-align: left">Replaceable</td>
- <td style="text-align: left">No</td>
- </tr>
- </tbody>
-</table>
-
-<h3 id="modules_backup"><code>modules_backup</code></h3>
-
-<ul>
- <li>Synopsis</li>
-</ul>
-
-<div class="highlight"><pre class="highlight plaintext"><code>modules_backup
-</code></pre></div>
-<ul>
- <li>Description</li>
-</ul>
-
-<p>Backup the MODULE globals prior to loop processing</p>
-
-<ul>
- <li>Returns</li>
-</ul>
-
-<p>Nothing</p>
-
-<table class="table table-bordered table-striped">
- <thead>
- <tr>
- <th style="text-align: left">Classification</th>
- <th style="text-align: left">Level</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td style="text-align: left">Audience</td>
- <td style="text-align: left">Public</td>
- </tr>
- <tr>
- <td style="text-align: left">Stability</td>
- <td style="text-align: left">Evolving</td>
- </tr>
- <tr>
- <td style="text-align: left">Replaceable</td>
- <td style="text-align: left">No</td>
- </tr>
- </tbody>
-</table>
-
-<h3 id="modules_messages"><code>modules_messages</code></h3>
-
-<ul>
- <li>Synopsis</li>
-</ul>
-
-<div class="highlight"><pre class="highlight plaintext"><code>modules_messages repostatus testtype summarymode
-</code></pre></div>
-<ul>
- <li>Description</li>
-</ul>
-
-<p>Utility to print standard module errors</p>
-
-<ul>
- <li>Returns</li>
-</ul>
-
-<p>Nothing</p>
-
-<table class="table table-bordered table-striped">
- <thead>
- <tr>
- <th style="text-align: left">Classification</th>
- <th style="text-align: left">Level</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td style="text-align: left">Audience</td>
- <td style="text-align: left">Public</td>
- </tr>
- <tr>
- <td style="text-align: left">Stability</td>
- <td style="text-align: left">Evolving</td>
- </tr>
- <tr>
- <td style="text-align: left">Replaceable</td>
- <td style="text-align: left">No</td>
- </tr>
- </tbody>
-</table>
-
-<h3 id="modules_reset"><code>modules_reset</code></h3>
-
-<ul>
- <li>Synopsis</li>
-</ul>
-
-<div class="highlight"><pre class="highlight plaintext"><code>modules_reset
-</code></pre></div>
-<ul>
- <li>Description</li>
-</ul>
-
-<p>Reset the test results</p>
-
-<ul>
- <li>Returns</li>
-</ul>
-
-<p>Nothing</p>
-
-<table class="table table-bordered table-striped">
- <thead>
- <tr>
- <th style="text-align: left">Classification</th>
- <th style="text-align: left">Level</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td style="text-align: left">Audience</td>
- <td style="text-align: left">Public</td>
- </tr>
- <tr>
- <td style="text-align: left">Stability</td>
- <td style="text-align: left">Evolving</td>
- </tr>
- <tr>
- <td style="text-align: left">Replaceable</td>
- <td style="text-align: left">No</td>
- </tr>
- </tbody>
-</table>
-
-<h3 id="modules_restore"><code>modules_restore</code></h3>
-
-<ul>
- <li>Synopsis</li>
-</ul>
-
-<div class="highlight"><pre class="highlight plaintext"><code>modules_restore
-</code></pre></div>
-<ul>
- <li>Description</li>
-</ul>
-
-<p>Restore the backup</p>
-
-<ul>
- <li>Returns</li>
-</ul>
-
-<p>Nothing</p>
-
-<table class="table table-bordered table-striped">
- <thead>
- <tr>
- <th style="text-align: left">Classification</th>
- <th style="text-align: left">Level</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td style="text-align: left">Audience</td>
- <td style="text-align: left">Public</td>
- </tr>
- <tr>
- <td style="text-align: left">Stability</td>
- <td style="text-align: left">Evolving</td>
- </tr>
- <tr>
- <td style="text-align: left">Replaceable</td>
- <td style="text-align: left">No</td>
- </tr>
- </tbody>
-</table>
-
-<h3 id="modules_workers"><code>modules_workers</code></h3>
-
-<ul>
- <li>Synopsis</li>
-</ul>
-
-<div class="highlight"><pre class="highlight plaintext"><code>modules_workers repostatus testtype mvncmdline
-</code></pre></div>
-<ul>
- <li>Description</li>
-</ul>
-
-<p>run the tests for the queued modules</p>
-
-<ul>
- <li>Returns</li>
-</ul>
-
-<p>Nothing</p>
-
-<table class="table table-bordered table-striped">
- <thead>
- <tr>
- <th style="text-align: left">Classification</th>
- <th style="text-align: left">Level</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td style="text-align: left">Audience</td>
- <td style="text-align: left">Public</td>
- </tr>
- <tr>
- <td style="text-align: left">Stability</td>
- <td style="text-align: left">Evolving</td>
- </tr>
- <tr>
- <td style="text-align: left">Replaceable</td>
- <td style="text-align: left">No</td>
- </tr>
- </tbody>
-</table>
-
-<h3 id="patchfiletests"><code>patchfiletests</code></h3>
-
-<ul>
- <li>Synopsis</li>
-</ul>
-
-<div class="highlight"><pre class="highlight plaintext"><code>patchfiletests branch|patch
-</code></pre></div>
-<ul>
- <li>Description</li>
-</ul>
-
-<p>Execute the patch file test phase. Calls out to to _patchfile</p>
-
-<ul>
- <li>Returns</li>
-</ul>
-
-<p>0 on success</p>
-
-<p>1 on failure</p>
-
-<table class="table table-bordered table-striped">
- <thead>
- <tr>
- <th style="text-align: left">Classification</th>
- <th style="text-align: left">Level</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td style="text-align: left">Audience</td>
- <td style="text-align: left">Public</td>
- </tr>
- <tr>
- <td style="text-align: left">Stability</td>
- <td style="text-align: left">Evolving</td>
- </tr>
- <tr>
- <td style="text-align: left">Replaceable</td>
- <td style="text-align: left">No</td>
- </tr>
- </tbody>
-</table>
-
-<h3 id="personality_enqueue_module"><code>personality_enqueue_module</code></h3>
-
-<ul>
- <li>Synopsis</li>
-</ul>
-
-<div class="highlight"><pre class="highlight plaintext"><code>personality_enqueue_module module profiles/flags/etc
-</code></pre></div>
-<ul>
- <li>Description</li>
-</ul>
-
-<p>Build the queue for tests</p>
-
-<ul>
- <li>Returns</li>
-</ul>
-
-<p>Nothing</p>
-
-<table class="table table-bordered table-striped">
- <thead>
- <tr>
- <th style="text-align: left">Classification</th>
- <th style="text-align: left">Level</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td style="text-align: left">Audience</td>
- <td style="text-align: left">Public</td>
- </tr>
- <tr>
- <td style="text-align: left">Stability</td>
- <td style="text-align: left">Evolving</td>
- </tr>
- <tr>
- <td style="text-align: left">Replaceable</td>
- <td style="text-align: left">No</td>
- </tr>
- </tbody>
-</table>
-
-<h2 id="privatestablereplaceable">Private/Stable/Replaceable</h2>
-<h3 id="prepopulate_footer"><code>prepopulate_footer</code></h3>
-
-<ul>
- <li>Synopsis</li>
-</ul>
-
-<div class="highlight"><pre class="highlight plaintext"><code>prepopulate_footer
-</code></pre></div>
-<ul>
- <li>Description</li>
-</ul>
-
-<p>Put the opening environment information at the bottom of the footer table</p>
-
-<ul>
- <li>Returns</li>
-</ul>
-
-<p>Nothing</p>
-
-<table class="table table-bordered table-striped">
- <thead>
- <tr>
- <th style="text-align: left">Classification</th>
- <th style="text-align: left">Level</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td style="text-align: left">Audience</td>
- <td style="text-align: left">Private</td>
- </tr>
- <tr>
- <td style="text-align: left">Stability</td>
- <td style="text-align: left">Stable</td>
- </tr>
- <tr>
- <td style="text-align: left">Replaceable</td>
- <td style="text-align: left">Yes</td>
- </tr>
- </tbody>
-</table>
-
-<h3 id="report_jvm_version"><code>report_jvm_version</code></h3>
-
-<ul>
- <li>Synopsis</li>
-</ul>
-
-<div class="highlight"><pre class="highlight plaintext"><code>report_jvm_version directory
-</code></pre></div>
-<ul>
- <li>Description</li>
-</ul>
-
-<p>Report the JVM vendor and version of the given directory</p>
-
-<ul>
- <li>Returns</li>
-</ul>
-
-<p>vendor and version string</p>
-
-<table class="table table-bordered table-striped">
- <thead>
- <tr>
- <th style="text-align: left">Classification</th>
- <th style="text-align: left">Level</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td style="text-align: left">Audience</td>
- <td style="text-align: left">Private</td>
- </tr>
- <tr>
- <td style="text-align: left">Stability</td>
- <td style="text-align: left">Stable</td>
- </tr>
- <tr>
- <td style="text-align: left">Replaceable</td>
- <td style="text-align: left">Yes</td>
- </tr>
- </tbody>
-</table>
-
-<h2 id="privateevolvingreplaceable">Private/Evolving/Replaceable</h2>
-<h3 id="start_coprocessors"><code>start_coprocessors</code></h3>
-
-<ul>
- <li>Synopsis</li>
-</ul>
-
-<div class="highlight"><pre class="highlight plaintext"><code>start_coprocessors
-</code></pre></div>
-<ul>
- <li>Description</li>
-</ul>
-
-<p>Start any coprocessors</p>
-
-<ul>
- <li>Returns</li>
-</ul>
-
-<p>Nothing</p>
-
-<table class="table table-bordered table-striped">
- <thead>
- <tr>
- <th style="text-align: left">Classification</th>
- <th style="text-align: left">Level</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td style="text-align: left">Audience</td>
- <td style="text-align: left">Private</td>
- </tr>
- <tr>
- <td style="text-align: left">Stability</td>
- <td style="text-align: left">Evolving</td>
- </tr>
- <tr>
- <td style="text-align: left">Replaceable</td>
- <td style="text-align: left">Yes</td>
- </tr>
- </tbody>
-</table>
-
-<h3 id="stop_coprocessors"><code>stop_coprocessors</code></h3>
-
-<ul>
- <li>Synopsis</li>
-</ul>
-
-<div class="highlight"><pre class="highlight plaintext"><code>stop_coprocessors
-</code></pre></div>
-<ul>
- <li>Description</li>
-</ul>
-
-<p>Stop any coprocessors</p>
-
-<ul>
- <li>Returns</li>
-</ul>
-
-<p>Nothing</p>
-
-<table class="table table-bordered table-striped">
- <thead>
- <tr>
- <th style="text-align: left">Classification</th>
- <th style="text-align: left">Level</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td style="text-align: left">Audience</td>
- <td style="text-align: left">Private</td>
- </tr>
- <tr>
- <td style="text-align: left">Stability</td>
- <td style="text-align: left">Evolving</td>
- </tr>
- <tr>
- <td style="text-align: left">Replaceable</td>
- <td style="text-align: left">Yes</td>
- </tr>
- </tbody>
-</table>
-
-<h3 id="verify_patchdir_still_exists"><code>verify_patchdir_still_exists</code></h3>
-
-<ul>
- <li>Synopsis</li>
-</ul>
-
-<div class="highlight"><pre class="highlight plaintext"><code>verify_patchdir_still_exists
-</code></pre></div>
-<ul>
- <li>Description</li>
-</ul>
-
-<p>Verify that the patch directory is still in working order since bad actors on some systems wipe it out. If not, recreate it and then exit</p>
-
-<ul>
- <li>Returns</li>
-</ul>
-
-<p>may exit on failure</p>
-
-<table class="table table-bordered table-striped">
- <thead>
- <tr>
- <th style="text-align: left">Classification</th>
- <th style="text-align: left">Level</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td style="text-align: left">Audience</td>
- <td style="text-align: left">Private</td>
- </tr>
- <tr>
- <td style="text-align: left">Stability</td>
- <td style="text-align: left">Evolving</td>
- </tr>
- <tr>
- <td style="text-align: left">Replaceable</td>
- <td style="text-align: left">Yes</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-2020 <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>
diff --git a/documentation/0.13.0-SNAPSHOT/precommit-architecture/index.html b/documentation/0.13.0-SNAPSHOT/precommit-architecture/index.html
deleted file mode 100644
index 4b2676a..0000000
--- a/documentation/0.13.0-SNAPSHOT/precommit-architecture/index.html
+++ /dev/null
@@ -1,248 +0,0 @@
-<!---
- 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.10.0/">Docs for v0.10.0</a></li>
- <li><a href="/documentation/0.11.1/">Docs for v0.11.1</a></li>
- <li><a href="/documentation/0.12.0/">Docs for v0.12.0</a></li>
- <li><a href="/documentation/in-progress/">In Progress Docs for Contributors</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.
--->
-
-<h1 id="some-philosophy">Some Philosophy</h1>
-
-<ul>
- <li>
- <p>Everyone's time is valuable. The quicker contributors can get feedback and iterate, the more likely and faster their contribution will get checked in. A committer should be able to focus on the core issues of a contribution rather than details that can be determined automatically.</p>
- </li>
- <li>
- <p>Precommit checks should be fast. There is no value in testing parts of the source tree that are not immediately impacted by a change. Unit testing is the target. They are not a replacement for full builds or integration tests.</p>
- </li>
- <li>
- <p>Many open source projects have a desire to have this capability. Why not generalize a solution?</p>
- </li>
- <li>
- <p>In many build systems (especially with maven), a modular design has been picked. Why not leverage that design to make checks faster?</p>
- </li>
- <li>
- <p>Projects that use the same language will, with a high degree of certainty, benefit from the same types of checks.</p>
- </li>
- <li>
- <p>Portability matters. Tooling should be as operating system and language agnostic as possible.</p>
- </li>
-</ul>
-
-<h1 id="phases">Phases</h1>
-
-<p>test-patch works effectively under several different phases:</p>
-
-<h2 id="initialize">Initialize</h2>
-
-<p>This is where test-patch configures and validates the environment. Some things done in this phase:</p>
-
-<ul>
- <li>Defaults</li>
- <li>Parameter handling</li>
- <li>Importing plug-ins and personalities</li>
- <li>Docker container launching</li>
- <li>Re-exec support</li>
- <li>Patch file downloading</li>
- <li>git repository management (fresh pull, branch switching, etc)</li>
-</ul>
-
-<h2 id="precheck">Precheck</h2>
-
-<p>Checks done here are <em>fatal</em>.</p>
-
-<p>This acts as a verification of all of the setup parts and is the final place to short-cut the full test cycle. The most significant built-in check done here is verifying the patch file is a valid.</p>
-
-<h2 id="patch-file-tests">Patch File Tests</h2>
-
-<p>Tests that only require the patch file are run. Note that the repository is still from the initial checkout!</p>
-
-<h2 id="compile-cycle-branch">Compile Cycle (Branch)</h2>
-
-<p>When compilation must be done, we follow these five steps:</p>
-
-<ul>
- <li>The list of modules that require analysis is built.</li>
- <li>A precompile step to set things up for the actual compile</li>
- <li>The actual compile</li>
- <li>A postcompile to do analysis on the output of that compile phase</li>
- <li>A rebuild phase to run tests that require recompiles</li>
-</ul>
-
-<p>The first time this is done is with the pristine checkout. This is called the "branch compile". For this pass, this is where the 'before' work is handled. Some things that typically get checked in this phase:</p>
-
-<ul>
- <li>The first pass of files and modules that will get patched</li>
- <li>Validation and information gathering of the source tree pre-patch</li>
- <li>javadoc, scaladoc, etc</li>
-</ul>
-
-<h2 id="distribution-clean">Distribution Clean</h2>
-
-<p>This step is to wipe the repository clean back to a pristine state such that the previous cycle will not impact the next cycle.</p>
-
-<h2 id="patch-application">Patch Application</h2>
-
-<p>The patch gets applied.</p>
-
-<h2 id="compile-cycle-patch">Compile Cycle (Patch)</h2>
-
-<p>Now that the patch has been applied the steps to compile we outlined in the compilation (branch) phase are repeated but with the patch applied. This is where a lot of 'after' checks are performed.</p>
-
-<h2 id="unit-tests">Unit Tests</h2>
-
-<p>Since unit tests are generally the slowest part of the precommit process, they are run last. At this point, all the prerequisites to running them should be in place and ready to go.</p>
-
-<h2 id="reporting">Reporting</h2>
-
-<p>Finally, the results are reported to the screen and, optionally, to JIRA and/or whatever bug system has been configured.</p>
-
-<h1 id="test-flow">Test Flow</h1>
-
-<p>The basic workflow for many of the sub-items in individual phases are:</p>
-
-<ol>
- <li>print a header, so the end user knows that something is happening</li>
- <li>verify if the test is needed. If so, continue on. Otherwise, return success and let the next part of the phase execute.</li>
- <li>Ask the personality about what modules and what flags should get used</li>
- <li>Execute maven (or some other build tool) in the given modules with the given flags. Log the output and record the time and result code.</li>
- <li>Do any extra work as appropriate (diffs, counts, etc) and either accept the status and message given by the maven run or change the vote, message, log file, etc, based upon this extra work.</li>
- <li>Add the outcome(s) to the report generator</li>
-</ol>
-
-<p>As one can see, the modules list is one of the key inputs into what actually gets executed. As a result, projects must full flexibility in either adding, modifying, or even removing modules from the test list. If a personality removes the entire list of modules, then that test should just be ignored.</p>
-
- </div>
-
-<div class="container">
- <hr>
- <footer class="footer">
- <div class="row-fluid">
- <div class="span12 text-left">
- <div class="span12">
- Copyright 2008-2020 <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>
diff --git a/documentation/0.13.0-SNAPSHOT/precommit-basic/index.html b/documentation/0.13.0-SNAPSHOT/precommit-basic/index.html
deleted file mode 100644
index 20a4a2d..0000000
--- a/documentation/0.13.0-SNAPSHOT/precommit-basic/index.html
+++ /dev/null
@@ -1,514 +0,0 @@
-<!---
- 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.10.0/">Docs for v0.10.0</a></li>
- <li><a href="/documentation/0.11.1/">Docs for v0.11.1</a></li>
- <li><a href="/documentation/0.12.0/">Docs for v0.12.0</a></li>
- <li><a href="/documentation/in-progress/">In Progress Docs for Contributors</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.
--->
-
-<h1 id="basic-precommit">Basic Precommit</h1>
-
-<!-- MarkdownTOC levels="1,2" autolink="true" -->
-
-<ul>
- <li><a href="#purpose">Purpose</a></li>
- <li><a href="#pre-requisites">Pre-requisites</a>
- <ul>
- <li><a href="#base-requirements">Base Requirements</a></li>
- <li><a href="#optional-requirements">Optional Requirements</a></li>
- </ul>
- </li>
- <li><a href="#first-steps">First Steps</a></li>
- <li><a href="#resetting-the-repository">Resetting the Repository</a></li>
- <li><a href="#enabling-features">Enabling Features</a></li>
- <li><a href="#output-directory">Output Directory</a></li>
- <li><a href="#build-tool">Build Tool</a></li>
- <li><a href="#providing-patch-files">Providing Patch Files</a>
- <ul>
- <li><a href="#jira">JIRA</a></li>
- <li><a href="#github">GITHUB</a></li>
- <li><a href="#gitlab">GITLAB</a></li>
- <li><a href="#generic-urls">Generic URLs</a></li>
- </ul>
- </li>
- <li><a href="#project-specific-capabilities">Project-specific Capabilities</a>
- <ul>
- <li><a href="#direct-method">Direct Method</a></li>
- <li><a href="#project-method">Project Method</a></li>
- </ul>
- </li>
- <li><a href="#fork-bomb-protection">Fork Bomb Protection</a></li>
- <li><a href="#multijdk">MultiJDK</a></li>
- <li><a href="#docker">Docker</a></li>
- <li><a href="#in-closing">In Closing</a></li>
-</ul>
-
-<!-- /MarkdownTOC -->
-
-<h1 id="purpose">Purpose</h1>
-
-<p>As part of Apache Hadoop's commit process, all patches to the source base go through a precommit test that does some (relatively) light checking to make sure the proposed change does not break unit tests and/or passes some other prerequisites such as code formatting guidelines. This is meant as a preliminary check for committers so that the basic patch is in a known state and for contributors to know if they have followed the project's guidelines. This check, called <code>test-patch [...]
-
-<p>Other projects have adopted a similar methodology after seeing great success in the Apache Hadoop model. Some have even gone as far as forking Apache Hadoop's precommit code and modifying it to meet their project's needs.</p>
-
-<p>One of the key facets of Apache Yetus is to bring together all of these forks under a common code base to help software development<br />
-as a whole.</p>
-
-<h1 id="pre-requisites">Pre-requisites</h1>
-
-<p><code>test-patch</code> and <code>smart-apply-patch</code> are written in bash for maximum portability. As such, it mostly assumes the locations of commands to be in the file path. However, in many cases, this assumption may be overridden via command line options.</p>
-
-<p>For Solaris and Solaris-like operating systems, the default location for the POSIX binaries is in <code>/usr/xpg4/bin</code> and the default location for the GNU binaries is <code>/usr/gnu/bin</code>.</p>
-
-<h2 id="base-requirements">Base Requirements</h2>
-
-<p>test-patch requires these installed components to execute:</p>
-
-<ul>
- <li>git-based project (and git 1.7.3 or higher installed)</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>
- <li>POSIX grep</li>
- <li>POSIX sed</li>
- <li><a href="https://curl.haxx.se/">curl</a> command</li>
- <li>file command</li>
-</ul>
-
-<h2 id="optional-requirements">Optional Requirements</h2>
-
-<p>Features are plug-in based and enabled either individually or collectively on the command line. From there, these are activated based upon tool availability, the languages being tested, etc. The external dependencies of plug-ins may have different licensing requirements than Apache Yetus.</p>
-
-<p>Bug Systems:</p>
-
-<ul>
- <li><a href="https://github.com/">GitHub</a>-based issue tracking</li>
- <li><a href="https://www.atlassian.com/software/jira">JIRA</a>-based issue tracking</li>
- <li><a href="https://www.bugzilla.org/">Bugzilla</a>-based issue tracking (Read Only)</li>
- <li><a href="https://www.gitlab.com">Gitlab</a>-based issue tracking</li>
-</ul>
-
-<p>Build Tools:</p>
-
-<ul>
- <li><a href="https://ant.apache.org">ant</a></li>
- <li><a href="https://www.gnu.org/software/autoconf/autoconf.html">autoconf</a></li>
- <li><a href="https://www.cmake.org">cmake</a></li>
- <li><a href="https://www.gradle.org">gradle</a></li>
- <li>make</li>
- <li><a href="https://maven.apache.org">maven</a></li>
-</ul>
-
-<p>Automation and Isolation:</p>
-
-<ul>
- <li><a href="https://www.circleci.com">Circle CI</a></li>
- <li><a href="https://www.docker.com">Docker</a> Minimum: 17.0+ (moby Client API 1.27.0+) - Recommended: 18.0+ (moby Client API 1.38.0+)</li>
- <li><a href="https://www.gitlab.com">Gitlab CI</a></li>
- <li><a href="https://www.jenkins-ci.org">Jenkins</a></li>
- <li><a href="https://www.travis-ci.com">Travis CI</a></li>
-</ul>
-
-<p>Unit Test Formats:</p>
-
-<ul>
- <li><a href="https://cmake.org/Wiki/CMake/Testing_With_CTest">ctest</a></li>
- <li><a href="https://junit.org/">JUnit</a></li>
- <li><a href="https://testanything.org/">TAP</a></li>
-</ul>
-
-<p>Compiler Support:</p>
-
-<ul>
- <li>C/C++</li>
- <li>Go</li>
- <li>Java</li>
- <li>Scala</li>
-</ul>
-
-<p>Language Support, Licensing, and more:</p>
-
-<ul>
- <li><a href="https://creadur.apache.org/rat/">Apache Creadur Rat</a> entries in build system or installed</li>
- <li><a href="https://github.com/bufbuild/buf">buf</a> installed</li>
- <li><a href="https://github.com/mrtazz/checkmake">checkmake</a> installed</li>
- <li><a href="https://checkstyle.sourceforge.net/">checkstyle</a> entries in build system (ant and maven only)</li>
- <li><a href="https://findbugs.sourceforge.net/">FindBugs</a> entries in build system and 3.x executables
- <ul>
- <li>NOTE: only one of FindBugs or SpotBugs may be used at a time.</li>
- </ul>
- </li>
- <li><a href="https://github.com/golangci/golangci-lint">golangci-lint</a>
- <ul>
- <li>NOTE: only Go modules are supported</li>
- </ul>
- </li>
- <li><a href="https://github.com/hadolint/hadolint">hadolint</a> installed</li>
- <li><a href="https://jshint.com">jshint</a> installed</li>
- <li><a href="https://github.com/igorshubovych/markdownlint-cli">markdownlint-cli</a> installed</li>
- <li><a href="https://perlcritic.com/">Perl::Critic</a> installed</li>
- <li><a href="https://www.pylint.org/">pylint</a> installed</li>
- <li><a href="https://github.com/mgechev/revive">revive</a> installed</li>
- <li><a href="https://batsov.com/rubocop/">rubocop</a> installed</li>
- <li><a href="https://github.com/koalaman/shellcheck">shellcheck</a> installed, preferably 0.3.6 or higher<br />
-*<a href="https://spotbugs.github.io/">SpotBugs</a>) entries in build system and 3.x executables
- <ul>
- <li>NOTE: only one of FindBugs or SpotBugs may be used at a time.</li>
- </ul>
- </li>
- <li><a href="https://github.com/adrienverge/yamllint">yamllint</a> installed</li>
-</ul>
-
-<h1 id="first-steps">First Steps</h1>
-
-<p>A typical local configuration is to have two repositories. One with the code you are working on and another, clean repository. The workflow looks similar to the following:</p>
-
-<div class="highlight"><pre class="highlight shell"><code><span class="nv">$ </span><span class="nb">cd</span> <workrepo>
-<span class="nv">$ </span>git format-patch master <span class="o">></span> /tmp/patchfile
-<span class="nv">$ </span>test-patch <span class="nt">--basedir</span><span class="o">=</span>/some/path/testrepo /tmp/patchfile
-</code></pre></div>
-<ol>
- <li>In your work repo, generate a patch.</li>
- <li>Run your patch against the test repository.</li>
-</ol>
-
-<p><code>--basedir</code> sets the location of the repository to use for testing. The <code>/tmp/patchfile</code> is the patch file that is generated by <code>git format-patch</code> or <code>git diff</code> or any number of other types of input.</p>
-
-<h1 id="resetting-the-repository">Resetting the Repository</h1>
-
-<p>After running that command, the test repository will contain the remnants of the build for later debugging. It is inconvenient to instead use:</p>
-
-<div class="highlight"><pre class="highlight shell"><code><span class="nv">$ </span><span class="nb">cd</span> <workrepo>
-<span class="nv">$ </span>git format-patch master <span class="o">></span> /tmp/patchfile
-<span class="nv">$ </span>test-patch <span class="nt">--basedir</span><span class="o">=</span>/some/path/testrepo <span class="nt">--resetrepo</span> /tmp/patchfile
-</code></pre></div>
-<p><code>--resetrepo</code> tells test patch that it can go into <strong>destructive</strong> mode. Destructive mode will wipe out any changes made to that repository, so use it with care!</p>
-
-<h1 id="enabling-features">Enabling Features</h1>
-
-<p>In general, almost all features are enabled via the plug-in framework. To see what has been enabled, use the <code>--list-plugins</code> option:</p>
-
-<div class="highlight"><pre class="highlight shell"><code><span class="nv">$ </span>test-patch <span class="nt">--list-plugins</span>
-</code></pre></div>
-<p>You should see output similar to this:</p>
-
-<div class="highlight"><pre class="highlight plaintext"><code>BUILDTOOLS:
- ant autoconf cmake gradle make maven nobuild
-TESTTYPES:
- asflicense author cc checkstyle dupname findbugs hadolint javac javadoc jshint mvnsite pathlen perlcritic pylint rubocop ruby_lint scalac scaladoc shellcheck shelldocs test4tests unitveto whitespace xml yamllint
-BUGSYSTEMS:
- briefreport bugzilla github gitlab htmlout jira
-TESTFORMATS:
- ctest junit tap
-</code></pre></div>
-<p>This output shows all of the plug-ins that are available as well as what type of plug-in they are.</p>
-
-<ul>
- <li>BUILDTOOLS - These drive the actual compiling of the source tree.</li>
- <li>TESTTYPES - Various kinds of tests that precommit can apply to the source, patches, and generated output (object files, etc).</li>
- <li>BUGSYSTEMS - Integration support for input of patches or output of reports.</li>
- <li>TESTFORMATS - Types of unit test output that precommit reads.</li>
-</ul>
-
-<p>From this list, the specific plug-ins can be enabled:</p>
-
-<div class="highlight"><pre class="highlight shell"><code><span class="nv">$ </span>test-patch <span class="nt">--plugins</span><span class="o">=</span><span class="s2">"ant,maven,shellcheck,xml"</span> <other options>
-</code></pre></div>
-<p>As a short-cut, every plug-in may be enabled via the special 'all' type:</p>
-
-<div class="highlight"><pre class="highlight shell"><code><span class="nv">$ </span>test-patch <span class="nt">--plugins</span><span class="o">=</span><span class="s2">"all"</span> <other options>
-</code></pre></div>
-<p><code>--plugins</code> also allows some basic "arithmetic":</p>
-
-<div class="highlight"><pre class="highlight shell"><code><span class="nv">$ </span>test-patch <span class="nt">--plugins</span><span class="o">=</span><span class="s2">"all,-checkstyle,-findbugs"</span> <other options>
-</code></pre></div>
-<p>This will enable all plug-ins for potential usage, except for checkstyle and findbugs.</p>
-
-<p><strong>NOTE: Many examples in this section will use <code>--plugins=all</code>. Users should set the <code>--plugins</code> option as appropriate.</strong></p>
-
-<p>This command will execute basic patch testing against a patch file stored in "filename":</p>
-
-<div class="highlight"><pre class="highlight shell"><code><span class="nv">$ </span><span class="nb">cd</span> <your repo>
-<span class="nv">$ </span>test-patch <span class="nt">--plugins</span><span class="o">=</span>all <span class="nt">--dirty-workspace</span> <span class="nt">--project</span><span class="o">=</span>projectname <filename>
-</code></pre></div>
-<p>The <code>--dirty-workspace</code> flag tells test-patch that the repository is not clean and it is ok to continue. By default, unit tests are not run since they may take a significant amount of time.</p>
-
-<p>To do turn them on, we need to provide the –run-tests option:</p>
-
-<div class="highlight"><pre class="highlight shell"><code><span class="nv">$ </span><span class="nb">cd</span> <your repo>
-<span class="nv">$ </span>test-patch <span class="nt">--plugins</span><span class="o">=</span>all <span class="nt">--dirty-workspace</span> <span class="nt">--run-tests</span> <filename>
-</code></pre></div>
-<p>This is the same command, but now runs the unit tests.</p>
-
-<h1 id="output-directory">Output Directory</h1>
-
-<p>After the tests have run, there is a directory that contains all of the <code>test-patch</code> related artifacts. This is generally referred to as the patch directory. By default, <code>test-patch</code> tries to make something off of <code>/tmp</code> 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 <a href="../precommit-robots">continuous integration system [...]
-
-<p>For example:</p>
-
-<div class="highlight"><pre class="highlight shell"><code><span class="nv">$ </span>test-patch <span class="nt">--plugins</span><span class="o">=</span>all <span class="nt">--patch-dir</span><span class="o">=</span><span class="k">${</span><span class="nv">WORKSPACE</span><span class="k">}</span>/patchdir <span class="nt">--basedir</span><span class="o">=</span><span class="k">${</span><span class="nv">WORKSPACE</span><span class="k">}</span>/source <span class="k">${</span><span class=" [...]
-</code></pre></div>
-<p>… will trigger <code>test-patch</code> to run in fully automated mode, using <code>${WORKSPACE}/patchdir</code> as its scratch space, <code>${WORKSPACE}/source</code> as the source repository, and <code>${WORKSPACE}/patchfile</code> as the name of the patch to test against. This will always run the unit tests, write answers back to bug systems, remove old, stopped/exited Docker containers after 24 hours and images after 1 week, forcibly use <code>--resetrepo</code>, and more.</p>
-
-<p><strong>NOTE: Make sure to add the patch directory to <code>.gitignore</code> if the directory is inside the source tree to avoid deleting it, as <code>test-patch</code> does a <code>git clean</code> to remove untracked files from previous runs.</strong></p>
-
-<h1 id="build-tool">Build Tool</h1>
-
-<p>Out of the box, <code>test-patch</code> will try to figure out which build tool the project uses. But what if you want to override it? The <code>--build-tool</code> option allows a manual setting:</p>
-
-<div class="highlight"><pre class="highlight shell"><code><span class="nv">$ </span>test-patch <span class="nt">--plugins</span><span class="o">=</span>all <span class="nt">--build-tool</span><span class="o">=</span>ant <span class="o">(</span>other options<span class="o">)</span>
-</code></pre></div>
-<p>will tell <code>test-patch</code> to use <code>ant</code> instead of maven to drive the project.</p>
-
-<p>To disable the build tool entirely, use the <code>nobuild</code> setting:</p>
-
-<div class="highlight"><pre class="highlight shell"><code><span class="nv">$ </span>test-patch <span class="nt">--plugins</span><span class="o">=</span>all <span class="nt">--build-tool</span><span class="o">=</span>nobuild <span class="o">(</span>other options<span class="o">)</span>
-</code></pre></div>
-<h1 id="providing-patch-files">Providing Patch Files</h1>
-
-<p>NOTE: More in-depth information may be found in the <a href="../precommit-bugsystems/">bugsystems</a> section.</p>
-
-<h2 id="jira">JIRA</h2>
-
-<p>It is a fairly common practice within the Apache community to use Apache's JIRA instance to store potential patches. As a result, <code>test-patch</code> supports providing just a JIRA issue number via the <code>jira</code> plug-in. <code>test-patch</code> will find the <em>last</em> attachment, download it, then process it.</p>
-
-<p><strong>NOTE: <code>test-patch</code> expects the patch files to follow a particular naming convention. For complete details<br />
- on the naming convention please refer to <a href="../precommit-patchnames/">patch-naming-conventions</a></strong></p>
-
-<p>For example:</p>
-
-<div class="highlight"><pre class="highlight shell"><code><span class="nv">$ </span>test-patch <span class="nt">--plugins</span><span class="o">=</span>all HADOOP-9905 <span class="o">(</span>other options<span class="o">)</span>
-</code></pre></div>
-<p>… will process the patch file associated with this JIRA issue.</p>
-
-<p>If the Apache JIRA system is not in use, then override options may be provided on the command line to point to a different JIRA instance.</p>
-
-<div class="highlight"><pre class="highlight shell"><code><span class="nv">$ </span>test-patch <span class="nt">--plugins</span><span class="o">=</span>all <span class="nt">--jira-issue-re</span><span class="o">=</span><span class="s1">'^PROJECT-[0-9]+$'</span> <span class="nt">--jira-base-url</span><span class="o">=</span><span class="s1">'https://example.com/jira'</span> PROJECT-90
-</code></pre></div>
-<p>… will process the patch file attached to PROJECT-90 on the JIRA instance located on the example.com server.</p>
-
-<h2 id="github">GITHUB</h2>
-
-<p><code>test-patch</code> has built-in support for Github via the <code>github</code> plug-in. <code>test-patch</code> supports many forms of providing pull requests to work on:</p>
-
-<div class="highlight"><pre class="highlight shell"><code><span class="nv">$ </span>test-patch <span class="nt">--plugins</span><span class="o">=</span>all <span class="nt">--github-repo</span><span class="o">=</span>apache/pig GH:99
-</code></pre></div>
-<p>or</p>
-
-<div class="highlight"><pre class="highlight shell"><code><span class="nv">$ </span>test-patch <span class="nt">--plugins</span><span class="o">=</span>all https://github.com/apache/pig/pulls/99
-</code></pre></div>
-<p>or</p>
-
-<div class="highlight"><pre class="highlight shell"><code><span class="nv">$ </span>test-patch <span class="nt">--plugins</span><span class="o">=</span>all https://github.com/apache/pig/pulls/99.patch
-</code></pre></div>
-<p>… will process PR #99 on the apache/pig repo.</p>
-
-<h2 id="gitlab">GITLAB</h2>
-
-<p><code>test-patch</code> has support for Gitlab via the <code>gitlab</code> plug-in. <code>test-patch</code> supports many forms of providing merge requests to work on:</p>
-
-<div class="highlight"><pre class="highlight shell"><code><span class="nv">$ </span>test-patch <span class="nt">--plugins</span><span class="o">=</span>all <span class="nt">--gitlab-repo</span><span class="o">=</span>_a__w_/yetus GL:1
-</code></pre></div>
-<p>or</p>
-
-<div class="highlight"><pre class="highlight shell"><code><span class="nv">$ </span>test-patch <span class="nt">--plugins</span><span class="o">=</span>all https://gitlab.com/_a__w_/yetus/merge_requests/3
-</code></pre></div>
-<p>or</p>
-
-<div class="highlight"><pre class="highlight shell"><code><span class="nv">$ </span>test-patch <span class="nt">--plugins</span><span class="o">=</span>all https://gitlab.com/_a__w_/yetus/merge_requests/3.patch
-</code></pre></div>
-<p>… will process MR #3 on the _a__w_/yetus repo.</p>
-
-<h2 id="generic-urls">Generic URLs</h2>
-
-<p>Luckily, <code>test-patch</code> supports ways to provide unified diffs via URLs.</p>
-
-<p>For example:</p>
-
-<div class="highlight"><pre class="highlight shell"><code><span class="nv">$ </span>test-patch <span class="nt">--plugins</span><span class="o">=</span>all https://example.com/webserver/file.patch
-</code></pre></div>
-<p>… will download and process the file.patch from the example.com webserver.</p>
-
-<h1 id="project-specific-capabilities">Project-specific Capabilities</h1>
-
-<p>Due to the extensible nature of the system, <code>test-patch</code> allows for projects to define project-specific rules which we call personalities. (How to build those rules is covered elsewhere.) There are two ways to specify which personality to use:</p>
-
-<h2 id="direct-method">Direct Method</h2>
-
-<div class="highlight"><pre class="highlight shell"><code><span class="nv">$ </span>test-patch <span class="nt">--plugins</span><span class="o">=</span>all <span class="nt">--personality</span><span class="o">=(</span>filename<span class="o">)</span>
-</code></pre></div>
-<p>This tells <code>test-patch</code> to use the personality in the given file.</p>
-
-<h2 id="project-method">Project Method</h2>
-
-<p>However, <code>test-patch</code> can detect if it is a personality that is in its "personality" directory based upon the project name:</p>
-
-<div class="highlight"><pre class="highlight shell"><code><span class="nv">$ </span>test-patch <span class="nt">--plugins</span><span class="o">=</span>all <span class="nt">--project</span><span class="o">=(</span>project<span class="o">)</span>
-</code></pre></div>
-<h1 id="fork-bomb-protection">Fork Bomb Protection</h1>
-
-<p>By default, <code>test-patch</code> will set the user soft limit (<code>ulimit -Su</code>) 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>
-
-<div class="highlight"><pre class="highlight shell"><code><span class="nv">$ </span>test-patch <span class="nt">--plugins</span><span class="o">=</span>all <span class="nt">--proclimit</span><span class="o">=</span>10000
-</code></pre></div>
-<p>… 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="multijdk">MultiJDK</h1>
-
-<p>For many projects, it is useful to test Java code against multiple versions of JDKs at the same time. In combination with the <code>java</code> plug-in, <code>test-patch</code> can do this with the <code>--multijdkdirs</code> option:</p>
-
-<div class="highlight"><pre class="highlight shell"><code><span class="nv">$ </span>test-patch <span class="nt">--plugins</span><span class="o">=</span>all <span class="nt">--multijdkdirs</span><span class="o">=</span><span class="s2">"/j/d/k/1,/j/d/k/2"</span>
-</code></pre></div>
-<p>Not all Java tests support this mode, but those that do will now run their tests with all of the given versions of Java consecutively (e.g., <code>javac</code>–the Java compliation test). Tests that do not support MultiJDK mode (e.g., checkstyle, mvn install) will use JAVA_HOME.</p>
-
-<p>NOTE: JAVA_HOME is always appended to the list of JDKs in MultiJDK mode. If JAVA_HOME is in the list, it will be moved to the end.</p>
-
-<h1 id="docker">Docker</h1>
-
-<p><code>test-patch</code> also has a built-in mode (i.e., no plug-in required) to utilize Docker:</p>
-
-<div class="highlight"><pre class="highlight diff"><code><span class="err">$</span> test-patch --docker
-</code></pre></div>
-<p>This command 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 specific <a href="../precommit-docker">precommit Docker support</a> page and the <a href="/yetus-docker-image">Apache Yetus Docker Hub Images</a> page for more information on the convenience Docker images.</p>
-
-<h1 id="in-closing">In Closing</h1>
-
-<p><code>test-patch</code> 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 <code>test-patch</code> without any options or with <code>--help</code>.</p>
-
- </div>
-
-<div class="container">
- <hr>
- <footer class="footer">
- <div class="row-fluid">
- <div class="span12 text-left">
- <div class="span12">
- Copyright 2008-2020 <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>
diff --git a/documentation/0.13.0-SNAPSHOT/precommit-bugsystems/index.html b/documentation/0.13.0-SNAPSHOT/precommit-bugsystems/index.html
deleted file mode 100644
index 2a9d46b..0000000
--- a/documentation/0.13.0-SNAPSHOT/precommit-bugsystems/index.html
+++ /dev/null
@@ -1,268 +0,0 @@
-<!---
- 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.10.0/">Docs for v0.10.0</a></li>
- <li><a href="/documentation/0.11.1/">Docs for v0.11.1</a></li>
- <li><a href="/documentation/0.12.0/">Docs for v0.12.0</a></li>
- <li><a href="/documentation/in-progress/">In Progress Docs for Contributors</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.
--->
-
-<h1 id="bug-system-support">Bug System Support</h1>
-
-<!-- MarkdownTOC levels="1,2" autolink="true" -->
-
-<ul>
- <li><a href="#bugzilla-specific">Bugzilla Specific</a></li>
- <li><a href="#github-specific">GitHub Specific</a></li>
- <li><a href="#gitlab-specific">GitLab Specific</a></li>
- <li><a href="#jira-specific">JIRA Specific</a></li>
-</ul>
-
-<!-- /MarkdownTOC -->
-
-<p>test-patch has the ability to support multiple bug systems. Bug tools have some extra hooks to fetch patches, line-level reporting, and posting a final report. Every bug system plug-in must have one line in order to be recognized:</p>
-
-<div class="highlight"><pre class="highlight shell"><code>add_bugsystem <pluginname>
-</code></pre></div>
-<ul>
- <li>pluginname_locate_patch
- <ul>
- <li>Given input from the user, download the patch if possible.</li>
- </ul>
- </li>
- <li>pluginname_determine_branch
- <ul>
- <li>Using any heuristics available, return the branch to process, if possible.</li>
- </ul>
- </li>
- <li>pluginname_determine_issue
- <ul>
- <li>Using any heuristics available, set the issue, bug number, etc, for this bug system, if possible. This is typically used to fill in supplementary information in the final output table.</li>
- </ul>
- </li>
- <li>pluginname_write_comment
- <ul>
- <li>Given text input, write this output to the bug system as a comment. NOTE: It is the bug system's responsibility to format appropriately.</li>
- </ul>
- </li>
- <li>pluginname_linecomments
- <ul>
- <li>This function allows for the system to write specific comments on specific lines if the bug system supports code review comments.</li>
- </ul>
- </li>
- <li>pluginname_finalreport
- <ul>
- <li>Write the final result table to the bug system.</li>
- </ul>
- </li>
-</ul>
-
-<h1 id="bugzilla-specific">Bugzilla Specific</h1>
-
-<p>Currently, Bugzilla support is read-only. To use it, the Bug ID must be preferenced with 'BZ:'. For example:</p>
-
-<div class="highlight"><pre class="highlight shell"><code><span class="nv">$ </span>test-patch <span class="o">(</span>other options<span class="o">)</span> BZ:4
-</code></pre></div>
-<p>… will pull down Bugzilla ID #4.</p>
-
-<p>Using the <code>--bugzilla-base-url</code> on the command line or BUGZILLA_BASE_URL in a project's personality will define the location of the Bugzilla instance. By default, it is <a href="https://bz.apache.org/bugzilla">https://bz.apache.org/bugzilla</a>.</p>
-
-<h1 id="github-specific">GitHub Specific</h1>
-
-<p>GitHub supports the full range of functionality, including putting comments on individual lines. Be aware, however, that <code>test-patch</code> will (generally) require that GitHub PRs be fully squashed and rebased (i.e., a single commit) in many circumstances.</p>
-
-<p>By default, the GitHub plug-in assumes that <a href="https://github.com">https://github.com</a> is the base URL for GitHub. Enterprise users may override this with the <code>--github-base-url</code> for the normal web user interface and <code>--github-api-url</code> for the API URL. Personalities may use GITHUB_API_URL and GITHUB_BASE_URL.</p>
-
-<p>The specific repository on GitHub is defined with either <code>--github-repo</code> on the command line or GITHUB_REPO in a personality. It should take the form of "user/repo".</p>
-
-<p>GitHub pull requests may be directly processed on the command line in two ways:</p>
-
-<ul>
- <li>GH:(PR number)</li>
- <li>GHSHA:(PR SHA1 number)</li>
-</ul>
-
-<p>The GitHub bugsystem plugin will attempt to download the unified diff that the pull request references.<br />
-Pull requests that are made off of a specific branch will switch the test repo to that branch, if permitted. If the pull request references a JIRA issue that matches the given JIRA issue regexp in the Subject, the JIRA plug-in will also be invoked as needed.</p>
-
-<h2 id="github-authentication">GitHub Authentication</h2>
-
-<p>In order to comment on issues or, depending upon the security setup of the repo, authentication credentials. The GitHub plug-in supports authentication via token or user name/passphrase.</p>
-
-<h3 id="github-token">GitHub Token</h3>
-
-<p>The token is provided via the <code>--github-token</code> option.</p>
-
-<h3 id="github-usernamepassword-deprecated">GitHub Username/password (Deprecated)</h3>
-
-<p>The user name is provided via the <code>--github-user</code> option or the GITHUB_USER environment variable. The default value for GITHUB_USER is the value of <code>--project</code> suffixed with QA. For example,<br />
-<code>--project=yetus</code> will set <code>GITHUB_USER=yetusqa</code>.</p>
-
-<p>The password is provided via the <code>--github-password</code> or GITHUB_PASSWD environment variable.</p>
-
-<p>Both username and password options must be provided.</p>
-
-<h1 id="gitlab-specific">GitLab Specific</h1>
-
-<p>GitLab supports the full range of functionality, including putting comments on individual lines. Be aware, however, that <code>test-patch</code> will (generally) require that GitLab MRs be fully squashed and rebased (i.e., a single commit) in many circumstances.</p>
-
-<p>By default, the GitLab plug-in assumes that <a href="https://gitlab.com">https://gitlab.com</a> is the base URL for GitLab. Enterprise users may override this with the <code>--gitlab-base-url</code> for the normal web user interface and <code>--gitlab-api-url</code> for the API URL. Personalities may use GITLAB_API_URL and GITLAB_BASE_URL.</p>
-
-<p>The specific repository on GitLab is defined with either <code>--gitlab-repo</code> on the command line or GITLAB_REPO in a personality. It should take the form of "user/repo".</p>
-
-<p>In order to comment on issues or, depending upon the security setup of the repo, authentication credentials. The GitLab plug-in supports tokens via the <code>--gitlab-token</code> option or GITLAB_TOKEN environment variable.</p>
-
-<p>GitLab merge requests may be directly processed on the command line in two ways:</p>
-
-<ul>
- <li>GL:(MR number)</li>
- <li>GLSHA:(MR SHA1 number)</li>
-</ul>
-
-<p>The GitLab bugsystem plugin will attempt to download the unified diff that the merge request references.<br />
-Merge requests that are made off of a specific branch will switch the test repo to that branch, if permitted. If the merge request references a JIRA issue that matches the given JIRA issue regexp in the Subject, the JIRA plug-in will also be invoked as needed.</p>
-
-<h1 id="jira-specific">JIRA Specific</h1>
-
-<p>JIRA support allows both patch downloads and summary writes. It also supports branch detection-based upon the name of the attached patch file.</p>
-
-<p>JIRA issues are invoked by matching the command line option to a specific regular expression as given by the <code>--jira-issue-re</code> option or via the JIRA_ISSUE_RE personality variable. By default, the plug-in uses <a href="https://issues.apache.org/jira">https://issues.apache.org/jira</a> as the JIRA instance to use. However that may be overwritten via the <code>--jira-base-url</code> option or personalities may define via JIRA_URL.</p>
-
-<p>In order to write information on the issue, JIRA requires username and password authentication using the <code>--jira-user</code>/<code>--jira-password</code> options or the JIRA_USER and JIRA_PASSWORD variables in a personality.</p>
-
-<p>The default value for JIRA_USER is the value of <code>--project</code> suffixed with QA. For example,<br />
-<code>--project=yetus</code> will set <code>JIRA_USER=yetusqa</code>.</p>
-
- </div>
-
-<div class="container">
- <hr>
- <footer class="footer">
- <div class="row-fluid">
- <div class="span12 text-left">
- <div class="span12">
- Copyright 2008-2020 <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>
diff --git a/documentation/0.13.0-SNAPSHOT/precommit-buildtools/index.html b/documentation/0.13.0-SNAPSHOT/precommit-buildtools/index.html
deleted file mode 100644
index 3c717d2..0000000
--- a/documentation/0.13.0-SNAPSHOT/precommit-buildtools/index.html
+++ /dev/null
@@ -1,338 +0,0 @@
-<!---
- 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.10.0/">Docs for v0.10.0</a></li>
- <li><a href="/documentation/0.11.1/">Docs for v0.11.1</a></li>
- <li><a href="/documentation/0.12.0/">Docs for v0.12.0</a></li>
- <li><a href="/documentation/in-progress/">In Progress Docs for Contributors</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.
--->
-
-<h1 id="build-tool-support">Build Tool Support</h1>
-
-<!-- MarkdownTOC levels="1,2" autolink="true" -->
-
-<ul>
- <li><a href="#global-variables">Global Variables</a>
- <ul>
- <li><a href="#buildtoolcwd">BUILDTOOLCWD</a></li>
- <li><a href="#unsupported_test">UNSUPPORTED_TEST</a></li>
- </ul>
- </li>
- <li><a href="#required-functions">Required Functions</a>
- <ul>
- <li><a href="#pluginname_buildfile">pluginname_buildfile</a></li>
- <li><a href="#pluginname_executor">pluginname_executor</a></li>
- <li><a href="#pluginnamemodulesworker">pluginname_modules_worker</a></li>
- <li><a href="#pluginnamebuiltin_personalitymodules">pluginname_builtin_personality_modules</a></li>
- <li><a href="#pluginnamebuiltin_personality_filetests">pluginname_builtin_personality_file_tests</a></li>
- </ul>
- </li>
- <li><a href="#optional-functions">Optional Functions</a>
- <ul>
- <li><a href="#pluginnameparseargs">pluginname_parse_args</a></li>
- <li><a href="#pluginname_initialize">pluginname_initialize</a></li>
- <li><a href="#pluginnamereordermodules">pluginname_reorder_modules</a></li>
- <li><a href="#pluginnametestlogfilter">pluginname_(test)_logfilter</a></li>
- <li><a href="#pluginnametestcalcdiffs">pluginname_(test)_calcdiffs</a></li>
- <li><a href="#pluginnamedockersupport">pluginname_docker_support</a></li>
- </ul>
- </li>
- <li><a href="#apache-ant-specific">Apache Ant Specific</a>
- <ul>
- <li><a href="#ant-command-arguments">Ant Command Arguments</a></li>
- <li><a href="#ant-in-docker-mode">Ant in Docker Mode</a></li>
- </ul>
- </li>
- <li><a href="#autoconf-specific">autoconf Specific</a>
- <ul>
- <li><a href="#autoconf-command-arguments">autoconf Command Arguments</a></li>
- </ul>
- </li>
- <li><a href="#cmake-specific">CMAKE Specific</a></li>
- <li><a href="#gradle-specific">Gradle Specific</a></li>
- <li><a href="#make-specific">Make Specific</a></li>
- <li><a href="#apache-maven-specific">Apache Maven Specific</a>
- <ul>
- <li><a href="#command-arguments">Command Arguments</a></li>
- <li><a href="#per-instance-repositories">Per-instance Repositories</a></li>
- <li><a href="#maven-in-docker-mode">Maven in Docker Mode</a></li>
- <li><a href="#test-profile">Test Profile</a></li>
- <li><a href="#custom-maven-tests">Custom Maven Tests</a></li>
- </ul>
- </li>
-</ul>
-
-<!-- /MarkdownTOC -->
-
-<p>test-patch has the ability to support multiple build tools. Build tool plug-ins have some extra hooks to do source and object maintenance at key points. Every build tool plug-in must have one line in order to be recognized:</p>
-
-<div class="highlight"><pre class="highlight shell"><code>add_build_tool <pluginname>
-</code></pre></div>
-<h1 id="global-variables">Global Variables</h1>
-
-<h2 id="buildtoolcwd">BUILDTOOLCWD</h2>
-
-<p>This variable determines where the build tool's command (as returned by pluginname_executor) should actually execute. It should be one of three values:</p>
-
-<ul>
- <li>basedir - always execute at the root of the source tree</li>
- <li>module - (default) switch to the directory as given by the module being processed</li>
- <li>/(path) - change to the directory as given by this absolute path. This allows for custom directories to be created and used as necessary. If the path does not exist, it will be created. If /(path) is used, two special substitutions may be made:
- <ul>
- <li>@@@BASEDIR@@@ will be replaced with the root of the source tree</li>
- <li>@@@MODULEDIR@@@ will be replaced with the module name</li>
- </ul>
- </li>
-</ul>
-
-<h2 id="unsupported_test">UNSUPPORTED_TEST</h2>
-
-<p>If pluginname_modules_worker is given a test type that is not supported by the build system, set UNSUPPORTED_TEST=true. If it is supported, set UNSUPPORTED_TEST=false.</p>
-
-<p>For example, the gradle build tool does not have a standard way to execute checkstyle. So when checkstyle is requested, gradle_modules_worker sets UNSUPPORTED_TEST to true and returns out of the routine.</p>
-
-<h1 id="required-functions">Required Functions</h1>
-
-<h2 id="pluginname_buildfile">pluginname_buildfile</h2>
-
-<p>This should be an echo of the file that controls the build system. This is used for module determination. If the build system wishes to disable module determination, it should echo with no args.</p>
-
-<h2 id="pluginname_executor">pluginname_executor</h2>
-
-<p>This should be an echo of how to run the build tool, any extra arguments, etc.</p>
-
-<h2 id="pluginname_modules_worker">pluginname_modules_worker</h2>
-
-<p>Input is the branch and the test being run. This should call <code>modules_workers</code> with the generic parts to run that test on the build system. For example, if it is convention to use 'test' to trigger 'unit' tests, then <code>modules_workers</code> should be called with 'test' appended onto its normal parameters.</p>
-
-<h2 id="pluginname_builtin_personality_modules">pluginname_builtin_personality_modules</h2>
-
-<p>Default method to determine how to enqueue modules for processing. Note that personalities may override this function. Requires two arguments: repo status and test desired. For example, in a maven build, values may be 'branch' and 'mvninstall'.</p>
-
-<h2 id="pluginname_builtin_personality_file_tests">pluginname_builtin_personality_file_tests</h2>
-
-<p>Default method to determine which tests to trigger. Note that personalities may override this function. Requires a single argument: the file in which the tests exist.</p>
-
-<h1 id="optional-functions">Optional Functions</h1>
-
-<h2 id="pluginname_parse_args">pluginname_parse_args</h2>
-
-<p>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.</p>
-
-<h2 id="pluginname_initialize">pluginname_initialize</h2>
-
-<p>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.</p>
-
-<h2 id="pluginname_reorder_modules">pluginname_reorder_modules</h2>
-
-<p>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.</p>
-
-<h2 id="pluginname_test_logfilter">pluginname_(test)_logfilter</h2>
-
-<p>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.</p>
-
-<h2 id="pluginname_test_calcdiffs">pluginname_(test)_calcdiffs</h2>
-
-<p>Some build tools (e.g., maven) use custom output for certain types of compilations (e.g., java). This allows for custom log file difference calculation used to determine the before and after views.</p>
-
-<h2 id="pluginname_docker_support">pluginname_docker_support</h2>
-
-<p>If this build tool requires extra settings on the <code>docker run</code> command line, this function should be defined and add those options into an array called <code>${DOCKER_EXTRAARGS[@]}</code>. This is particularly useful for things like mounting volumes for repository caches.</p>
-
-<div class="highlight"><pre class="highlight plaintext"><code>**WARNING**: Be aware that directories that do not exist MAY be created by root by Docker itself under certain conditions. It is HIGHLY recommend that `pluginname_initialize` be used to create the necessary directories prior to be used in the `docker run` command.
-</code></pre></div>
-<h1 id="apache-ant-specific">Apache Ant Specific</h1>
-
-<h2 id="ant-command-arguments">Ant Command Arguments</h2>
-
-<p>test-patch always passes -noinput to Ant. This forces ant to be non-interactive.</p>
-
-<h2 id="ant-in-docker-mode">Ant in Docker Mode</h2>
-
-<p>In Docker mode, the <code>${HOME}/.ivy2</code> directory is shared amongst all invocations.</p>
-
-<h1 id="autoconf-specific">autoconf Specific</h1>
-
-<p>autoconf requires make to be enabled. autoreconf is always used to rebuild the configure scripte.</p>
-
-<h2 id="autoconf-command-arguments">autoconf Command Arguments</h2>
-
-<p>autoconf will always run configure with prefix set to a directory in the patch processing directory. To configure other flags, set the AUTCONF_CONF_FLAGS environment variable.</p>
-
-<h1 id="cmake-specific">CMAKE Specific</h1>
-
-<p>By default, cmake will create a 'build' directory and perform all work there. This may be changed either on the command line or via a personality setting. cmake requires make to be enabled.</p>
-
-<h1 id="gradle-specific">Gradle Specific</h1>
-
-<p>The gradle plug-in always rebuilds the gradlew file and uses gradlew as the method to execute commands.</p>
-
-<p>In Docker mode, the <code>${HOME}/.gradle</code> directory is shared amongst all invocations.</p>
-
-<h1 id="make-specific">Make Specific</h1>
-
-<p>No notes.</p>
-
-<h1 id="apache-maven-specific">Apache Maven Specific</h1>
-
-<h2 id="command-arguments">Command Arguments</h2>
-
-<p>test-patch always passes –batch-mode to maven to force it into non-interactive mode. Additionally, some tests will also force -fae in order to get all of messages/errors during that mode. Some tests are executed with -DskipTests. Additional arguments should be handled via the personality.</p>
-
-<h2 id="per-instance-repositories">Per-instance Repositories</h2>
-
-<p>Under many common configurations, maven (as of 3.3.3 and lower) may not properly handle being executed by multiple processes simultaneously, especially given that some tests require the <code>mvn install</code> command to be used.</p>
-
-<p>To assist, <code>test-patch</code> supports a <code>--mvn-custom-repos</code> option to set the <code>-Dmaven.repo.local</code> value to a per-instance repository directory keyed to the project and branch being used for the test. If the <code>--jenkins</code> flag is also passed, the instance will be tied to the Jenkins <code>${EXECUTOR_NUMBER}</code> value. Otherwise, the instance value will be randomly generated via <code>${RANDOM}</code>. If the repository has not been used in 3 [...]
-
-<p>By default, <code>test-patch</code> uses <code>${HOME}/yetus-m2</code> as the base directory to store these custom maven repositories. That location may be changed via the <code>--mvn-custom-repos-dir</code> option.</p>
-
-<p>The location of the <code>settings.xml</code> may be changed via the <code>--mvn-settings</code> option.</p>
-
-<h2 id="maven-in-docker-mode">Maven in Docker Mode</h2>
-
-<p>In Docker mode, <code>${HOME}/.m2</code> is shared amongst all invocations. If <code>--mvn-custom-repos</code> is used, all of <code>--mvn-custom-repos-dir</code> is shared with all invocations. The per-instance directory will be calculated and configured after Docker has launched.</p>
-
-<h2 id="test-profile">Test Profile</h2>
-
-<p>By default, test-patch will pass -Ptest-patch to Maven. This will allow you to configure special actions that should only happen when running underneath test-patch.</p>
-
-<h2 id="custom-maven-tests">Custom Maven Tests</h2>
-
-<p>Maven will test eclipse and site if maven is being used as the build tool and appropriate files trigger them.</p>
-
-<p>Maven will trigger add a maven install test when the <code>maven_add_install</code> function has been used and the related tests are requierd. Plug-ins that need to run maven before MUST call it as part of their respective initialize functions, otherwise maven may fail unexpectedly. All Apache Yetus provided plug-ins that require maven will trigger the maven install functionality.</p>
-
- </div>
-
-<div class="container">
- <hr>
- <footer class="footer">
- <div class="row-fluid">
- <div class="span12 text-left">
- <div class="span12">
- Copyright 2008-2020 <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>
diff --git a/documentation/0.13.0-SNAPSHOT/precommit-docker-cleanup/index.html b/documentation/0.13.0-SNAPSHOT/precommit-docker-cleanup/index.html
deleted file mode 100644
index 566e8f4..0000000
--- a/documentation/0.13.0-SNAPSHOT/precommit-docker-cleanup/index.html
+++ /dev/null
@@ -1,185 +0,0 @@
-<!---
- 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.10.0/">Docs for v0.10.0</a></li>
- <li><a href="/documentation/0.11.1/">Docs for v0.11.1</a></li>
- <li><a href="/documentation/0.12.0/">Docs for v0.12.0</a></li>
- <li><a href="/documentation/in-progress/">In Progress Docs for Contributors</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.
--->
-
-<h1 id="docker-cleanup">docker-cleanup</h1>
-<!-- MarkdownTOC levels="1,2" autolink="true" -->
-
-<ul>
- <li><a href="#usage">Usage</a></li>
-</ul>
-
-<!-- /MarkdownTOC -->
-
-<p><code>docker-cleanup</code> is a command to perform precommit's Docker cleanup functionality outside of patch and build testing.</p>
-
-<h1 id="usage">Usage</h1>
-
-<p>Executing <code>docker-cleanup</code> will peform the same Docker image as the <code>--robot</code> option.</p>
-
-<div class="highlight"><pre class="highlight shell"><code><span class="nv">$ </span>docker-cleanup
-
-...
- Removing old images
-...
-Untagged: hadoop/createrelease:3.0.0-alpha3-SNAPSHOT_10600
-Deleted: sha256:1a96c79a0a9ab538c6c7765dc908eca3e689270b778d6ae2add558e89792a7d8
-...
- Docker Container Maintenance
-...
-
-</code></pre></div>
-<p><code>docker-cleanup</code> also supports the <code>--sentinel</code> mode to kill and remove stale running containers:</p>
-
-<div class="highlight"><pre class="highlight shell"><code><span class="nv">$ </span>docker-cleanup <span class="nt">--sentinel</span>
-
-...
- Removing old images
-...
-Untagged: hadoop/createrelease:3.0.0-alpha3-SNAPSHOT_10600
-Deleted: sha256:1a96c79a0a9ab538c6c7765dc908eca3e689270b778d6ae2add558e89792a7d8
-...
-
- Docker Container Maintenance
-...
-Attempting to remove docker container /big_kowalevski <span class="o">[</span>5ffd22a56ebcfe38d72b9078e0e7133ab6dc054115a4804e504c910bdbdeea45]
-...
-</code></pre></div>
- </div>
-
-<div class="container">
- <hr>
- <footer class="footer">
- <div class="row-fluid">
- <div class="span12 text-left">
- <div class="span12">
- Copyright 2008-2020 <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>
diff --git a/documentation/0.13.0-SNAPSHOT/precommit-docker/index.html b/documentation/0.13.0-SNAPSHOT/precommit-docker/index.html
deleted file mode 100644
index 0003dca..0000000
--- a/documentation/0.13.0-SNAPSHOT/precommit-docker/index.html
+++ /dev/null
@@ -1,214 +0,0 @@
-<!---
- 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.10.0/">Docs for v0.10.0</a></li>
- <li><a href="/documentation/0.11.1/">Docs for v0.11.1</a></li>
- <li><a href="/documentation/0.12.0/">Docs for v0.12.0</a></li>
- <li><a href="/documentation/in-progress/">In Progress Docs for Contributors</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.
--->
-
-<h1 id="test-patch-docker-support">test-patch Docker Support</h1>
-
-<!-- MarkdownTOC levels="1,2" autolink="true" -->
-
-<ul>
- <li><a href="#the-basics">The Basics</a></li>
- <li><a href="#docker-base-images">Docker Base Images</a>
- <ul>
- <li><a href="#default-image">Default Image</a></li>
- <li><a href="#using-a-dockerfile">Using a Dockerfile</a></li>
- <li><a href="#pulling-a-docker-tag">Pulling a Docker tag</a></li>
- <li><a href="#using-a-cache">Using a cache</a></li>
- <li><a href="#platforms">Platforms</a></li>
- </ul>
- </li>
- <li><a href="#resource-controls">Resource Controls</a></li>
- <li><a href="#privileged-mode">Privileged Mode</a></li>
- <li><a href="#docker-in-docker">Docker in Docker</a></li>
-</ul>
-
-<!-- /MarkdownTOC -->
-
-<h1 id="the-basics">The Basics</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 Linux container by using the <code>--docker</code> parameter. 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 CI instance.</p>
-
-<p>Each run will spawn two Docker images, one that contains some sort of base image and one specific to each run. The base image is described further in this text. The run-specific image is a small one that passes parameters and settings that are dedicated to that run, with "tp-" as part of the Docker image tag. It should be removed automatically after the run upon test-patch completion.</p>
-
-<h1 id="docker-base-images">Docker Base Images</h1>
-
-<h2 id="default-image">Default Image</h2>
-
-<p>By default, test-patch will try to pull apache/yetus:VERSION from the default repository, where VERSION matches the version of Apache Yetus being utilized. If that fails, it will then build an image based upon the built-in Dockerfile. Both images contain all of the basic requirements for all of the plug-ins that test-patch supports. As a result, it is a fairly hefty image! It may take several minutes to either download or build, dependent upon processor, network speed, etc.</p>
-
-<h2 id="using-a-dockerfile">Using a Dockerfile</h2>
-
-<p>The <code>--dockerfile</code> parameter allows one to provide a custom Dockerfile instead. The Dockerfile should contain all of the necessary binaries and tooling needed to build and test. test-patch will process this file up until the text "YETUS CUT HERE". Be aware that will always fail the build if the Dockerfile itself fails the build. This makes it ideal to use to test any tools Dockerfile that is also used for development.</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 <code>--robot</code> 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>--do [...]
-
-<h3 id="copy-and-add-in-dockerfiles">COPY and ADD in Dockerfiles</h3>
-
-<p>In order to use both 'YETUS CUT HERE' and a Dockerfile that uses COPY and ADD directives, the Docker API must be version 18 or higher. If the API version is 17 or lower, the Dockerfile will be copied to a temporary directory to be processed, thus removing the Docker build context in the process.</p>
-
-<h2 id="pulling-a-docker-tag">Pulling a Docker tag</h2>
-
-<p>Instead of processing a Dockerfile, test-patch can pull a tag from a repository using the <code>--docker-tag</code> parameter. Note that the repository must already be logged into and configured prior to executing test-patch.</p>
-
-<h2 id="using-a-cache">Using a cache</h2>
-
-<p>With the <code>--docker-cache-from</code> parameter, other images may be utilized to provide a cache when building a Dockerfile. This comma delimited list will automatically be pulled (errors are ignored) and given to the docker command line to use.</p>
-
-<h2 id="platforms">Platforms</h2>
-
-<p>When either building or pull an image, test-patch supports the <code>--docker-platform</code> flag to pass in the Docker <code>--platform</code> flag. This allows you full control over what kind of image the software either creates or fetches.</p>
-
-<h1 id="resource-controls">Resource Controls</h1>
-
-<p>Docker's <code>--memory</code> flag is supported via the <code>--dockermemlimit</code> option. This enables the container's memory size to be limited. This may be important to set to prevent things like broken unit tests bringing down the entire build server. See <a href="https://docs.docker.com/engine/admin/resource_constraints/">the Docker documentation</a> for more details. Apache Yetus also sets the <code>--oom-score-adj</code> to 500 in order to offer itself as the first proce [...]
-
-<p>Additionally, if bash v4 and Linux is in use, a separate process is launched to keep a rolling count of the maximum number of threads (not processes!) in use at one time. This number will be reported at the end of the test-patch run. Depending upon the build, languages, features enabled, etc, this number may be helpful in determining what the value of <code>--proclimit</code></p>
-
-<h1 id="privileged-mode">Privileged Mode</h1>
-
-<p>In some cases, the work being preformed inside the Docker container requires extra permissions. Using the <code>--docker-privd</code> option enables Docker's extended privileges to the container.</p>
-
-<h1 id="docker-in-docker">Docker in Docker</h1>
-
-<p>With the usage of the <code>--dockerind</code> flag, test-patch will mount the <code>/var/run/docker.sock</code> UNIX socket into the container to enable Docker-in-Docker mode. Additionally, the <code>--docker-socket</code> option will let one set the socket to mount in situations where that isn't the location of the socket, such as a dockerd proxy providing authentication.</p>
-
-<div class="highlight"><pre class="highlight plaintext"><code>NOTE: Using --dockerind requires the availability of the `stat` command that supports either -c '%g' (GNU form) or -f '%g' (BSD form).
-</code></pre></div>
- </div>
-
-<div class="container">
- <hr>
- <footer class="footer">
- <div class="row-fluid">
- <div class="span12 text-left">
- <div class="span12">
- Copyright 2008-2020 <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>
diff --git a/documentation/0.13.0-SNAPSHOT/precommit-glossary/index.html b/documentation/0.13.0-SNAPSHOT/precommit-glossary/index.html
deleted file mode 100644
index 242b9a7..0000000
--- a/documentation/0.13.0-SNAPSHOT/precommit-glossary/index.html
+++ /dev/null
@@ -1,176 +0,0 @@
-<!---
- 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.10.0/">Docs for v0.10.0</a></li>
- <li><a href="/documentation/0.11.1/">Docs for v0.11.1</a></li>
- <li><a href="/documentation/0.12.0/">Docs for v0.12.0</a></li>
- <li><a href="/documentation/in-progress/">In Progress Docs for Contributors</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.
--->
-
-<h1 id="glossary">Glossary</h1>
-
-<h2 id="genericoutside-definitions">Generic/outside definitions</h2>
-
-<p>Apache's <a href="https://community.apache.org/contributors/">new contributor documentation</a> and Maven's <a href="https://maven.apache.org/glossary.html">glossary</a> are great places to start if you are new to Apache or Maven.</p>
-
-<ul>
- <li>
- <p>Module</p>
-
- <p>Almost the same meaning as "sub-project" on Maven.</p>
- </li>
-</ul>
-
-<h2 id="test-patch-specific">test-patch specific</h2>
-
-<ul>
- <li>
- <p>Personality</p>
-
- <p>A chunk of shell code that tells test-patch this particular project's needs and special requirements</p>
- </li>
- <li>
- <p>Plug-ins</p>
-
- <p>Shell code snippets that define new, not built-in test types.</p>
- </li>
- <li>
- <p>Precommit</p>
-
- <p>An automated process that verifies a patch is "good" prior to a committer looking at it.</p>
- </li>
-</ul>
-
- </div>
-
-<div class="container">
- <hr>
- <footer class="footer">
- <div class="row-fluid">
- <div class="span12 text-left">
- <div class="span12">
- Copyright 2008-2020 <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>
diff --git a/documentation/0.13.0-SNAPSHOT/precommit-patchnames/index.html b/documentation/0.13.0-SNAPSHOT/precommit-patchnames/index.html
deleted file mode 100644
index f5195a9..0000000
--- a/documentation/0.13.0-SNAPSHOT/precommit-patchnames/index.html
+++ /dev/null
@@ -1,181 +0,0 @@
-<!---
- 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.10.0/">Docs for v0.10.0</a></li>
- <li><a href="/documentation/0.11.1/">Docs for v0.11.1</a></li>
- <li><a href="/documentation/0.12.0/">Docs for v0.12.0</a></li>
- <li><a href="/documentation/in-progress/">In Progress Docs for Contributors</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.
--->
-
-<h1 id="patch-file-naming">Patch File Naming</h1>
-
-<!-- MarkdownTOC levels="1,2" autolink="true" -->
-
-<ul>
- <li><a href="#jira">JIRA</a></li>
- <li><a href="#github">Github</a></li>
-</ul>
-
-<!-- /MarkdownTOC -->
-
-<p>We use Apache Yetus to process your patch. It supports the following patterns and procedures for patch file names:</p>
-
-<h2 id="jira">JIRA</h2>
-
-<p>If JIRA support is configured, attach the patch to the given ISSUE and<br />
-click 'Submit Patch'. The patch file should be named one of:</p>
-
-<ul>
- <li>ISSUE.patch</li>
- <li>ISSUE.###.patch</li>
- <li>ISSUE.branch.###.patch</li>
- <li>ISSUE-branch-###.patch</li>
- <li>ISSUE.###.branch.patch</li>
- <li>ISSUE-branch.###.patch</li>
-</ul>
-
-<p>The meaning of the subpart are the following:</p>
-
-<ul>
- <li>ISSUE: JIRA key (e.g. YETUS-1)</li>
- <li>branch: either the name of a branch or a git hash prefixed with <strong>git</strong> (e.g. branch-2.8 or git8e55427b35)</li>
- <li>###: revision of the patch (e.g. 00 or 01)</li>
-</ul>
-
-<h2 id="github">Github</h2>
-
-<p>If Github support is also configured, a comment that contains a link to a Pull Request's patch file (e.g., <a href="https://github.com/user/repo/pull/1.patch">https://github.com/user/repo/pull/1.patch</a>) will pull the patch from the given Github PR.</p>
-
- </div>
-
-<div class="container">
- <hr>
- <footer class="footer">
- <div class="row-fluid">
- <div class="span12 text-left">
- <div class="span12">
- Copyright 2008-2020 <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>
diff --git a/documentation/0.13.0-SNAPSHOT/precommit-qbt/index.html b/documentation/0.13.0-SNAPSHOT/precommit-qbt/index.html
deleted file mode 100644
index 5ebe616..0000000
--- a/documentation/0.13.0-SNAPSHOT/precommit-qbt/index.html
+++ /dev/null
@@ -1,207 +0,0 @@
-<!---
- 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.10.0/">Docs for v0.10.0</a></li>
- <li><a href="/documentation/0.11.1/">Docs for v0.11.1</a></li>
- <li><a href="/documentation/0.12.0/">Docs for v0.12.0</a></li>
- <li><a href="/documentation/in-progress/">In Progress Docs for Contributors</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>
... 4643 lines suppressed ...