Repository: yetus Updated Branches: refs/heads/asf-site e3c707570 -> 3c27a5590
http://git-wip-us.apache.org/repos/asf/yetus/blob/7e0fd8e4/documentation/0.6.0/precommit-qbt/index.html ---------------------------------------------------------------------- diff --git a/documentation/0.6.0/precommit-qbt/index.html b/documentation/0.6.0/precommit-qbt/index.html new file mode 100644 index 0000000..cf97b3d --- /dev/null +++ b/documentation/0.6.0/precommit-qbt/index.html @@ -0,0 +1,199 @@ +<!--- + 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.4.0/">Docs for v0.4.0</a></li> + <li><a href="/documentation/0.5.0/">Docs for v0.5.0</a></li> + <li><a href="/documentation/0.6.0/">Docs for v0.6.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="http://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://git-wip-us.apache.org/repos/asf?s=yetus";><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="http://www.apache.org";>Apache Homepage</a> + </li> + <li><a href="http://www.apache.org/licenses/";>Apache License</a> + </li> + <li><a href="http://www.apache.org/foundation/sponsorship.html";>Sponsorship</a> + </li> + <li><a href="http://www.apache.org/foundation/thanks.html";>Thanks</a> + </li> + <li><a href="http://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="qbt">qbt</h1> + +<p><code>qbt</code> is a command to execute test-patch without a patch. It uses +the same plug-ins and the same options as test-patch. The only +difference is that no patch file, location, etc should be supplied. +It is meant to be a way to easily get test-patch’s output on your +current source tree. It is suitable to be run as a regularly +scheduled build as part of your overall development strategy.</p> + +<h1 id="reporting">Reporting</h1> + +<p>When using an automation tool, it may be useful to use the +<code>--console-report-file</code> option to send the summary email to a +file. This can then be used with systems like Jenkin’s +email-ext plug-in to send the output as an emailed report:</p> +<pre class="highlight plaintext"><code>${FILE,path="<report-file-path>"} +</code></pre> +<p>For something a bit more structured, there is also the <code>--html-report-file</code> +option. Using this output, again with Jenkins’ email-ext plug-in, it is +possible to build some very nice looking output that is easily customized:</p> +<pre class="highlight html"><code><span class="nt"><html></span> +<span class="nt"><head></span> +<span class="nt"><style></span> +<span class="nt">table</span> <span class="p">{</span> + <span class="nl">border-collapse</span><span class="p">:</span> <span class="nb">collapse</span><span class="p">;</span> +<span class="p">}</span> +<span class="nt">table</span><span class="o">,</span> <span class="nt">th</span><span class="o">,</span> <span class="nt">td</span> <span class="p">{</span> + <span class="nl">border</span><span class="p">:</span> <span class="m">1px</span> <span class="nb">solid</span> <span class="no">black</span><span class="p">;</span> +<span class="p">}</span> +<span class="nt">tr</span><span class="nd">:nth-child</span><span class="o">(</span><span class="nt">even</span><span class="o">)</span><span class="p">{</span><span class="nl">background-color</span><span class="p">:</span> <span class="m">#f2f2f2</span><span class="p">}</span> +<span class="nt"></style></span> +<span class="nt"></head></span> +<span class="nt"><body></span> +<span class="nt"><p></span>See the <span class="nt"><a</span> <span class="na">href=</span><span class="s">"${BUILD_URL}"</span><span class="nt">></span>Jenkins Build<span class="nt"></a></span> for more information.<span class="nt"></p></span> +<span class="nt"><p></span>${CHANGES, format="<span class="nt"><div></span>[%d] (%a) %m<span class="nt"></div></span>"}<span class="nt"></p></span> +<span class="nt"><p></p></span> +${FILE,path="<span class="nt"><report-file-path></span>"} +<span class="nt"></body></html></span> +</code></pre> +<p>If your mailing lists do not allow HTML-formatted email, then the <code>--brief-report-file</code> +provides a solution. This option creates a very plain, reduced content text file +suitable for email. It contains just the barebones information needed to get +information on failures: what voted -1, what tests failed, what subsystems are long +running (configurable with the <code>--brief-report-long</code> opton), and a list of any +attached log files.</p> + +<p>NOTE: Be aware that ASF mailing lists do not allow HTML formatted email.</p> + +<h1 id="archiving">Archiving</h1> + +<p>It may be useful to save off certain files while qbt is running for more +post-processing by another utility. If the <code>rsync</code> command is available, +then the archiving functionality may be used.</p> + +<p>The <code>--archive-list</code> option takes a comma separated list of <code>find -name</code> +patterns and copies them to the patch directory’s archiver subdirectory. +It will preserve the directory structure of the source tree so that +multiple matching file names will be preserved.</p> + + </div> + <div class="container"> + <hr> + <footer class="footer"> + <div class="row-fluid"> + <div class="span12 text-left"> + <div class="span12"> + Copyright 2008-2017 <a href="http://www.apache.org/";>Apache Software Foundation</a>. Licensed under the <a href="http://www.apache.org/licenses/";>Apache License v2.0</a>. Apache Yetus and the Apache feather logo are trademarks of The Apache Software Foundation. + </div> + </div> + + </div> + + </footer> +</div> + + </body> +</html> http://git-wip-us.apache.org/repos/asf/yetus/blob/7e0fd8e4/documentation/0.6.0/precommit-smart-apply-patch/index.html ---------------------------------------------------------------------- diff --git a/documentation/0.6.0/precommit-smart-apply-patch/index.html b/documentation/0.6.0/precommit-smart-apply-patch/index.html new file mode 100644 index 0000000..6ccc27f --- /dev/null +++ b/documentation/0.6.0/precommit-smart-apply-patch/index.html @@ -0,0 +1,165 @@ +<!--- + 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.4.0/">Docs for v0.4.0</a></li> + <li><a href="/documentation/0.5.0/">Docs for v0.5.0</a></li> + <li><a href="/documentation/0.6.0/">Docs for v0.6.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="http://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://git-wip-us.apache.org/repos/asf?s=yetus";><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="http://www.apache.org";>Apache Homepage</a> + </li> + <li><a href="http://www.apache.org/licenses/";>Apache License</a> + </li> + <li><a href="http://www.apache.org/foundation/sponsorship.html";>Sponsorship</a> + </li> + <li><a href="http://www.apache.org/foundation/thanks.html";>Thanks</a> + </li> + <li><a href="http://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="smart-apply-patch">smart-apply-patch</h1> + +<p><code>smart-apply-patch</code> is a command to help apply patches easily. It uses the same plug-ins and many of the same options as test-patch. This means that it can, for example, fetch patches from JIRA and apply them to a local source tree.</p> + +<h1 id="usage">Usage</h1> + +<p>Its simplest form is used when a patch is stored in a local file:</p> +<pre class="highlight shell"><code><span class="gp">$ </span>smart-apply-patch patch +</code></pre> +<p>This will cause the command to run through various ways to verify and then apply the patch to the current repo, including deducing a patch level.</p> + +<p>Perhaps you just want to see if the patch even applies without changing your local repo. The <code>--dry-run</code> option will just test for applicability:</p> +<pre class="highlight shell"><code><span class="gp">$ </span>smart-apply-patch --dry-run patch +</code></pre> +<p>For committers of projects, there is a special mode:</p> +<pre class="highlight shell"><code><span class="gp">$ </span>smart-apply-patch --committer patch +</code></pre> +<p>that in addition to applying the patch will also attempt to:</p> + +<ul> +<li>use <code>--whitespace=fix</code> mode</li> +<li>add all newly created files in the repo</li> +<li>use <code>--signoff</code> and commit the change via git-am</li> +</ul> + + </div> + <div class="container"> + <hr> + <footer class="footer"> + <div class="row-fluid"> + <div class="span12 text-left"> + <div class="span12"> + Copyright 2008-2017 <a href="http://www.apache.org/";>Apache Software Foundation</a>. Licensed under the <a href="http://www.apache.org/licenses/";>Apache License v2.0</a>. Apache Yetus and the Apache feather logo are trademarks of The Apache Software Foundation. + </div> + </div> + + </div> + + </footer> +</div> + + </body> +</html> http://git-wip-us.apache.org/repos/asf/yetus/blob/7e0fd8e4/documentation/0.6.0/precommit-testformats/index.html ---------------------------------------------------------------------- diff --git a/documentation/0.6.0/precommit-testformats/index.html b/documentation/0.6.0/precommit-testformats/index.html new file mode 100644 index 0000000..7c83c51 --- /dev/null +++ b/documentation/0.6.0/precommit-testformats/index.html @@ -0,0 +1,162 @@ +<!--- + 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.4.0/">Docs for v0.4.0</a></li> + <li><a href="/documentation/0.5.0/">Docs for v0.5.0</a></li> + <li><a href="/documentation/0.6.0/">Docs for v0.6.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="http://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://git-wip-us.apache.org/repos/asf?s=yetus";><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="http://www.apache.org";>Apache Homepage</a> + </li> + <li><a href="http://www.apache.org/licenses/";>Apache License</a> + </li> + <li><a href="http://www.apache.org/foundation/sponsorship.html";>Sponsorship</a> + </li> + <li><a href="http://www.apache.org/foundation/thanks.html";>Thanks</a> + </li> + <li><a href="http://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-format-support">Test Format Support</h1> + +<p>test-patch has the ability to support multiple test formats. Test formats have some extra hooks to process the output of test tools and write the results to some tables. Every test format plug-in must have one line in order to be recognized:</p> +<pre class="highlight shell"><code>add_test_format <pluginname> +</code></pre> +<p>Test format plugins can provide following two methods, which will be called by test-patch if defined.</p> + +<ul> +<li><p>pluginname_process_tests</p> + +<ul> +<li>Given a path to the log file and tested module name, parse that file and store the test result into global variables and/or files.</li> +</ul></li> +<li><p>pluginname_finalize_results</p> + +<ul> +<li>Using the results stored by pluginname_process_tests, write them to the test result table and/or the footer table for reporting.</li> +</ul></li> +</ul> + +<p>For an example of how to write a test-format plugin, you can look at <a href="https://github.com/apache/yetus/blob/master/precommit/test-patch.d/junit.sh";>junit plugin</a> bundled in Apache Yetus.</p> + + </div> + <div class="container"> + <hr> + <footer class="footer"> + <div class="row-fluid"> + <div class="span12 text-left"> + <div class="span12"> + Copyright 2008-2017 <a href="http://www.apache.org/";>Apache Software Foundation</a>. Licensed under the <a href="http://www.apache.org/licenses/";>Apache License v2.0</a>. Apache Yetus and the Apache feather logo are trademarks of The Apache Software Foundation. + </div> + </div> + + </div> + + </footer> +</div> + + </body> +</html> http://git-wip-us.apache.org/repos/asf/yetus/blob/7e0fd8e4/documentation/0.6.0/releasedocmaker/index.html ---------------------------------------------------------------------- diff --git a/documentation/0.6.0/releasedocmaker/index.html b/documentation/0.6.0/releasedocmaker/index.html new file mode 100644 index 0000000..793d0a2 --- /dev/null +++ b/documentation/0.6.0/releasedocmaker/index.html @@ -0,0 +1,294 @@ +<!--- + 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.4.0/">Docs for v0.4.0</a></li> + <li><a href="/documentation/0.5.0/">Docs for v0.5.0</a></li> + <li><a href="/documentation/0.6.0/">Docs for v0.6.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="http://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://git-wip-us.apache.org/repos/asf?s=yetus";><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="http://www.apache.org";>Apache Homepage</a> + </li> + <li><a href="http://www.apache.org/licenses/";>Apache License</a> + </li> + <li><a href="http://www.apache.org/foundation/sponsorship.html";>Sponsorship</a> + </li> + <li><a href="http://www.apache.org/foundation/thanks.html";>Thanks</a> + </li> + <li><a href="http://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="releasedocmaker">releasedocmaker</h1> + +<ul> +<li><a href="#purpose">Purpose</a></li> +<li><a href="#requirements">Requirements</a></li> +<li><a href="#basic-usage">Basic Usage</a></li> +<li><a href="#changing-the-header">Changing the Header</a></li> +<li><a href="#multiple-versions">Multiple Versions</a></li> +<li><a href="#unreleased-dates">Unreleased Dates</a></li> +<li><a href="#sorted-output">Sorted Output</a></li> +<li><a href="#backward-incompatible-changes">Backward Incompatible Changes</a></li> +<li><a href="#lint-mode">Lint Mode</a></li> +<li><a href="#index-mode">Index Mode</a></li> +<li><a href="#release-version">Release Version</a></li> +</ul> + +<h1 id="purpose">Purpose</h1> + +<p>Building changelog information in a form that is human digestible but still containing as much useful information is difficult. Many attempts over the years have resulted in a variety of methods that projects use to solve this problem:</p> + +<ul> +<li>JIRA-generated release notes from the <q>Release Notes</q> button</li> +<li>Manually modified CHANGES file</li> +<li>Processing git log information</li> +</ul> + +<p>All of these methods have their pros and cons. Some have issues with accuracy. Some have issues with lack of details. None of these methods seem to cover all of the needs of many projects and are full of potential pitfalls.</p> + +<p>In order to solve these problems, releasedocmaker was written to automatically generate a changelog and release notes by querying Apache’s JIRA instance.</p> + +<h1 id="requirements">Requirements</h1> + +<ul> +<li>Python 2.6 with dateutil extension</li> +</ul> + +<p>dateutil may be installed via pip: <code>pip install python-dateutil</code></p> + +<h1 id="basic-usage">Basic Usage</h1> + +<p>Minimally, the name of the JIRA project and a version registered in JIRA must be provided:</p> +<pre class="highlight shell"><code><span class="gp">$ </span>releasedocmaker.py --project <span class="o">(</span>project<span class="o">)</span> --version <span class="o">(</span>version<span class="o">)</span> +</code></pre> +<p>This will query Apache JIRA, generating two files in a directory named after the given version in an extended markdown format which can be processed by both mvn site and GitHub.</p> + +<ul> +<li>CHANGES.(version).md</li> +</ul> + +<p>This is similar to the JIRA <q>Release Notes</q> button but is in tabular format and includes the priority, component, reporter, and contributor fields. It also highlights Incompatible Changes so that readers know what to look out for when upgrading. The top of the file also includes the date that the version was marked as released in JIRA.</p> + +<ul> +<li>RELEASENOTES.(version).md</li> +</ul> + +<p>If your JIRA project supports the release note field, this will contain any JIRA mentioned in the CHANGES log that is either an incompatible change or has a release note associated with it. If your JIRA project does not support the release notes field, this will be the description field.</p> + +<p>For example, to build the release documentation for HBase v1.2.0…</p> +<pre class="highlight shell"><code><span class="gp">$ </span>releasedocmaker.py --project HBASE --version 1.2.0 +</code></pre> +<p>… will create a 1.2.0 directory and inside that directory will be CHANGES.1.2.0.md and RELEASENOTES.1.2.0.md .</p> + +<p>By default, release notes are expected to be in plain text. However, you can write them in markdown if you include a header at the top of your release note:</p> +<pre class="highlight xml"><code><span class="c"><!-- markdown --></span> +remaining text +</code></pre> +<h1 id="changing-the-header">Changing the Header</h1> + +<p>By default, it will use a header that matches the project name. But that is kind of ugly and the case may be wrong. Luckily, the title can be changed:</p> +<pre class="highlight shell"><code><span class="gp">$ </span>releasedocmaker.py --project HBASE --version 1.2.0 --projecttitle <span class="s2">"Apache HBase"</span> +</code></pre> +<p>Now instead of <q>HBASE</q>, it will use <q>Apache HBASE</q> for some titles and headers.</p> + +<h1 id="multiple-versions">Multiple Versions</h1> + +<p>The script can also generate multiple versions at once, by</p> +<pre class="highlight shell"><code><span class="gp">$ </span>releasedocmaker.py --project HBASE --version 1.0.0 --version 1.2.0 +</code></pre> +<p>This will create the files for versions 1.0.0 and versions 1.2.0 in their own directories.</p> + +<p>But what if the version numbers are not known? releasedocmaker can also generate version data based upon ranges:</p> +<pre class="highlight shell"><code><span class="gp">$ </span>releasedocmaker.py --project HBASE --version 1.0.0 --version 1.2.0 --range +</code></pre> +<p>In this form, releasedocmaker will query JIRA, discover all versions that alphabetically appear to be between 1.0.0 and 1.2.0, inclusive, and generate all of the relative release documents. This is especially useful when bootstrapping an existing project.</p> + +<h1 id="unreleased-dates">Unreleased Dates</h1> + +<p>For released versions, releasedocmaker will pull the date of the release from JIRA. However, for unreleased versions it marks the release as <q>Unreleased</q>. This can be inconvenient when actually building a release and wanting to include it inside the source package.</p> + +<p>The –usetoday option can be used to signify that instead of using Unreleased, releasedocmaker should use today’s date.</p> +<pre class="highlight shell"><code><span class="gp">$ </span>releasedocmaker.py --project HBASE --version 1.0.0 --usetoday +</code></pre> +<p>After using this option and release, don’t forget to change JIRA’s release date to match!</p> + +<h1 id="sorted-output">Sorted Output</h1> + +<p>Different projects may find one type of sort better than another, depending upon their needs. releasedocmaker supports two types of sorts and each provides two different options in the direction for that sort.</p> + +<h2 id="resolution-date-base-sort">Resolution Date-base Sort</h2> + +<p>By default, releasedocmaker will sort the output based upon the resolution date of the issue starting with older resolutions. This is the same as giving these options:</p> +<pre class="highlight shell"><code><span class="gp">$ </span>releasedocmaker.py --project falcon --version 0.6 --sorttype resolutiondate --sortorder older +</code></pre> +<p>The order can be reversed so that newer issues appear on top by providing the ‘newer’ flag:</p> +<pre class="highlight shell"><code><span class="gp">$ </span>releasedocmaker.py --project falcon --version 0.6 --sorttype resolutiondate --sortorder newer +</code></pre> +<p>In the case of multiple projects given on the command line, the projects will be interspersed.</p> + +<h2 id="issue-number-based-sort">Issue Number-based Sort</h2> + +<p>An alternative to the date-based sort is to sort based upon the issue id. This may be accomplished via:</p> +<pre class="highlight shell"><code><span class="gp">$ </span>releasedocmaker.py --project falcon --version 0.6 --sorttype issueid --sortorder asc +</code></pre> +<p>This will now sort by the issue id, listing them in lowest to highest (or ascending) order.</p> + +<p>The order may be reversed to list them in highest to lowest (or descending) order by providing the appropriate flag:</p> +<pre class="highlight shell"><code><span class="gp">$ </span>releasedocmaker.py --project falcon --version 0.6 --sorttype issueid --sortorder desc +</code></pre> +<p>In the case of multiple projects given on the command line, the projects will be grouped and then sorted by issue id.</p> + +<h1 id="backward-incompatible-changes">Backward Incompatible Changes</h1> + +<p>To check if an issue is backward-incompatible the releasedocmaker script first checks the <q>Hadoop Flags</q> field in the +issue. If this field is found to be blank then it searches for the ‘backward-incompatible’ label. You can override the +default value for this label by using –incompatiblelabel option e.g.</p> +<pre class="highlight shell"><code><span class="gp">$ </span>releasedocmaker.py --project falcon --version 0.6 --incompatiblelabel not-compatible +</code></pre> +<p>or equivalently using the shorter -X option</p> +<pre class="highlight shell"><code><span class="gp">$ </span>releasedocmaker.py --project falcon --version 0.6 -X not-compatible +</code></pre> +<h1 id="lint-mode">Lint Mode</h1> + +<p>In order to ensure proper formatting while using mvn site, releasedocmaker puts in periods (.) for fields that are empty or unassigned. This can be unsightly and not proper for any given project. There are also other things, such as missing release notes for incompatible changes, that are less than desirable.</p> + +<p>In order to help release managers from having to scan through potentially large documents, releasedocmaker features a lint mode, triggered via –lint:</p> +<pre class="highlight shell"><code><span class="gp">$ </span>releasedocmaker.py --project HBASE --version 1.0.0 --lint +</code></pre> +<p>This will do the normal JIRA querying, looking for items it considers problematic. It will print the information to the screen and then exit with either success or failure, depending upon if any issues were discovered.</p> + +<h1 id="index-mode">Index Mode</h1> + +<p>There is basic support for an autoindexer. It will create two files that contain links to all directories that have a major.minor*-style version numbering system. +For example directories with names like 0.6, 1.2.2, 1.2alpha etc. will all be linked.</p> + +<ul> +<li>index.md: a file suitable for conversion to HTML via mvn site</li> +<li>README.md: a file suitable for display on Github and other Markdown rendering websites</li> +</ul> + +<h1 id="release-version">Release Version</h1> + +<p>You can find the version of the releasedocmaker that you are using by giving the -V option. This may be helpful in finding documentation for the version you are using.</p> +<pre class="highlight shell"><code><span class="gp">$ </span>releasedocmaker.py -V +</code></pre> + </div> + <div class="container"> + <hr> + <footer class="footer"> + <div class="row-fluid"> + <div class="span12 text-left"> + <div class="span12"> + Copyright 2008-2017 <a href="http://www.apache.org/";>Apache Software Foundation</a>. Licensed under the <a href="http://www.apache.org/licenses/";>Apache License v2.0</a>. Apache Yetus and the Apache feather logo are trademarks of The Apache Software Foundation. + </div> + </div> + + </div> + + </footer> +</div> + + </body> +</html> http://git-wip-us.apache.org/repos/asf/yetus/blob/7e0fd8e4/documentation/in-progress/index.html ---------------------------------------------------------------------- diff --git a/documentation/in-progress/index.html b/documentation/in-progress/index.html index 5bbe31b..ed3a48c 100644 --- a/documentation/in-progress/index.html +++ b/documentation/in-progress/index.html @@ -55,6 +55,7 @@ <ul class="dropdown-menu" role="menu"> <li><a href="/documentation/0.4.0/">Docs for v0.4.0</a></li> <li><a href="/documentation/0.5.0/">Docs for v0.5.0</a></li> + <li><a href="/documentation/0.6.0/">Docs for v0.6.0</a></li> <li><a href="/documentation/in-progress/">In Progress Docs for Contributors</a> </li> </ul> http://git-wip-us.apache.org/repos/asf/yetus/blob/7e0fd8e4/documentation/in-progress/interface-classification/index.html ---------------------------------------------------------------------- diff --git a/documentation/in-progress/interface-classification/index.html b/documentation/in-progress/interface-classification/index.html index 35b38c1..c9247fe 100644 --- a/documentation/in-progress/interface-classification/index.html +++ b/documentation/in-progress/interface-classification/index.html @@ -55,6 +55,7 @@ <ul class="dropdown-menu" role="menu"> <li><a href="/documentation/0.4.0/">Docs for v0.4.0</a></li> <li><a href="/documentation/0.5.0/">Docs for v0.5.0</a></li> + <li><a href="/documentation/0.6.0/">Docs for v0.6.0</a></li> <li><a href="/documentation/in-progress/">In Progress Docs for Contributors</a> </li> </ul> http://git-wip-us.apache.org/repos/asf/yetus/blob/7e0fd8e4/documentation/in-progress/precommit-advanced/index.html ---------------------------------------------------------------------- diff --git a/documentation/in-progress/precommit-advanced/index.html b/documentation/in-progress/precommit-advanced/index.html index 4f13561..847262f 100644 --- a/documentation/in-progress/precommit-advanced/index.html +++ b/documentation/in-progress/precommit-advanced/index.html @@ -55,6 +55,7 @@ <ul class="dropdown-menu" role="menu"> <li><a href="/documentation/0.4.0/">Docs for v0.4.0</a></li> <li><a href="/documentation/0.5.0/">Docs for v0.5.0</a></li> + <li><a href="/documentation/0.6.0/">Docs for v0.6.0</a></li> <li><a href="/documentation/in-progress/">In Progress Docs for Contributors</a> </li> </ul> @@ -152,6 +153,10 @@ <p>Dockerfile images will be named with a test-patch prefix and suffix with either a date or a git commit hash. By using this information, test-patch will automatically manage broken/stale container images that are hanging around if it is run in –robot mode. In this way, if Docker fails to build the image, the disk space should eventually be cleaned and returned back to the system. The docker mode can also be run in a <q>safe</q> mode that prevents deletions via the <code>--dockerdelrep</code> option. Specifying this option will cause test-patch to only report what it would have deleted, but not actually remove anything.</p> +<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.</p> + +<p>Additionally, Apache Yetus sets the –oom-score-adj to 500 in order to offer itself as the first processes to be killed if memory is low.</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 are covered below. See other documentation for pertinent information for the other plug-in types.</p> @@ -288,6 +293,15 @@ <span class="nv">GITHUB_REPO</span><span class="o">=</span><span class="s2">"apache/yetus"</span> <span class="o">}</span> </code></pre> +<p>Additionally, a personality may require some outside help from the user. The <code>personality_parse_args</code> +function is called almost immediately after the personality is loaded and plug-ins parse arguments.</p> +<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> +<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> http://git-wip-us.apache.org/repos/asf/yetus/blob/7e0fd8e4/documentation/in-progress/precommit-apidocs/core/index.html ---------------------------------------------------------------------- diff --git a/documentation/in-progress/precommit-apidocs/core/index.html b/documentation/in-progress/precommit-apidocs/core/index.html index 485871d..19cd6ae 100644 --- a/documentation/in-progress/precommit-apidocs/core/index.html +++ b/documentation/in-progress/precommit-apidocs/core/index.html @@ -55,6 +55,7 @@ <ul class="dropdown-menu" role="menu"> <li><a href="/documentation/0.4.0/">Docs for v0.4.0</a></li> <li><a href="/documentation/0.5.0/">Docs for v0.5.0</a></li> + <li><a href="/documentation/0.6.0/">Docs for v0.6.0</a></li> <li><a href="/documentation/in-progress/">In Progress Docs for Contributors</a> </li> </ul> http://git-wip-us.apache.org/repos/asf/yetus/blob/7e0fd8e4/documentation/in-progress/precommit-apidocs/index.html ---------------------------------------------------------------------- diff --git a/documentation/in-progress/precommit-apidocs/index.html b/documentation/in-progress/precommit-apidocs/index.html index d5170e7..3d435e3 100644 --- a/documentation/in-progress/precommit-apidocs/index.html +++ b/documentation/in-progress/precommit-apidocs/index.html @@ -55,6 +55,7 @@ <ul class="dropdown-menu" role="menu"> <li><a href="/documentation/0.4.0/">Docs for v0.4.0</a></li> <li><a href="/documentation/0.5.0/">Docs for v0.5.0</a></li> + <li><a href="/documentation/0.6.0/">Docs for v0.6.0</a></li> <li><a href="/documentation/in-progress/">In Progress Docs for Contributors</a> </li> </ul> http://git-wip-us.apache.org/repos/asf/yetus/blob/7e0fd8e4/documentation/in-progress/precommit-apidocs/plugins/index.html ---------------------------------------------------------------------- diff --git a/documentation/in-progress/precommit-apidocs/plugins/index.html b/documentation/in-progress/precommit-apidocs/plugins/index.html index 3de01fe..008bd96 100644 --- a/documentation/in-progress/precommit-apidocs/plugins/index.html +++ b/documentation/in-progress/precommit-apidocs/plugins/index.html @@ -55,6 +55,7 @@ <ul class="dropdown-menu" role="menu"> <li><a href="/documentation/0.4.0/">Docs for v0.4.0</a></li> <li><a href="/documentation/0.5.0/">Docs for v0.5.0</a></li> + <li><a href="/documentation/0.6.0/">Docs for v0.6.0</a></li> <li><a href="/documentation/in-progress/">In Progress Docs for Contributors</a> </li> </ul> @@ -152,7 +153,9 @@ <li><a href="#javadoc_filefilter">javadoc_filefilter</a></li> <li><a href="#javadoc_initialize">javadoc_initialize</a></li> <li><a href="#junit_finalize_results">junit_finalize_results</a></li> +<li><a href="#junit_parse_args">junit_parse_args</a></li> <li><a href="#junit_process_tests">junit_process_tests</a></li> +<li><a href="#junit_usage">junit_usage</a></li> <li><a href="#maven_buildfile">maven_buildfile</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> @@ -1005,6 +1008,41 @@ <td style="text-align: left">No</td> </tr> </tbody></table> +<h3 id="junit_parse_args"><code>junit_parse_args</code></h3> + +<ul> +<li>Synopsis</li> +</ul> +<pre class="highlight plaintext"><code>junit_parse_args +</code></pre> +<ul> +<li>Description</li> +</ul> + +<p>None</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">None</td> +</tr> +<tr> +<td style="text-align: left">Stability</td> +<td style="text-align: left">None</td> +</tr> +<tr> +<td style="text-align: left">Replaceable</td> +<td style="text-align: left">No</td> +</tr> +</tbody></table> <h3 id="junit_process_tests"><code>junit_process_tests</code></h3> <ul> @@ -1040,6 +1078,41 @@ <td style="text-align: left">No</td> </tr> </tbody></table> +<h3 id="junit_usage"><code>junit_usage</code></h3> + +<ul> +<li>Synopsis</li> +</ul> +<pre class="highlight plaintext"><code>junit_usage +</code></pre> +<ul> +<li>Description</li> +</ul> + +<p>None</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">None</td> +</tr> +<tr> +<td style="text-align: left">Stability</td> +<td style="text-align: left">None</td> +</tr> +<tr> +<td style="text-align: left">Replaceable</td> +<td style="text-align: left">No</td> +</tr> +</tbody></table> <h3 id="maven_buildfile"><code>maven_buildfile</code></h3> <ul> http://git-wip-us.apache.org/repos/asf/yetus/blob/7e0fd8e4/documentation/in-progress/precommit-apidocs/smart-apply-patch/index.html ---------------------------------------------------------------------- diff --git a/documentation/in-progress/precommit-apidocs/smart-apply-patch/index.html b/documentation/in-progress/precommit-apidocs/smart-apply-patch/index.html index 1b570c9..df8cbf6 100644 --- a/documentation/in-progress/precommit-apidocs/smart-apply-patch/index.html +++ b/documentation/in-progress/precommit-apidocs/smart-apply-patch/index.html @@ -55,6 +55,7 @@ <ul class="dropdown-menu" role="menu"> <li><a href="/documentation/0.4.0/">Docs for v0.4.0</a></li> <li><a href="/documentation/0.5.0/">Docs for v0.5.0</a></li> + <li><a href="/documentation/0.6.0/">Docs for v0.6.0</a></li> <li><a href="/documentation/in-progress/">In Progress Docs for Contributors</a> </li> </ul> http://git-wip-us.apache.org/repos/asf/yetus/blob/7e0fd8e4/documentation/in-progress/precommit-apidocs/test-patch/index.html ---------------------------------------------------------------------- diff --git a/documentation/in-progress/precommit-apidocs/test-patch/index.html b/documentation/in-progress/precommit-apidocs/test-patch/index.html index 584e186..551bafe 100644 --- a/documentation/in-progress/precommit-apidocs/test-patch/index.html +++ b/documentation/in-progress/precommit-apidocs/test-patch/index.html @@ -55,6 +55,7 @@ <ul class="dropdown-menu" role="menu"> <li><a href="/documentation/0.4.0/">Docs for v0.4.0</a></li> <li><a href="/documentation/0.5.0/">Docs for v0.5.0</a></li> + <li><a href="/documentation/0.6.0/">Docs for v0.6.0</a></li> <li><a href="/documentation/in-progress/">In Progress Docs for Contributors</a> </li> </ul> http://git-wip-us.apache.org/repos/asf/yetus/blob/7e0fd8e4/documentation/in-progress/precommit-architecture/index.html ---------------------------------------------------------------------- diff --git a/documentation/in-progress/precommit-architecture/index.html b/documentation/in-progress/precommit-architecture/index.html index fb29f65..721bf9c 100644 --- a/documentation/in-progress/precommit-architecture/index.html +++ b/documentation/in-progress/precommit-architecture/index.html @@ -55,6 +55,7 @@ <ul class="dropdown-menu" role="menu"> <li><a href="/documentation/0.4.0/">Docs for v0.4.0</a></li> <li><a href="/documentation/0.5.0/">Docs for v0.5.0</a></li> + <li><a href="/documentation/0.6.0/">Docs for v0.6.0</a></li> <li><a href="/documentation/in-progress/">In Progress Docs for Contributors</a> </li> </ul> http://git-wip-us.apache.org/repos/asf/yetus/blob/7e0fd8e4/documentation/in-progress/precommit-basic/index.html ---------------------------------------------------------------------- diff --git a/documentation/in-progress/precommit-basic/index.html b/documentation/in-progress/precommit-basic/index.html index ae47893..32e0a7d 100644 --- a/documentation/in-progress/precommit-basic/index.html +++ b/documentation/in-progress/precommit-basic/index.html @@ -55,6 +55,7 @@ <ul class="dropdown-menu" role="menu"> <li><a href="/documentation/0.4.0/">Docs for v0.4.0</a></li> <li><a href="/documentation/0.5.0/">Docs for v0.5.0</a></li> + <li><a href="/documentation/0.6.0/">Docs for v0.6.0</a></li> <li><a href="/documentation/in-progress/">In Progress Docs for Contributors</a> </li> </ul> @@ -254,6 +255,13 @@ as a whole.</p> </code></pre> <p>We used two new options here. –basedir sets the location of the repository to use for testing. –resetrepo 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="fork-bomb-protection">Fork Bomb Protection</h1> + +<p>By default, test-patch.sh will set the user soft limit (ulimit -Su) to a relatively low 1,000 processes (and, on some operating systems, threads!). This is to prevent errant processes from eating up all system resources. If this limit is too low (e.g., highly threaded Java processes), it may be necessary to use the <code>--proclimit</code> option. For example:</p> +<pre class="highlight shell"><code><span class="gp">$ </span><span class="nb">test</span>-patch --proclimit<span class="o">=</span>10000 +</code></pre> +<p>… will set it to be 10,000 processes.</p> + <h1 id="automation">Automation</h1> <p>After the tests have run, there is a directory that contains all of the test-patch related artifacts. This is generally referred to as the patchprocess directory. By default, test-patch tries to make something off of /tmp to contain this content. Using the <code>--patch-dir</code> option, one can specify exactly which directory to use. This is helpful for automated precommit testing so that Jenkins or other automated workflow system knows where to look to gather up the output.</p> http://git-wip-us.apache.org/repos/asf/yetus/blob/7e0fd8e4/documentation/in-progress/precommit-bugsystems/index.html ---------------------------------------------------------------------- diff --git a/documentation/in-progress/precommit-bugsystems/index.html b/documentation/in-progress/precommit-bugsystems/index.html index 830c2e5..c8a34a5 100644 --- a/documentation/in-progress/precommit-bugsystems/index.html +++ b/documentation/in-progress/precommit-bugsystems/index.html @@ -55,6 +55,7 @@ <ul class="dropdown-menu" role="menu"> <li><a href="/documentation/0.4.0/">Docs for v0.4.0</a></li> <li><a href="/documentation/0.5.0/">Docs for v0.5.0</a></li> + <li><a href="/documentation/0.6.0/">Docs for v0.6.0</a></li> <li><a href="/documentation/in-progress/">In Progress Docs for Contributors</a> </li> </ul> http://git-wip-us.apache.org/repos/asf/yetus/blob/7e0fd8e4/documentation/in-progress/precommit-buildtools/index.html ---------------------------------------------------------------------- diff --git a/documentation/in-progress/precommit-buildtools/index.html b/documentation/in-progress/precommit-buildtools/index.html index d9596c7..7656791 100644 --- a/documentation/in-progress/precommit-buildtools/index.html +++ b/documentation/in-progress/precommit-buildtools/index.html @@ -55,6 +55,7 @@ <ul class="dropdown-menu" role="menu"> <li><a href="/documentation/0.4.0/">Docs for v0.4.0</a></li> <li><a href="/documentation/0.5.0/">Docs for v0.5.0</a></li> + <li><a href="/documentation/0.6.0/">Docs for v0.6.0</a></li> <li><a href="/documentation/in-progress/">In Progress Docs for Contributors</a> </li> </ul> http://git-wip-us.apache.org/repos/asf/yetus/blob/7e0fd8e4/documentation/in-progress/precommit-docker-cleanup/index.html ---------------------------------------------------------------------- diff --git a/documentation/in-progress/precommit-docker-cleanup/index.html b/documentation/in-progress/precommit-docker-cleanup/index.html index 87bfe07..0a29c3d 100644 --- a/documentation/in-progress/precommit-docker-cleanup/index.html +++ b/documentation/in-progress/precommit-docker-cleanup/index.html @@ -55,6 +55,7 @@ <ul class="dropdown-menu" role="menu"> <li><a href="/documentation/0.4.0/">Docs for v0.4.0</a></li> <li><a href="/documentation/0.5.0/">Docs for v0.5.0</a></li> + <li><a href="/documentation/0.6.0/">Docs for v0.6.0</a></li> <li><a href="/documentation/in-progress/">In Progress Docs for Contributors</a> </li> </ul> http://git-wip-us.apache.org/repos/asf/yetus/blob/7e0fd8e4/documentation/in-progress/precommit-glossary/index.html ---------------------------------------------------------------------- diff --git a/documentation/in-progress/precommit-glossary/index.html b/documentation/in-progress/precommit-glossary/index.html index 88c2c7d..5b8e756 100644 --- a/documentation/in-progress/precommit-glossary/index.html +++ b/documentation/in-progress/precommit-glossary/index.html @@ -55,6 +55,7 @@ <ul class="dropdown-menu" role="menu"> <li><a href="/documentation/0.4.0/">Docs for v0.4.0</a></li> <li><a href="/documentation/0.5.0/">Docs for v0.5.0</a></li> + <li><a href="/documentation/0.6.0/">Docs for v0.6.0</a></li> <li><a href="/documentation/in-progress/">In Progress Docs for Contributors</a> </li> </ul> http://git-wip-us.apache.org/repos/asf/yetus/blob/7e0fd8e4/documentation/in-progress/precommit-patchnames/index.html ---------------------------------------------------------------------- diff --git a/documentation/in-progress/precommit-patchnames/index.html b/documentation/in-progress/precommit-patchnames/index.html index d490743..031402b 100644 --- a/documentation/in-progress/precommit-patchnames/index.html +++ b/documentation/in-progress/precommit-patchnames/index.html @@ -55,6 +55,7 @@ <ul class="dropdown-menu" role="menu"> <li><a href="/documentation/0.4.0/">Docs for v0.4.0</a></li> <li><a href="/documentation/0.5.0/">Docs for v0.5.0</a></li> + <li><a href="/documentation/0.6.0/">Docs for v0.6.0</a></li> <li><a href="/documentation/in-progress/">In Progress Docs for Contributors</a> </li> </ul> http://git-wip-us.apache.org/repos/asf/yetus/blob/7e0fd8e4/documentation/in-progress/precommit-qbt/index.html ---------------------------------------------------------------------- diff --git a/documentation/in-progress/precommit-qbt/index.html b/documentation/in-progress/precommit-qbt/index.html index ddcba4d..cf97b3d 100644 --- a/documentation/in-progress/precommit-qbt/index.html +++ b/documentation/in-progress/precommit-qbt/index.html @@ -55,6 +55,7 @@ <ul class="dropdown-menu" role="menu"> <li><a href="/documentation/0.4.0/">Docs for v0.4.0</a></li> <li><a href="/documentation/0.5.0/">Docs for v0.5.0</a></li> + <li><a href="/documentation/0.6.0/">Docs for v0.6.0</a></li> <li><a href="/documentation/in-progress/">In Progress Docs for Contributors</a> </li> </ul> http://git-wip-us.apache.org/repos/asf/yetus/blob/7e0fd8e4/documentation/in-progress/precommit-smart-apply-patch/index.html ---------------------------------------------------------------------- diff --git a/documentation/in-progress/precommit-smart-apply-patch/index.html b/documentation/in-progress/precommit-smart-apply-patch/index.html index 2446afa..6ccc27f 100644 --- a/documentation/in-progress/precommit-smart-apply-patch/index.html +++ b/documentation/in-progress/precommit-smart-apply-patch/index.html @@ -55,6 +55,7 @@ <ul class="dropdown-menu" role="menu"> <li><a href="/documentation/0.4.0/">Docs for v0.4.0</a></li> <li><a href="/documentation/0.5.0/">Docs for v0.5.0</a></li> + <li><a href="/documentation/0.6.0/">Docs for v0.6.0</a></li> <li><a href="/documentation/in-progress/">In Progress Docs for Contributors</a> </li> </ul> http://git-wip-us.apache.org/repos/asf/yetus/blob/7e0fd8e4/documentation/in-progress/precommit-testformats/index.html ---------------------------------------------------------------------- diff --git a/documentation/in-progress/precommit-testformats/index.html b/documentation/in-progress/precommit-testformats/index.html index c60fd60..7c83c51 100644 --- a/documentation/in-progress/precommit-testformats/index.html +++ b/documentation/in-progress/precommit-testformats/index.html @@ -55,6 +55,7 @@ <ul class="dropdown-menu" role="menu"> <li><a href="/documentation/0.4.0/">Docs for v0.4.0</a></li> <li><a href="/documentation/0.5.0/">Docs for v0.5.0</a></li> + <li><a href="/documentation/0.6.0/">Docs for v0.6.0</a></li> <li><a href="/documentation/in-progress/">In Progress Docs for Contributors</a> </li> </ul> http://git-wip-us.apache.org/repos/asf/yetus/blob/7e0fd8e4/documentation/in-progress/releasedocmaker/index.html ---------------------------------------------------------------------- diff --git a/documentation/in-progress/releasedocmaker/index.html b/documentation/in-progress/releasedocmaker/index.html index 4cdb166..793d0a2 100644 --- a/documentation/in-progress/releasedocmaker/index.html +++ b/documentation/in-progress/releasedocmaker/index.html @@ -55,6 +55,7 @@ <ul class="dropdown-menu" role="menu"> <li><a href="/documentation/0.4.0/">Docs for v0.4.0</a></li> <li><a href="/documentation/0.5.0/">Docs for v0.5.0</a></li> + <li><a href="/documentation/0.6.0/">Docs for v0.6.0</a></li> <li><a href="/documentation/in-progress/">In Progress Docs for Contributors</a> </li> </ul> http://git-wip-us.apache.org/repos/asf/yetus/blob/7e0fd8e4/downloads/index.html ---------------------------------------------------------------------- diff --git a/downloads/index.html b/downloads/index.html index 500a9a1..6a7b294 100644 --- a/downloads/index.html +++ b/downloads/index.html @@ -55,6 +55,7 @@ <ul class="dropdown-menu" role="menu"> <li><a href="/documentation/0.4.0/">Docs for v0.4.0</a></li> <li><a href="/documentation/0.5.0/">Docs for v0.5.0</a></li> + <li><a href="/documentation/0.6.0/">Docs for v0.6.0</a></li> <li><a href="/documentation/in-progress/">In Progress Docs for Contributors</a> </li> </ul> @@ -132,6 +133,14 @@ third-party repositories (e.g. Maven Central).</p> <h2 id="releases">Releases</h2> <ul> +<li>0.6.0 + +<ul> +<li><a href="/documentation/0.6.0/RELEASENOTES">Release Notes</a></li> +<li><a href="/documentation/0.6.0/CHANGES">CHANGES</a></li> +<li>Source : <a href="https://www.apache.org/dyn/closer.lua?path=/yetus/0.6.0/yetus-0.6.0-src.tar.gz";>yetus-0.6.0-src.tar.gz</a> (<a href="https://www.apache.org/dist/yetus/0.6.0/yetus-0.6.0-src.tar.gz.asc";>signature</a>, <a href="https://www.apache.org/dist/yetus/0.6.0/yetus-0.6.0-src.tar.gz.mds";>hashes</a>)</li> +<li>Binaries : <a href="https://www.apache.org/dyn/closer.lua?path=/yetus/0.6.0/yetus-0.6.0-bin.tar.gz";>yetus-0.6.0-bin.tar.gz</a> (<a href="https://www.apache.org/dist/yetus/0.6.0/yetus-0.6.0-bin.tar.gz.asc";>signature</a>, <a href="https://www.apache.org/dist/yetus/0.6.0/yetus-0.6.0-bin.tar.gz.mds";>hashes</a>)</li> +</ul></li> <li>0.5.0 <ul> http://git-wip-us.apache.org/repos/asf/yetus/blob/7e0fd8e4/index.html ---------------------------------------------------------------------- diff --git a/index.html b/index.html index bcebc5a..d1e454b 100644 --- a/index.html +++ b/index.html @@ -55,6 +55,7 @@ <ul class="dropdown-menu" role="menu"> <li><a href="/documentation/0.4.0/">Docs for v0.4.0</a></li> <li><a href="/documentation/0.5.0/">Docs for v0.5.0</a></li> + <li><a href="/documentation/0.6.0/">Docs for v0.6.0</a></li> <li><a href="/documentation/in-progress/">In Progress Docs for Contributors</a> </li> </ul> http://git-wip-us.apache.org/repos/asf/yetus/blob/7e0fd8e4/mailinglists/index.html ---------------------------------------------------------------------- diff --git a/mailinglists/index.html b/mailinglists/index.html index 39be0af..0f80a49 100644 --- a/mailinglists/index.html +++ b/mailinglists/index.html @@ -55,6 +55,7 @@ <ul class="dropdown-menu" role="menu"> <li><a href="/documentation/0.4.0/">Docs for v0.4.0</a></li> <li><a href="/documentation/0.5.0/">Docs for v0.5.0</a></li> + <li><a href="/documentation/0.6.0/">Docs for v0.6.0</a></li> <li><a href="/documentation/in-progress/">In Progress Docs for Contributors</a> </li> </ul>
