http://git-wip-us.apache.org/repos/asf/yetus/blob/6ca1d766/documentation/0.2.1/releasedocmaker/index.html ---------------------------------------------------------------------- diff --git a/documentation/0.2.1/releasedocmaker/index.html b/documentation/0.2.1/releasedocmaker/index.html deleted file mode 100644 index 5477ad9..0000000 --- a/documentation/0.2.1/releasedocmaker/index.html +++ /dev/null @@ -1,242 +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.1.0/">Docs for v0.1.0</a></li> - <li><a href="/documentation/0.2.0/">Docs for v0.2.0</a></li> - <li><a href="/documentation/0.2.1/">Docs for v0.2.1</a></li> - <li><a href="/documentation/0.3.0/">Docs for v0.3.0</a></li> - <li><a href="/documentation/0.4.0/">Docs for v0.4.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="#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="#Lint_Mode">Lint Mode</a></li> -<li><a href="#Index_Mode">Index Mode</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="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="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.micro-style version numbering system, where all fields are numeric.</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> - - </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/6ca1d766/documentation/0.3.0/CHANGES/index.html ---------------------------------------------------------------------- diff --git a/documentation/0.3.0/CHANGES/index.html b/documentation/0.3.0/CHANGES/index.html deleted file mode 100644 index 878cc11..0000000 --- a/documentation/0.3.0/CHANGES/index.html +++ /dev/null @@ -1,667 +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.1.0/">Docs for v0.1.0</a></li> - <li><a href="/documentation/0.2.0/">Docs for v0.2.0</a></li> - <li><a href="/documentation/0.2.1/">Docs for v0.2.1</a></li> - <li><a href="/documentation/0.3.0/">Docs for v0.3.0</a></li> - <li><a href="/documentation/0.4.0/">Docs for v0.4.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="apache-yetus-changelog">Apache Yetus Changelog</h1> - -<h2 id="release-0-3-0-2016-05-23">Release 0.3.0 - 2016-05-23</h2> - -<h3 id="important-issues">IMPORTANT ISSUES:</h3> -<table class='table table-bordered table-striped'><thead><tr> -<th style="text-align: left">JIRA</th> -<th style="text-align: left">Summary</th> -<th style="text-align: left">Priority</th> -<th style="text-align: left">Component</th> -<th style="text-align: left">Reporter</th> -<th style="text-align: left">Contributor</th> -</tr> -</thead><tbody><tr> -<td style="text-align: left"><a href="https://issues.apache.org/jira/browse/YETUS-322";>YETUS-322</a></td> -<td style="text-align: left">flip verify_ result codes</td> -<td style="text-align: left">Major</td> -<td style="text-align: left">Test Patch</td> -<td style="text-align: left">Allen Wittenauer</td> -<td style="text-align: left">Allen Wittenauer</td> -</tr> -<tr> -<td style="text-align: left"><a href="https://issues.apache.org/jira/browse/YETUS-300";>YETUS-300</a></td> -<td style="text-align: left">CHANGED_FILES, CHANGED_MODULES, etc should really be arrays</td> -<td style="text-align: left">Blocker</td> -<td style="text-align: left">Test Patch</td> -<td style="text-align: left">Allen Wittenauer</td> -<td style="text-align: left">Allen Wittenauer</td> -</tr> -<tr> -<td style="text-align: left"><a href="https://issues.apache.org/jira/browse/YETUS-156";>YETUS-156</a></td> -<td style="text-align: left">[Umbrella] build driver</td> -<td style="text-align: left">Major</td> -<td style="text-align: left">Test Patch</td> -<td style="text-align: left">Allen Wittenauer</td> -<td style="text-align: left">Allen Wittenauer</td> -</tr> -</tbody></table> -<h3 id="improvements">IMPROVEMENTS:</h3> -<table class='table table-bordered table-striped'><thead><tr> -<th style="text-align: left">JIRA</th> -<th style="text-align: left">Summary</th> -<th style="text-align: left">Priority</th> -<th style="text-align: left">Component</th> -<th style="text-align: left">Reporter</th> -<th style="text-align: left">Contributor</th> -</tr> -</thead><tbody><tr> -<td style="text-align: left"><a href="https://issues.apache.org/jira/browse/YETUS-330";>YETUS-330</a></td> -<td style="text-align: left">show most recent release first on downloads page</td> -<td style="text-align: left">Minor</td> -<td style="text-align: left">website and documentation</td> -<td style="text-align: left">Sean Busbey</td> -<td style="text-align: left">Sean Busbey</td> -</tr> -<tr> -<td style="text-align: left"><a href="https://issues.apache.org/jira/browse/YETUS-337";>YETUS-337</a></td> -<td style="text-align: left">Upgrade version of pylint used in Dockerfile</td> -<td style="text-align: left">Major</td> -<td style="text-align: left">Test Patch</td> -<td style="text-align: left">Andrew Wang</td> -<td style="text-align: left">Andrew Wang</td> -</tr> -<tr> -<td style="text-align: left"><a href="https://issues.apache.org/jira/browse/YETUS-237";>YETUS-237</a></td> -<td style="text-align: left">Shelldocs should pass pylint</td> -<td style="text-align: left">Major</td> -<td style="text-align: left">ShellDocs</td> -<td style="text-align: left">Kengo Seki</td> -<td style="text-align: left">Allen Wittenauer</td> -</tr> -<tr> -<td style="text-align: left"><a href="https://issues.apache.org/jira/browse/YETUS-306";>YETUS-306</a></td> -<td style="text-align: left">author tag detector should produce a file with pointers to incidence</td> -<td style="text-align: left">Minor</td> -<td style="text-align: left">Test Patch</td> -<td style="text-align: left">Sean Busbey</td> -<td style="text-align: left">Kengo Seki</td> -</tr> -<tr> -<td style="text-align: left"><a href="https://issues.apache.org/jira/browse/YETUS-361";>YETUS-361</a></td> -<td style="text-align: left">Use Google’s pylintrc file</td> -<td style="text-align: left">Major</td> -<td style="text-align: left">Release Doc Maker</td> -<td style="text-align: left">Andrew Wang</td> -<td style="text-align: left">Andrew Wang</td> -</tr> -<tr> -<td style="text-align: left"><a href="https://issues.apache.org/jira/browse/YETUS-358";>YETUS-358</a></td> -<td style="text-align: left">make use of BSD tar in build script explicit</td> -<td style="text-align: left">Blocker</td> -<td style="text-align: left">build</td> -<td style="text-align: left">Sean Busbey</td> -<td style="text-align: left">Sean Busbey</td> -</tr> -<tr> -<td style="text-align: left"><a href="https://issues.apache.org/jira/browse/YETUS-289";>YETUS-289</a></td> -<td style="text-align: left">shelldocs should output error positions in lint mode</td> -<td style="text-align: left">Major</td> -<td style="text-align: left">ShellDocs</td> -<td style="text-align: left">Kengo Seki</td> -<td style="text-align: left">Allen Wittenauer</td> -</tr> -<tr> -<td style="text-align: left"><a href="https://issues.apache.org/jira/browse/YETUS-382";>YETUS-382</a></td> -<td style="text-align: left">launch-test-patch.sh has shellcheck issues</td> -<td style="text-align: left">Major</td> -<td style="text-align: left">Test Patch</td> -<td style="text-align: left">Allen Wittenauer</td> -<td style="text-align: left">Allen Wittenauer</td> -</tr> -<tr> -<td style="text-align: left"><a href="https://issues.apache.org/jira/browse/YETUS-381";>YETUS-381</a></td> -<td style="text-align: left">fix config.rb rubocop issues</td> -<td style="text-align: left">Major</td> -<td style="text-align: left">build</td> -<td style="text-align: left">Allen Wittenauer</td> -<td style="text-align: left">Allen Wittenauer</td> -</tr> -<tr> -<td style="text-align: left"><a href="https://issues.apache.org/jira/browse/YETUS-321";>YETUS-321</a></td> -<td style="text-align: left">releasedocmaker.py lint mode enhancements</td> -<td style="text-align: left">Major</td> -<td style="text-align: left">Release Doc Maker</td> -<td style="text-align: left">Andrew Wang</td> -<td style="text-align: left">Andrew Wang</td> -</tr> -<tr> -<td style="text-align: left"><a href="https://issues.apache.org/jira/browse/YETUS-383";>YETUS-383</a></td> -<td style="text-align: left">fix releasedocmaker pylint issues</td> -<td style="text-align: left">Major</td> -<td style="text-align: left">build, Release Doc Maker</td> -<td style="text-align: left">Allen Wittenauer</td> -<td style="text-align: left">Allen Wittenauer</td> -</tr> -<tr> -<td style="text-align: left"><a href="https://issues.apache.org/jira/browse/YETUS-387";>YETUS-387</a></td> -<td style="text-align: left">fix some dockerfile issues</td> -<td style="text-align: left">Blocker</td> -<td style="text-align: left">build, Test Patch</td> -<td style="text-align: left">Allen Wittenauer</td> -<td style="text-align: left">Allen Wittenauer</td> -</tr> -<tr> -<td style="text-align: left"><a href="https://issues.apache.org/jira/browse/YETUS-331";>YETUS-331</a></td> -<td style="text-align: left">post-r0.2.0 doc feedback</td> -<td style="text-align: left">Major</td> -<td style="text-align: left">website and documentation</td> -<td style="text-align: left">Allen Wittenauer</td> -<td style="text-align: left">Allen Wittenauer</td> -</tr> -<tr> -<td style="text-align: left"><a href="https://issues.apache.org/jira/browse/YETUS-364";>YETUS-364</a></td> -<td style="text-align: left">make building source archive POSIX-compliant</td> -<td style="text-align: left">Major</td> -<td style="text-align: left">build</td> -<td style="text-align: left">Kengo Seki</td> -<td style="text-align: left">Kengo Seki</td> -</tr> -</tbody></table> -<h3 id="bug-fixes">BUG FIXES:</h3> -<table class='table table-bordered table-striped'><thead><tr> -<th style="text-align: left">JIRA</th> -<th style="text-align: left">Summary</th> -<th style="text-align: left">Priority</th> -<th style="text-align: left">Component</th> -<th style="text-align: left">Reporter</th> -<th style="text-align: left">Contributor</th> -</tr> -</thead><tbody><tr> -<td style="text-align: left"><a href="https://issues.apache.org/jira/browse/YETUS-335";>YETUS-335</a></td> -<td style="text-align: left">switch Yetus Dockerfile to use ruby 2.0</td> -<td style="text-align: left">Blocker</td> -<td style="text-align: left">Test Patch</td> -<td style="text-align: left">Allen Wittenauer</td> -<td style="text-align: left">Allen Wittenauer</td> -</tr> -<tr> -<td style="text-align: left"><a href="https://issues.apache.org/jira/browse/YETUS-338";>YETUS-338</a></td> -<td style="text-align: left">test-patch may not update patchfile in patchdir</td> -<td style="text-align: left">Blocker</td> -<td style="text-align: left">Test Patch</td> -<td style="text-align: left">Allen Wittenauer</td> -<td style="text-align: left">Allen Wittenauer</td> -</tr> -<tr> -<td style="text-align: left"><a href="https://issues.apache.org/jira/browse/YETUS-345";>YETUS-345</a></td> -<td style="text-align: left">mvn dependency dupe fix broke hadoop</td> -<td style="text-align: left">Blocker</td> -<td style="text-align: left">Test Patch</td> -<td style="text-align: left">Allen Wittenauer</td> -<td style="text-align: left">Allen Wittenauer</td> -</tr> -<tr> -<td style="text-align: left"><a href="https://issues.apache.org/jira/browse/YETUS-334";>YETUS-334</a></td> -<td style="text-align: left">mvn dependency ordering generates duplicates</td> -<td style="text-align: left">Critical</td> -<td style="text-align: left">Test Patch</td> -<td style="text-align: left">Phil Yang</td> -<td style="text-align: left">Allen Wittenauer</td> -</tr> -<tr> -<td style="text-align: left"><a href="https://issues.apache.org/jira/browse/YETUS-303";>YETUS-303</a></td> -<td style="text-align: left">better sorting options for releasedocmaker</td> -<td style="text-align: left">Major</td> -<td style="text-align: left">Release Doc Maker</td> -<td style="text-align: left">Allen Wittenauer</td> -<td style="text-align: left">Allen Wittenauer</td> -</tr> -<tr> -<td style="text-align: left"><a href="https://issues.apache.org/jira/browse/YETUS-336";>YETUS-336</a></td> -<td style="text-align: left">javadoc plugin giving conflicting answers on pass/fail</td> -<td style="text-align: left">Blocker</td> -<td style="text-align: left">Test Patch</td> -<td style="text-align: left">Sean Busbey</td> -<td style="text-align: left">Allen Wittenauer</td> -</tr> -<tr> -<td style="text-align: left"><a href="https://issues.apache.org/jira/browse/YETUS-363";>YETUS-363</a></td> -<td style="text-align: left">releasedocmaker fails due to the lack of dateutil module</td> -<td style="text-align: left">Major</td> -<td style="text-align: left">Release Doc Maker</td> -<td style="text-align: left">Kengo Seki</td> -<td style="text-align: left">Allen Wittenauer</td> -</tr> -<tr> -<td style="text-align: left"><a href="https://issues.apache.org/jira/browse/YETUS-366";>YETUS-366</a></td> -<td style="text-align: left">Wrapper script generated by build.sh doesn’t work if the user is in the same location and executes it with a relative path</td> -<td style="text-align: left">Minor</td> -<td style="text-align: left">build</td> -<td style="text-align: left">Kengo Seki</td> -<td style="text-align: left">Allen Wittenauer</td> -</tr> -<tr> -<td style="text-align: left"><a href="https://issues.apache.org/jira/browse/YETUS-370";>YETUS-370</a></td> -<td style="text-align: left">multiple compile test types confuse later runs</td> -<td style="text-align: left">Blocker</td> -<td style="text-align: left">Test Patch</td> -<td style="text-align: left">Allen Wittenauer</td> -<td style="text-align: left">Allen Wittenauer</td> -</tr> -<tr> -<td style="text-align: left"><a href="https://issues.apache.org/jira/browse/YETUS-377";>YETUS-377</a></td> -<td style="text-align: left">clean up whitespace</td> -<td style="text-align: left">Major</td> -<td style="text-align: left">website and documentation</td> -<td style="text-align: left">Allen Wittenauer</td> -<td style="text-align: left">Allen Wittenauer</td> -</tr> -<tr> -<td style="text-align: left"><a href="https://issues.apache.org/jira/browse/YETUS-65";>YETUS-65</a></td> -<td style="text-align: left">fix shellcheck 4.1 errors</td> -<td style="text-align: left">Major</td> -<td style="text-align: left">Test Patch</td> -<td style="text-align: left">Allen Wittenauer</td> -<td style="text-align: left">Allen Wittenauer</td> -</tr> -<tr> -<td style="text-align: left"><a href="https://issues.apache.org/jira/browse/YETUS-359";>YETUS-359</a></td> -<td style="text-align: left">shellcheck needs UTF-8 protection</td> -<td style="text-align: left">Major</td> -<td style="text-align: left">Test Patch</td> -<td style="text-align: left">Allen Wittenauer</td> -<td style="text-align: left">Allen Wittenauer</td> -</tr> -<tr> -<td style="text-align: left"><a href="https://issues.apache.org/jira/browse/YETUS-388";>YETUS-388</a></td> -<td style="text-align: left">test-patch fails when no maven found</td> -<td style="text-align: left">Blocker</td> -<td style="text-align: left">Test Patch</td> -<td style="text-align: left">Allen Wittenauer</td> -<td style="text-align: left">Allen Wittenauer</td> -</tr> -<tr> -<td style="text-align: left"><a href="https://issues.apache.org/jira/browse/YETUS-391";>YETUS-391</a></td> -<td style="text-align: left">test-patch regards git 1.7.1x is lower than 1.7.3</td> -<td style="text-align: left">Major</td> -<td style="text-align: left">Test Patch</td> -<td style="text-align: left">Kengo Seki</td> -<td style="text-align: left">Kengo Seki</td> -</tr> -<tr> -<td style="text-align: left"><a href="https://issues.apache.org/jira/browse/YETUS-394";>YETUS-394</a></td> -<td style="text-align: left">Minor fixes to contributor guide and website</td> -<td style="text-align: left">Trivial</td> -<td style="text-align: left">website and documentation</td> -<td style="text-align: left">Aldrin Piri</td> -<td style="text-align: left">Aldrin Piri</td> -</tr> -<tr> -<td style="text-align: left"><a href="https://issues.apache.org/jira/browse/YETUS-393";>YETUS-393</a></td> -<td style="text-align: left">docker check fails for 1.10+</td> -<td style="text-align: left">Blocker</td> -<td style="text-align: left">Test Patch</td> -<td style="text-align: left">Allen Wittenauer</td> -<td style="text-align: left">Allen Wittenauer</td> -</tr> -</tbody></table> -<h3 id="sub-tasks">SUB-TASKS:</h3> -<table class='table table-bordered table-striped'><thead><tr> -<th style="text-align: left">JIRA</th> -<th style="text-align: left">Summary</th> -<th style="text-align: left">Priority</th> -<th style="text-align: left">Component</th> -<th style="text-align: left">Reporter</th> -<th style="text-align: left">Contributor</th> -</tr> -</thead><tbody><tr> -<td style="text-align: left"><a href="https://issues.apache.org/jira/browse/YETUS-324";>YETUS-324</a></td> -<td style="text-align: left">Refactor releasedocmaker.py option parsing into separate function</td> -<td style="text-align: left">Major</td> -<td style="text-align: left">Release Doc Maker</td> -<td style="text-align: left">Andrew Wang</td> -<td style="text-align: left">Andrew Wang</td> -</tr> -<tr> -<td style="text-align: left"><a href="https://issues.apache.org/jira/browse/YETUS-325";>YETUS-325</a></td> -<td style="text-align: left">Refactor releasedocmaker.py lint functionality into separate class</td> -<td style="text-align: left">Major</td> -<td style="text-align: left">Release Doc Maker</td> -<td style="text-align: left">Andrew Wang</td> -<td style="text-align: left">Andrew Wang</td> -</tr> -<tr> -<td style="text-align: left"><a href="https://issues.apache.org/jira/browse/YETUS-332";>YETUS-332</a></td> -<td style="text-align: left">make use of outputdir option consistent with cleaning</td> -<td style="text-align: left">Major</td> -<td style="text-align: left">Release Doc Maker</td> -<td style="text-align: left">Sean Busbey</td> -<td style="text-align: left">Sean Busbey</td> -</tr> -<tr> -<td style="text-align: left"><a href="https://issues.apache.org/jira/browse/YETUS-347";>YETUS-347</a></td> -<td style="text-align: left">change docker’s extraargs to be an array</td> -<td style="text-align: left">Major</td> -<td style="text-align: left">Test Patch</td> -<td style="text-align: left">Allen Wittenauer</td> -<td style="text-align: left">Allen Wittenauer</td> -</tr> -<tr> -<td style="text-align: left"><a href="https://issues.apache.org/jira/browse/YETUS-348";>YETUS-348</a></td> -<td style="text-align: left">add ability to write console report to a file</td> -<td style="text-align: left">Major</td> -<td style="text-align: left">Test Patch</td> -<td style="text-align: left">Allen Wittenauer</td> -<td style="text-align: left">Allen Wittenauer</td> -</tr> -<tr> -<td style="text-align: left"><a href="https://issues.apache.org/jira/browse/YETUS-349";>YETUS-349</a></td> -<td style="text-align: left">core engine changes for build driver</td> -<td style="text-align: left">Major</td> -<td style="text-align: left">Test Patch</td> -<td style="text-align: left">Allen Wittenauer</td> -<td style="text-align: left">Allen Wittenauer</td> -</tr> -<tr> -<td style="text-align: left"><a href="https://issues.apache.org/jira/browse/YETUS-350";>YETUS-350</a></td> -<td style="text-align: left">plug-in changes for build driver</td> -<td style="text-align: left">Major</td> -<td style="text-align: left">Test Patch</td> -<td style="text-align: left">Allen Wittenauer</td> -<td style="text-align: left">Allen Wittenauer</td> -</tr> -<tr> -<td style="text-align: left"><a href="https://issues.apache.org/jira/browse/YETUS-353";>YETUS-353</a></td> -<td style="text-align: left">runtime wrapper for build driver</td> -<td style="text-align: left">Major</td> -<td style="text-align: left">Test Patch</td> -<td style="text-align: left">Allen Wittenauer</td> -<td style="text-align: left">Allen Wittenauer</td> -</tr> -<tr> -<td style="text-align: left"><a href="https://issues.apache.org/jira/browse/YETUS-351";>YETUS-351</a></td> -<td style="text-align: left">documentation changes for build driver</td> -<td style="text-align: left">Major</td> -<td style="text-align: left">Test Patch</td> -<td style="text-align: left">Allen Wittenauer</td> -<td style="text-align: left">Allen Wittenauer</td> -</tr> -<tr> -<td style="text-align: left"><a href="https://issues.apache.org/jira/browse/YETUS-352";>YETUS-352</a></td> -<td style="text-align: left">hadoop and hbase personality changes for build driver</td> -<td style="text-align: left">Major</td> -<td style="text-align: left">Test Patch</td> -<td style="text-align: left">Allen Wittenauer</td> -<td style="text-align: left">Allen Wittenauer</td> -</tr> -<tr> -<td style="text-align: left"><a href="https://issues.apache.org/jira/browse/YETUS-354";>YETUS-354</a></td> -<td style="text-align: left">findbugs in build driver has problems</td> -<td style="text-align: left">Major</td> -<td style="text-align: left">Test Patch</td> -<td style="text-align: left">Allen Wittenauer</td> -<td style="text-align: left">Allen Wittenauer</td> -</tr> -<tr> -<td style="text-align: left"><a href="https://issues.apache.org/jira/browse/YETUS-371";>YETUS-371</a></td> -<td style="text-align: left">build driver: speed up checkstyle</td> -<td style="text-align: left">Major</td> -<td style="text-align: left">Test Patch</td> -<td style="text-align: left">Allen Wittenauer</td> -<td style="text-align: left">Allen Wittenauer</td> -</tr> -<tr> -<td style="text-align: left"><a href="https://issues.apache.org/jira/browse/YETUS-357";>YETUS-357</a></td> -<td style="text-align: left">build driver for hadoop shouldn’t union unit tests</td> -<td style="text-align: left">Major</td> -<td style="text-align: left">Test Patch</td> -<td style="text-align: left">Allen Wittenauer</td> -<td style="text-align: left">Allen Wittenauer</td> -</tr> -<tr> -<td style="text-align: left"><a href="https://issues.apache.org/jira/browse/YETUS-372";>YETUS-372</a></td> -<td style="text-align: left">build driver: unit tests still mentions patches</td> -<td style="text-align: left">Major</td> -<td style="text-align: left">Test Patch</td> -<td style="text-align: left">Allen Wittenauer</td> -<td style="text-align: left">Allen Wittenauer</td> -</tr> -<tr> -<td style="text-align: left"><a href="https://issues.apache.org/jira/browse/YETUS-373";>YETUS-373</a></td> -<td style="text-align: left">build driver: maven install should be smarter</td> -<td style="text-align: left">Major</td> -<td style="text-align: left">Test Patch</td> -<td style="text-align: left">Allen Wittenauer</td> -<td style="text-align: left">Allen Wittenauer</td> -</tr> -<tr> -<td style="text-align: left"><a href="https://issues.apache.org/jira/browse/YETUS-356";>YETUS-356</a></td> -<td style="text-align: left">build driver: author plug-in still mentions patches</td> -<td style="text-align: left">Major</td> -<td style="text-align: left">Test Patch</td> -<td style="text-align: left">Allen Wittenauer</td> -<td style="text-align: left">Allen Wittenauer</td> -</tr> -<tr> -<td style="text-align: left"><a href="https://issues.apache.org/jira/browse/YETUS-374";>YETUS-374</a></td> -<td style="text-align: left">need a way to ignore results from a list of tests</td> -<td style="text-align: left">Major</td> -<td style="text-align: left">Test Patch</td> -<td style="text-align: left">Allen Wittenauer</td> -<td style="text-align: left">Allen Wittenauer</td> -</tr> -<tr> -<td style="text-align: left"><a href="https://issues.apache.org/jira/browse/YETUS-375";>YETUS-375</a></td> -<td style="text-align: left">build driver: maven install actually needs to be dumber</td> -<td style="text-align: left">Major</td> -<td style="text-align: left">Test Patch</td> -<td style="text-align: left">Allen Wittenauer</td> -<td style="text-align: left">Allen Wittenauer</td> -</tr> -<tr> -<td style="text-align: left"><a href="https://issues.apache.org/jira/browse/YETUS-376";>YETUS-376</a></td> -<td style="text-align: left">add ability to write report to an HTML formatted file</td> -<td style="text-align: left">Major</td> -<td style="text-align: left">Test Patch</td> -<td style="text-align: left">Allen Wittenauer</td> -<td style="text-align: left">Allen Wittenauer</td> -</tr> -<tr> -<td style="text-align: left"><a href="https://issues.apache.org/jira/browse/YETUS-384";>YETUS-384</a></td> -<td style="text-align: left">In build driver mode, some plugins have misleading status text</td> -<td style="text-align: left">Minor</td> -<td style="text-align: left">Test Patch</td> -<td style="text-align: left">Sean Busbey</td> -<td style="text-align: left">Allen Wittenauer</td> -</tr> -<tr> -<td style="text-align: left"><a href="https://issues.apache.org/jira/browse/YETUS-385";>YETUS-385</a></td> -<td style="text-align: left">test plugin for author tag detection should have a way to opt-out of specific instances</td> -<td style="text-align: left">Major</td> -<td style="text-align: left">Test Patch</td> -<td style="text-align: left">Sean Busbey</td> -<td style="text-align: left">Allen Wittenauer</td> -</tr> -<tr> -<td style="text-align: left"><a href="https://issues.apache.org/jira/browse/YETUS-378";>YETUS-378</a></td> -<td style="text-align: left">flink, hbase, jmeter personalities custom tests need to be made qbt aware</td> -<td style="text-align: left">Major</td> -<td style="text-align: left">Test Patch</td> -<td style="text-align: left">Allen Wittenauer</td> -<td style="text-align: left">Allen Wittenauer</td> -</tr> -<tr> -<td style="text-align: left"><a href="https://issues.apache.org/jira/browse/YETUS-326";>YETUS-326</a></td> -<td style="text-align: left">Make releasedocmaker.py lint filters configurable</td> -<td style="text-align: left">Major</td> -<td style="text-align: left">Release Doc Maker</td> -<td style="text-align: left">Andrew Wang</td> -<td style="text-align: left">Andrew Wang</td> -</tr> -<tr> -<td style="text-align: left"><a href="https://issues.apache.org/jira/browse/YETUS-386";>YETUS-386</a></td> -<td style="text-align: left">document –html-report-file and clean up htmlout’s comments</td> -<td style="text-align: left">Major</td> -<td style="text-align: left">Test Patch</td> -<td style="text-align: left">Allen Wittenauer</td> -<td style="text-align: left">Allen Wittenauer</td> -</tr> -</tbody></table> -<h3 id="other">OTHER:</h3> -<table class='table table-bordered table-striped'><thead><tr> -<th style="text-align: left">JIRA</th> -<th style="text-align: left">Summary</th> -<th style="text-align: left">Priority</th> -<th style="text-align: left">Component</th> -<th style="text-align: left">Reporter</th> -<th style="text-align: left">Contributor</th> -</tr> -</thead><tbody><tr> -<td style="text-align: left"><a href="https://issues.apache.org/jira/browse/YETUS-329";>YETUS-329</a></td> -<td style="text-align: left">update docs generation to use rel/ tags</td> -<td style="text-align: left">Major</td> -<td style="text-align: left">build, website and documentation</td> -<td style="text-align: left">Sean Busbey</td> -<td style="text-align: left">Sean Busbey</td> -</tr> -<tr> -<td style="text-align: left"><a href="https://issues.apache.org/jira/browse/YETUS-379";>YETUS-379</a></td> -<td style="text-align: left">Release 0.3.0</td> -<td style="text-align: left">Major</td> -<td style="text-align: left">website and documentation</td> -<td style="text-align: left">Kengo Seki</td> -<td style="text-align: left">Kengo Seki</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-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/6ca1d766/documentation/0.3.0/RELEASENOTES/index.html ---------------------------------------------------------------------- diff --git a/documentation/0.3.0/RELEASENOTES/index.html b/documentation/0.3.0/RELEASENOTES/index.html deleted file mode 100644 index 4544d0c..0000000 --- a/documentation/0.3.0/RELEASENOTES/index.html +++ /dev/null @@ -1,234 +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.1.0/">Docs for v0.1.0</a></li> - <li><a href="/documentation/0.2.0/">Docs for v0.2.0</a></li> - <li><a href="/documentation/0.2.1/">Docs for v0.2.1</a></li> - <li><a href="/documentation/0.3.0/">Docs for v0.3.0</a></li> - <li><a href="/documentation/0.4.0/">Docs for v0.4.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="apache-yetus-0-3-0-release-notes">Apache Yetus 0.3.0 Release Notes</h1> - -<p>These release notes cover new developer and user-facing incompatibilities, important issues, features, and major improvements.</p> - -<hr> - -<ul> -<li><a href="https://issues.apache.org/jira/browse/YETUS-337";>YETUS-337</a> | <em>Major</em> | <strong>Upgrade version of pylint used in Dockerfile</strong></li> -</ul> - -<p>The default precommit Dockerfile now relies on pip to grab an up-to-date version of pylint, rather than rely on the version shipped in dpkg.</p> - -<hr> - -<ul> -<li><a href="https://issues.apache.org/jira/browse/YETUS-322";>YETUS-322</a> | <em>Major</em> | <strong>flip verify_ result codes</strong></li> -</ul> - -<p>This changes various verify_ functions such that 0 is always yes/true and 1 is always no/false. This should make it easier/more obvious what test is being performed in if statements. Be aware that this will likely break any personalities or plug-ins that were written against previous versions.</p> - -<hr> - -<ul> -<li><a href="https://issues.apache.org/jira/browse/YETUS-300";>YETUS-300</a> | <em>Blocker</em> | <strong>CHANGED_FILES, CHANGED_MODULES, etc should really be arrays</strong></li> -</ul> - -<!-- markdown --> - -<p>Users:</p> - -<ul> -<li>precommit should now have much better support for source trees with files that have spaces in them.</li> -</ul> - -<p>Devs:</p> - -<ul> -<li>this patch completely changes CHANGED_FILES, CHANGED_MODULES, and USER_MODULES_LIST to be arrays instead of strings. Personalities, plug-ins, etc, that use these will need to be updated appropriately.</li> -</ul> - -<hr> - -<ul> -<li><a href="https://issues.apache.org/jira/browse/YETUS-303";>YETUS-303</a> | <em>Major</em> | <strong>better sorting options for releasedocmaker</strong></li> -</ul> - -<p>Releasedocmaker now supports sorting issues based either on resolution date or issue id. The default remains the same: release date in oldest-first order.</p> - -<p>See the docs for more information.</p> - -<hr> - -<ul> -<li><a href="https://issues.apache.org/jira/browse/YETUS-326";>YETUS-326</a> | <em>Major</em> | <strong>Make releasedocmaker.py lint filters configurable</strong></li> -</ul> - -<!-- markdown --> - -<p>Users of release doc maker can now specify which lint checks they would like used via the <code>--lint</code> command line arguement. Available options are:</p> - -<ul> -<li><q>incompatible</q> - issues flagged incompatible should have release notes</li> -<li><q>important</q> - issues marked important should have release notes</li> -<li><q>version</q> - issues should have a version string of the form <em>major</em>.<em>minor</em>.<em>other</em> or <em>description</em>-_revision</li> -<li><q>component</q> - issues should specify a component</li> -<li><q>assignee</q> - issues should have an assignee</li> -<li><q>all</q> - all of the above</li> -</ul> - -<p>For backwards compatibility, the <code>releasedocmaker</code> wrapper script included in the Yetus convenience binary will treat a bare <code>--lint</code> argument as <code>--lint=all</code>. Users that directly invoke the <code>releasedocmaker.py</code> python script will have to update their invocation.</p> - -<hr> - -<ul> -<li><a href="https://issues.apache.org/jira/browse/YETUS-156";>YETUS-156</a> | <em>Major</em> | <strong>[Umbrella] build driver</strong></li> -</ul> - -<!-- markdown --> - -<p>For users:</p> - -<p>This patch adds the qbt (<q>quality build tool</q>) command in order to run test-patch as a regularly scheduled reporting tool against a source tree without the necessity of providing a patch file.</p> - -<p>For Developers:</p> - -<p>This feature has changed several internal structures and control mechanisms to be incompatible with previous releases:</p> - -<ul> -<li>Previously, a text file was used add extra parameters onto the <code>docker run</code> command. Now this is done via the <code>DOCKER_EXTRAARGS[@]</code> variable.</li> -<li><code>BINNAME</code> now strips off the .sh extension.</li> -<li><code>PATCH_OR_ISSUE</code> and related vars may be empty when running in the full build mode.</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/6ca1d766/documentation/0.3.0/audience-annotations-apidocs/allclasses-frame.html ---------------------------------------------------------------------- diff --git a/documentation/0.3.0/audience-annotations-apidocs/allclasses-frame.html b/documentation/0.3.0/audience-annotations-apidocs/allclasses-frame.html deleted file mode 100644 index 4cdeed9..0000000 --- a/documentation/0.3.0/audience-annotations-apidocs/allclasses-frame.html +++ /dev/null @@ -1,30 +0,0 @@ -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> -<!-- NewPage --> -<html lang="en"> -<head> -<!-- Generated by javadoc (1.8.0_92) on Fri Jun 16 07:14:47 PDT 2017 --> -<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> -<title>All Classes (Apache Yetus - Audience Annotations Component 0.3.0 API)</title> -<meta name="date" content="2017-06-16"> -<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style"> -<script type="text/javascript" src="script.js"></script> -</head> -<body> -<h1 class="bar">All Classes</h1> -<div class="indexContainer"> -<ul> -<li><a href="org/apache/yetus/audience/tools/ExcludePrivateAnnotationsJDiffDoclet.html" title="class in org.apache.yetus.audience.tools" target="classFrame">ExcludePrivateAnnotationsJDiffDoclet</a></li> -<li><a href="org/apache/yetus/audience/tools/ExcludePrivateAnnotationsStandardDoclet.html" title="class in org.apache.yetus.audience.tools" target="classFrame">ExcludePrivateAnnotationsStandardDoclet</a></li> -<li><a href="org/apache/yetus/audience/tools/IncludePublicAnnotationsStandardDoclet.html" title="class in org.apache.yetus.audience.tools" target="classFrame">IncludePublicAnnotationsStandardDoclet</a></li> -<li><a href="org/apache/yetus/audience/InterfaceAudience.html" title="class in org.apache.yetus.audience" target="classFrame">InterfaceAudience</a></li> -<li><a href="org/apache/yetus/audience/InterfaceAudience.LimitedPrivate.html" title="annotation in org.apache.yetus.audience" target="classFrame">InterfaceAudience.LimitedPrivate</a></li> -<li><a href="org/apache/yetus/audience/InterfaceAudience.Private.html" title="annotation in org.apache.yetus.audience" target="classFrame">InterfaceAudience.Private</a></li> -<li><a href="org/apache/yetus/audience/InterfaceAudience.Public.html" title="annotation in org.apache.yetus.audience" target="classFrame">InterfaceAudience.Public</a></li> -<li><a href="org/apache/yetus/audience/InterfaceStability.html" title="class in org.apache.yetus.audience" target="classFrame">InterfaceStability</a></li> -<li><a href="org/apache/yetus/audience/InterfaceStability.Evolving.html" title="annotation in org.apache.yetus.audience" target="classFrame">InterfaceStability.Evolving</a></li> -<li><a href="org/apache/yetus/audience/InterfaceStability.Stable.html" title="annotation in org.apache.yetus.audience" target="classFrame">InterfaceStability.Stable</a></li> -<li><a href="org/apache/yetus/audience/InterfaceStability.Unstable.html" title="annotation in org.apache.yetus.audience" target="classFrame">InterfaceStability.Unstable</a></li> -</ul> -</div> -</body> -</html> http://git-wip-us.apache.org/repos/asf/yetus/blob/6ca1d766/documentation/0.3.0/audience-annotations-apidocs/allclasses-noframe.html ---------------------------------------------------------------------- diff --git a/documentation/0.3.0/audience-annotations-apidocs/allclasses-noframe.html b/documentation/0.3.0/audience-annotations-apidocs/allclasses-noframe.html deleted file mode 100644 index e80e77f..0000000 --- a/documentation/0.3.0/audience-annotations-apidocs/allclasses-noframe.html +++ /dev/null @@ -1,30 +0,0 @@ -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> -<!-- NewPage --> -<html lang="en"> -<head> -<!-- Generated by javadoc (1.8.0_92) on Fri Jun 16 07:14:47 PDT 2017 --> -<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> -<title>All Classes (Apache Yetus - Audience Annotations Component 0.3.0 API)</title> -<meta name="date" content="2017-06-16"> -<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style"> -<script type="text/javascript" src="script.js"></script> -</head> -<body> -<h1 class="bar">All Classes</h1> -<div class="indexContainer"> -<ul> -<li><a href="org/apache/yetus/audience/tools/ExcludePrivateAnnotationsJDiffDoclet.html" title="class in org.apache.yetus.audience.tools">ExcludePrivateAnnotationsJDiffDoclet</a></li> -<li><a href="org/apache/yetus/audience/tools/ExcludePrivateAnnotationsStandardDoclet.html" title="class in org.apache.yetus.audience.tools">ExcludePrivateAnnotationsStandardDoclet</a></li> -<li><a href="org/apache/yetus/audience/tools/IncludePublicAnnotationsStandardDoclet.html" title="class in org.apache.yetus.audience.tools">IncludePublicAnnotationsStandardDoclet</a></li> -<li><a href="org/apache/yetus/audience/InterfaceAudience.html" title="class in org.apache.yetus.audience">InterfaceAudience</a></li> -<li><a href="org/apache/yetus/audience/InterfaceAudience.LimitedPrivate.html" title="annotation in org.apache.yetus.audience">InterfaceAudience.LimitedPrivate</a></li> -<li><a href="org/apache/yetus/audience/InterfaceAudience.Private.html" title="annotation in org.apache.yetus.audience">InterfaceAudience.Private</a></li> -<li><a href="org/apache/yetus/audience/InterfaceAudience.Public.html" title="annotation in org.apache.yetus.audience">InterfaceAudience.Public</a></li> -<li><a href="org/apache/yetus/audience/InterfaceStability.html" title="class in org.apache.yetus.audience">InterfaceStability</a></li> -<li><a href="org/apache/yetus/audience/InterfaceStability.Evolving.html" title="annotation in org.apache.yetus.audience">InterfaceStability.Evolving</a></li> -<li><a href="org/apache/yetus/audience/InterfaceStability.Stable.html" title="annotation in org.apache.yetus.audience">InterfaceStability.Stable</a></li> -<li><a href="org/apache/yetus/audience/InterfaceStability.Unstable.html" title="annotation in org.apache.yetus.audience">InterfaceStability.Unstable</a></li> -</ul> -</div> -</body> -</html> http://git-wip-us.apache.org/repos/asf/yetus/blob/6ca1d766/documentation/0.3.0/audience-annotations-apidocs/constant-values.html ---------------------------------------------------------------------- diff --git a/documentation/0.3.0/audience-annotations-apidocs/constant-values.html b/documentation/0.3.0/audience-annotations-apidocs/constant-values.html deleted file mode 100644 index d4d1373..0000000 --- a/documentation/0.3.0/audience-annotations-apidocs/constant-values.html +++ /dev/null @@ -1,126 +0,0 @@ -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> -<!-- NewPage --> -<html lang="en"> -<head> -<!-- Generated by javadoc (1.8.0_92) on Fri Jun 16 07:14:46 PDT 2017 --> -<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> -<title>Constant Field Values (Apache Yetus - Audience Annotations Component 0.3.0 API)</title> -<meta name="date" content="2017-06-16"> -<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style"> -<script type="text/javascript" src="script.js"></script> -</head> -<body> -<script type="text/javascript"><!-- - try { - if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="Constant Field Values (Apache Yetus - Audience Annotations Component 0.3.0 API)"; - } - } - catch(err) { - } -//--> -</script> -<noscript> -<div>JavaScript is disabled on your browser.</div> -</noscript> -<!-- ========= START OF TOP NAVBAR ======= --> -<div class="topNav"><a name="navbar.top"> -<!-- --> -</a> -<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> -<a name="navbar.top.firstrow"> -<!-- --> -</a> -<ul class="navList" title="Navigation"> -<li><a href="overview-summary.html">Overview</a></li> -<li>Package</li> -<li>Class</li> -<li>Use</li> -<li><a href="overview-tree.html">Tree</a></li> -<li><a href="deprecated-list.html">Deprecated</a></li> -<li><a href="index-all.html">Index</a></li> -<li><a href="help-doc.html">Help</a></li> -</ul> -</div> -<div class="subNav"> -<ul class="navList"> -<li>Prev</li> -<li>Next</li> -</ul> -<ul class="navList"> -<li><a href="index.html?constant-values.html" target="_top">Frames</a></li> -<li><a href="constant-values.html" target="_top">No Frames</a></li> -</ul> -<ul class="navList" id="allclasses_navbar_top"> -<li><a href="allclasses-noframe.html">All Classes</a></li> -</ul> -<div> -<script type="text/javascript"><!-- - allClassesLink = document.getElementById("allclasses_navbar_top"); - if(window==top) { - allClassesLink.style.display = "block"; - } - else { - allClassesLink.style.display = "none"; - } - //--> -</script> -</div> -<a name="skip.navbar.top"> -<!-- --> -</a></div> -<!-- ========= END OF TOP NAVBAR ========= --> -<div class="header"> -<h1 title="Constant Field Values" class="title">Constant Field Values</h1> -<h2 title="Contents">Contents</h2> -</div> -<!-- ======= START OF BOTTOM NAVBAR ====== --> -<div class="bottomNav"><a name="navbar.bottom"> -<!-- --> -</a> -<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> -<a name="navbar.bottom.firstrow"> -<!-- --> -</a> -<ul class="navList" title="Navigation"> -<li><a href="overview-summary.html">Overview</a></li> -<li>Package</li> -<li>Class</li> -<li>Use</li> -<li><a href="overview-tree.html">Tree</a></li> -<li><a href="deprecated-list.html">Deprecated</a></li> -<li><a href="index-all.html">Index</a></li> -<li><a href="help-doc.html">Help</a></li> -</ul> -</div> -<div class="subNav"> -<ul class="navList"> -<li>Prev</li> -<li>Next</li> -</ul> -<ul class="navList"> -<li><a href="index.html?constant-values.html" target="_top">Frames</a></li> -<li><a href="constant-values.html" target="_top">No Frames</a></li> -</ul> -<ul class="navList" id="allclasses_navbar_bottom"> -<li><a href="allclasses-noframe.html">All Classes</a></li> -</ul> -<div> -<script type="text/javascript"><!-- - allClassesLink = document.getElementById("allclasses_navbar_bottom"); - if(window==top) { - allClassesLink.style.display = "block"; - } - else { - allClassesLink.style.display = "none"; - } - //--> -</script> -</div> -<a name="skip.navbar.bottom"> -<!-- --> -</a></div> -<!-- ======== END OF BOTTOM NAVBAR ======= --> -<p class="legalCopy"><small>Copyright © 2015–2017 <a href="http://www.apache.org/";>The Apache Software Foundation</a>. All rights reserved.</small></p> -</body> -</html> http://git-wip-us.apache.org/repos/asf/yetus/blob/6ca1d766/documentation/0.3.0/audience-annotations-apidocs/deprecated-list.html ---------------------------------------------------------------------- diff --git a/documentation/0.3.0/audience-annotations-apidocs/deprecated-list.html b/documentation/0.3.0/audience-annotations-apidocs/deprecated-list.html deleted file mode 100644 index 24942b3..0000000 --- a/documentation/0.3.0/audience-annotations-apidocs/deprecated-list.html +++ /dev/null @@ -1,126 +0,0 @@ -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> -<!-- NewPage --> -<html lang="en"> -<head> -<!-- Generated by javadoc (1.8.0_92) on Fri Jun 16 07:14:47 PDT 2017 --> -<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> -<title>Deprecated List (Apache Yetus - Audience Annotations Component 0.3.0 API)</title> -<meta name="date" content="2017-06-16"> -<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style"> -<script type="text/javascript" src="script.js"></script> -</head> -<body> -<script type="text/javascript"><!-- - try { - if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="Deprecated List (Apache Yetus - Audience Annotations Component 0.3.0 API)"; - } - } - catch(err) { - } -//--> -</script> -<noscript> -<div>JavaScript is disabled on your browser.</div> -</noscript> -<!-- ========= START OF TOP NAVBAR ======= --> -<div class="topNav"><a name="navbar.top"> -<!-- --> -</a> -<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> -<a name="navbar.top.firstrow"> -<!-- --> -</a> -<ul class="navList" title="Navigation"> -<li><a href="overview-summary.html">Overview</a></li> -<li>Package</li> -<li>Class</li> -<li>Use</li> -<li><a href="overview-tree.html">Tree</a></li> -<li class="navBarCell1Rev">Deprecated</li> -<li><a href="index-all.html">Index</a></li> -<li><a href="help-doc.html">Help</a></li> -</ul> -</div> -<div class="subNav"> -<ul class="navList"> -<li>Prev</li> -<li>Next</li> -</ul> -<ul class="navList"> -<li><a href="index.html?deprecated-list.html" target="_top">Frames</a></li> -<li><a href="deprecated-list.html" target="_top">No Frames</a></li> -</ul> -<ul class="navList" id="allclasses_navbar_top"> -<li><a href="allclasses-noframe.html">All Classes</a></li> -</ul> -<div> -<script type="text/javascript"><!-- - allClassesLink = document.getElementById("allclasses_navbar_top"); - if(window==top) { - allClassesLink.style.display = "block"; - } - else { - allClassesLink.style.display = "none"; - } - //--> -</script> -</div> -<a name="skip.navbar.top"> -<!-- --> -</a></div> -<!-- ========= END OF TOP NAVBAR ========= --> -<div class="header"> -<h1 title="Deprecated API" class="title">Deprecated API</h1> -<h2 title="Contents">Contents</h2> -</div> -<!-- ======= START OF BOTTOM NAVBAR ====== --> -<div class="bottomNav"><a name="navbar.bottom"> -<!-- --> -</a> -<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> -<a name="navbar.bottom.firstrow"> -<!-- --> -</a> -<ul class="navList" title="Navigation"> -<li><a href="overview-summary.html">Overview</a></li> -<li>Package</li> -<li>Class</li> -<li>Use</li> -<li><a href="overview-tree.html">Tree</a></li> -<li class="navBarCell1Rev">Deprecated</li> -<li><a href="index-all.html">Index</a></li> -<li><a href="help-doc.html">Help</a></li> -</ul> -</div> -<div class="subNav"> -<ul class="navList"> -<li>Prev</li> -<li>Next</li> -</ul> -<ul class="navList"> -<li><a href="index.html?deprecated-list.html" target="_top">Frames</a></li> -<li><a href="deprecated-list.html" target="_top">No Frames</a></li> -</ul> -<ul class="navList" id="allclasses_navbar_bottom"> -<li><a href="allclasses-noframe.html">All Classes</a></li> -</ul> -<div> -<script type="text/javascript"><!-- - allClassesLink = document.getElementById("allclasses_navbar_bottom"); - if(window==top) { - allClassesLink.style.display = "block"; - } - else { - allClassesLink.style.display = "none"; - } - //--> -</script> -</div> -<a name="skip.navbar.bottom"> -<!-- --> -</a></div> -<!-- ======== END OF BOTTOM NAVBAR ======= --> -<p class="legalCopy"><small>Copyright © 2015–2017 <a href="http://www.apache.org/";>The Apache Software Foundation</a>. All rights reserved.</small></p> -</body> -</html> http://git-wip-us.apache.org/repos/asf/yetus/blob/6ca1d766/documentation/0.3.0/audience-annotations-apidocs/help-doc.html ---------------------------------------------------------------------- diff --git a/documentation/0.3.0/audience-annotations-apidocs/help-doc.html b/documentation/0.3.0/audience-annotations-apidocs/help-doc.html deleted file mode 100644 index c972db1..0000000 --- a/documentation/0.3.0/audience-annotations-apidocs/help-doc.html +++ /dev/null @@ -1,231 +0,0 @@ -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> -<!-- NewPage --> -<html lang="en"> -<head> -<!-- Generated by javadoc (1.8.0_92) on Fri Jun 16 07:14:47 PDT 2017 --> -<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> -<title>API Help (Apache Yetus - Audience Annotations Component 0.3.0 API)</title> -<meta name="date" content="2017-06-16"> -<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style"> -<script type="text/javascript" src="script.js"></script> -</head> -<body> -<script type="text/javascript"><!-- - try { - if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="API Help (Apache Yetus - Audience Annotations Component 0.3.0 API)"; - } - } - catch(err) { - } -//--> -</script> -<noscript> -<div>JavaScript is disabled on your browser.</div> -</noscript> -<!-- ========= START OF TOP NAVBAR ======= --> -<div class="topNav"><a name="navbar.top"> -<!-- --> -</a> -<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> -<a name="navbar.top.firstrow"> -<!-- --> -</a> -<ul class="navList" title="Navigation"> -<li><a href="overview-summary.html">Overview</a></li> -<li>Package</li> -<li>Class</li> -<li>Use</li> -<li><a href="overview-tree.html">Tree</a></li> -<li><a href="deprecated-list.html">Deprecated</a></li> -<li><a href="index-all.html">Index</a></li> -<li class="navBarCell1Rev">Help</li> -</ul> -</div> -<div class="subNav"> -<ul class="navList"> -<li>Prev</li> -<li>Next</li> -</ul> -<ul class="navList"> -<li><a href="index.html?help-doc.html" target="_top">Frames</a></li> -<li><a href="help-doc.html" target="_top">No Frames</a></li> -</ul> -<ul class="navList" id="allclasses_navbar_top"> -<li><a href="allclasses-noframe.html">All Classes</a></li> -</ul> -<div> -<script type="text/javascript"><!-- - allClassesLink = document.getElementById("allclasses_navbar_top"); - if(window==top) { - allClassesLink.style.display = "block"; - } - else { - allClassesLink.style.display = "none"; - } - //--> -</script> -</div> -<a name="skip.navbar.top"> -<!-- --> -</a></div> -<!-- ========= END OF TOP NAVBAR ========= --> -<div class="header"> -<h1 class="title">How This API Document Is Organized</h1> -<div class="subTitle">This API (Application Programming Interface) document has pages corresponding to the items in the navigation bar, described as follows.</div> -</div> -<div class="contentContainer"> -<ul class="blockList"> -<li class="blockList"> -<h2>Overview</h2> -<p>The <a href="overview-summary.html">Overview</a> page is the front page of this API document and provides a list of all packages with a summary for each. This page can also contain an overall description of the set of packages.</p> -</li> -<li class="blockList"> -<h2>Package</h2> -<p>Each package has a page that contains a list of its classes and interfaces, with a summary for each. This page can contain six categories:</p> -<ul> -<li>Interfaces (italic)</li> -<li>Classes</li> -<li>Enums</li> -<li>Exceptions</li> -<li>Errors</li> -<li>Annotation Types</li> -</ul> -</li> -<li class="blockList"> -<h2>Class/Interface</h2> -<p>Each class, interface, nested class and nested interface has its own separate page. Each of these pages has three sections consisting of a class/interface description, summary tables, and detailed member descriptions:</p> -<ul> -<li>Class inheritance diagram</li> -<li>Direct Subclasses</li> -<li>All Known Subinterfaces</li> -<li>All Known Implementing Classes</li> -<li>Class/interface declaration</li> -<li>Class/interface description</li> -</ul> -<ul> -<li>Nested Class Summary</li> -<li>Field Summary</li> -<li>Constructor Summary</li> -<li>Method Summary</li> -</ul> -<ul> -<li>Field Detail</li> -<li>Constructor Detail</li> -<li>Method Detail</li> -</ul> -<p>Each summary entry contains the first sentence from the detailed description for that item. The summary entries are alphabetical, while the detailed descriptions are in the order they appear in the source code. This preserves the logical groupings established by the programmer.</p> -</li> -<li class="blockList"> -<h2>Annotation Type</h2> -<p>Each annotation type has its own separate page with the following sections:</p> -<ul> -<li>Annotation Type declaration</li> -<li>Annotation Type description</li> -<li>Required Element Summary</li> -<li>Optional Element Summary</li> -<li>Element Detail</li> -</ul> -</li> -<li class="blockList"> -<h2>Enum</h2> -<p>Each enum has its own separate page with the following sections:</p> -<ul> -<li>Enum declaration</li> -<li>Enum description</li> -<li>Enum Constant Summary</li> -<li>Enum Constant Detail</li> -</ul> -</li> -<li class="blockList"> -<h2>Use</h2> -<p>Each documented package, class and interface has its own Use page. This page describes what packages, classes, methods, constructors and fields use any part of the given class or package. Given a class or interface A, its Use page includes subclasses of A, fields declared as A, methods that return A, and methods and constructors with parameters of type A. You can access this page by first going to the package, class or interface, then clicking on the "Use" link in the navigation bar.</p> -</li> -<li class="blockList"> -<h2>Tree (Class Hierarchy)</h2> -<p>There is a <a href="overview-tree.html">Class Hierarchy</a> page for all packages, plus a hierarchy for each package. Each hierarchy page contains a list of classes and a list of interfaces. The classes are organized by inheritance structure starting with <code>java.lang.Object</code>. The interfaces do not inherit from <code>java.lang.Object</code>.</p> -<ul> -<li>When viewing the Overview page, clicking on "Tree" displays the hierarchy for all packages.</li> -<li>When viewing a particular package, class or interface page, clicking "Tree" displays the hierarchy for only that package.</li> -</ul> -</li> -<li class="blockList"> -<h2>Deprecated API</h2> -<p>The <a href="deprecated-list.html">Deprecated API</a> page lists all of the API that have been deprecated. A deprecated API is not recommended for use, generally due to improvements, and a replacement API is usually given. Deprecated APIs may be removed in future implementations.</p> -</li> -<li class="blockList"> -<h2>Index</h2> -<p>The <a href="index-all.html">Index</a> contains an alphabetic list of all classes, interfaces, constructors, methods, and fields.</p> -</li> -<li class="blockList"> -<h2>Prev/Next</h2> -<p>These links take you to the next or previous class, interface, package, or related page.</p> -</li> -<li class="blockList"> -<h2>Frames/No Frames</h2> -<p>These links show and hide the HTML frames. All pages are available with or without frames.</p> -</li> -<li class="blockList"> -<h2>All Classes</h2> -<p>The <a href="allclasses-noframe.html">All Classes</a> link shows all classes and interfaces except non-static nested types.</p> -</li> -<li class="blockList"> -<h2>Serialized Form</h2> -<p>Each serializable or externalizable class has a description of its serialization fields and methods. This information is of interest to re-implementors, not to developers using the API. While there is no link in the navigation bar, you can get to this information by going to any serialized class and clicking "Serialized Form" in the "See also" section of the class description.</p> -</li> -<li class="blockList"> -<h2>Constant Field Values</h2> -<p>The <a href="constant-values.html">Constant Field Values</a> page lists the static final fields and their values.</p> -</li> -</ul> -<span class="emphasizedPhrase">This help file applies to API documentation generated using the standard doclet.</span></div> -<!-- ======= START OF BOTTOM NAVBAR ====== --> -<div class="bottomNav"><a name="navbar.bottom"> -<!-- --> -</a> -<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> -<a name="navbar.bottom.firstrow"> -<!-- --> -</a> -<ul class="navList" title="Navigation"> -<li><a href="overview-summary.html">Overview</a></li> -<li>Package</li> -<li>Class</li> -<li>Use</li> -<li><a href="overview-tree.html">Tree</a></li> -<li><a href="deprecated-list.html">Deprecated</a></li> -<li><a href="index-all.html">Index</a></li> -<li class="navBarCell1Rev">Help</li> -</ul> -</div> -<div class="subNav"> -<ul class="navList"> -<li>Prev</li> -<li>Next</li> -</ul> -<ul class="navList"> -<li><a href="index.html?help-doc.html" target="_top">Frames</a></li> -<li><a href="help-doc.html" target="_top">No Frames</a></li> -</ul> -<ul class="navList" id="allclasses_navbar_bottom"> -<li><a href="allclasses-noframe.html">All Classes</a></li> -</ul> -<div> -<script type="text/javascript"><!-- - allClassesLink = document.getElementById("allclasses_navbar_bottom"); - if(window==top) { - allClassesLink.style.display = "block"; - } - else { - allClassesLink.style.display = "none"; - } - //--> -</script> -</div> -<a name="skip.navbar.bottom"> -<!-- --> -</a></div> -<!-- ======== END OF BOTTOM NAVBAR ======= --> -<p class="legalCopy"><small>Copyright © 2015–2017 <a href="http://www.apache.org/";>The Apache Software Foundation</a>. All rights reserved.</small></p> -</body> -</html>
