Repository: yetus Updated Branches: refs/heads/asf-site 455063f65 -> 1a20466fe
http://git-wip-us.apache.org/repos/asf/yetus/blob/1a20466f/documentation/latest/precommit-patchnames/index.html ---------------------------------------------------------------------- diff --git a/documentation/latest/precommit-patchnames/index.html b/documentation/latest/precommit-patchnames/index.html deleted file mode 100644 index 8004e86..0000000 --- a/documentation/latest/precommit-patchnames/index.html +++ /dev/null @@ -1,153 +0,0 @@ -<!--- - Licensed to the Apache Software Foundation (ASF) under one - or more contributor license agreements. See the NOTICE file - distributed with this work for additional information - regarding copyright ownership. The ASF licenses this file - to you under the Apache License, Version 2.0 (the - "License"); you may not use this file except in compliance - with the License. You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, - software distributed under the License is distributed on an - "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY - KIND, either express or implied. See the License for the - specific language governing permissions and limitations - under the License. ---> - -<html> - <head> - <meta charset="utf-8"> - <title>Apache Yetus</title> - <meta name="viewport" content="width=device-width, initial-scale=1.0"> - <meta name="description" content=""> - <meta name="author" content=""> - - <link href="/assets/css/bootstrap.css" rel="stylesheet"> - <link href="/assets/css/bootstrap-theme.css" rel="stylesheet"> - <link href="/assets/css/font-awesome.css" rel="stylesheet"> - - <!-- JS --> - <script type="text/javascript" src="/assets/js/jquery-2.1.4.min.js"></script> - <script type="text/javascript" src="/assets/js/bootstrap.js"></script> - </head> - <body> - <div class="navbar navbar-inverse navbar-static-top" role="navigation"> - <div class="container"> - <div class="navbar-header"> - <button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".navbar-collapse"> - <span class="sr-only">Toggle navigation</span> - <span class="icon-bar"></span> - <span class="icon-bar"></span> - <span class="icon-bar"></span> - </button> - <a class="img-responsive pull-left" href="/"> - <img style="max-height: 40px; margin-top: 5px; margin-bottom: 5px;" src="/assets/img/yetus_logo.png" alt="Apache Yetus logo" /> - </a> - </div> - <div class="navbar-collapse collapse"> - <ul class="nav navbar-nav"> - <li><a href="/downloads/">Downloads</a> - <li><a href="/documentation/latest/">Documentation</a> - </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. ---> - -<p>We use Apache Yetus to process your patch. It supports the following patterns and -procedures for patch file names:</p> - -<p>JIRA:</p> - -<p>If JIRA support is configured, attach the patch to the given ISSUE and -click ‘Submit Patch’. The patch file should be named one of:</p> - -<ul> -<li>ISSUE.patch</li> -<li>ISSUE.###.patch</li> -<li>ISSUE.branch.###.patch</li> -<li>ISSUE-branch-###.patch</li> -<li>ISSUE.##.branch.patch</li> -<li>ISSUE-branch.##.patch</li> -</ul> - -<p>If Github support is also configured, a comment that contains a link to a Pull Request’s -patch file (e.g., <a href="https://github.com/user/repo/pull/1.patch";>https://github.com/user/repo/pull/1.patch</a>) will pull the patch from -the given Github PR.</p> - - </div> - <div class="container"> - <hr> - <footer class="footer"> - <div class="row-fluid"> - <div class="span12 text-left"> - <div class="span12"> - Copyright 2008-2015 <a href="http://www.apache.org/";>Apache Software Foundation</a>. Licensed under the <a href="http://www.apache.org/licenses/";>Apache License v2.0</a>. Apache Yetus and the Apache feather logo are trademarks of The Apache Software Foundation. - </div> - </div> - - </div> - - </footer> -</div> - - </body> -</html> http://git-wip-us.apache.org/repos/asf/yetus/blob/1a20466f/documentation/latest/precommit-smart-apply-patch/index.html ---------------------------------------------------------------------- diff --git a/documentation/latest/precommit-smart-apply-patch/index.html b/documentation/latest/precommit-smart-apply-patch/index.html deleted file mode 100644 index 67289d1..0000000 --- a/documentation/latest/precommit-smart-apply-patch/index.html +++ /dev/null @@ -1,160 +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><a href="/documentation/latest/">Documentation</a> - </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 simpliest 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-2015 <a href="http://www.apache.org/";>Apache Software Foundation</a>. Licensed under the <a href="http://www.apache.org/licenses/";>Apache License v2.0</a>. Apache Yetus and the Apache feather logo are trademarks of The Apache Software Foundation. - </div> - </div> - - </div> - - </footer> -</div> - - </body> -</html> http://git-wip-us.apache.org/repos/asf/yetus/blob/1a20466f/documentation/latest/precommit-testformats/index.html ---------------------------------------------------------------------- diff --git a/documentation/latest/precommit-testformats/index.html b/documentation/latest/precommit-testformats/index.html deleted file mode 100644 index 5ab5078..0000000 --- a/documentation/latest/precommit-testformats/index.html +++ /dev/null @@ -1,151 +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><a href="/documentation/latest/">Documentation</a> - </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> - -<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> - - </div> - <div class="container"> - <hr> - <footer class="footer"> - <div class="row-fluid"> - <div class="span12 text-left"> - <div class="span12"> - Copyright 2008-2015 <a href="http://www.apache.org/";>Apache Software Foundation</a>. Licensed under the <a href="http://www.apache.org/licenses/";>Apache License v2.0</a>. Apache Yetus and the Apache feather logo are trademarks of The Apache Software Foundation. - </div> - </div> - - </div> - - </footer> -</div> - - </body> -</html> http://git-wip-us.apache.org/repos/asf/yetus/blob/1a20466f/documentation/latest/releasedocmaker/index.html ---------------------------------------------------------------------- diff --git a/documentation/latest/releasedocmaker/index.html b/documentation/latest/releasedocmaker/index.html deleted file mode 100644 index f6885d1..0000000 --- a/documentation/latest/releasedocmaker/index.html +++ /dev/null @@ -1,240 +0,0 @@ -<!--- - Licensed to the Apache Software Foundation (ASF) under one - or more contributor license agreements. See the NOTICE file - distributed with this work for additional information - regarding copyright ownership. The ASF licenses this file - to you under the Apache License, Version 2.0 (the - "License"); you may not use this file except in compliance - with the License. You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, - software distributed under the License is distributed on an - "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY - KIND, either express or implied. See the License for the - specific language governing permissions and limitations - under the License. ---> - -<html> - <head> - <meta charset="utf-8"> - <title>Apache Yetus</title> - <meta name="viewport" content="width=device-width, initial-scale=1.0"> - <meta name="description" content=""> - <meta name="author" content=""> - - <link href="/assets/css/bootstrap.css" rel="stylesheet"> - <link href="/assets/css/bootstrap-theme.css" rel="stylesheet"> - <link href="/assets/css/font-awesome.css" rel="stylesheet"> - - <!-- JS --> - <script type="text/javascript" src="/assets/js/jquery-2.1.4.min.js"></script> - <script type="text/javascript" src="/assets/js/bootstrap.js"></script> - </head> - <body> - <div class="navbar navbar-inverse navbar-static-top" role="navigation"> - <div class="container"> - <div class="navbar-header"> - <button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".navbar-collapse"> - <span class="sr-only">Toggle navigation</span> - <span class="icon-bar"></span> - <span class="icon-bar"></span> - <span class="icon-bar"></span> - </button> - <a class="img-responsive pull-left" href="/"> - <img style="max-height: 40px; margin-top: 5px; margin-bottom: 5px;" src="/assets/img/yetus_logo.png" alt="Apache Yetus logo" /> - </a> - </div> - <div class="navbar-collapse collapse"> - <ul class="nav navbar-nav"> - <li><a href="/downloads/">Downloads</a> - <li><a href="/documentation/latest/">Documentation</a> - </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 “Release Notes” 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 “Release Notes” 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 “HBASE”, it will use “Apache HBASE” 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 “Unreleased”. 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-2015 <a href="http://www.apache.org/";>Apache Software Foundation</a>. Licensed under the <a href="http://www.apache.org/licenses/";>Apache License v2.0</a>. Apache Yetus and the Apache feather logo are trademarks of The Apache Software Foundation. - </div> - </div> - - </div> - - </footer> -</div> - - </body> -</html> http://git-wip-us.apache.org/repos/asf/yetus/blob/1a20466f/downloads/index.html ---------------------------------------------------------------------- diff --git a/downloads/index.html b/downloads/index.html index cf66c39..dc8da38 100644 --- a/downloads/index.html +++ b/downloads/index.html @@ -50,7 +50,7 @@ <div class="navbar-collapse collapse"> <ul class="nav navbar-nav"> <li><a href="/downloads/">Downloads</a> - <li><a href="/documentation/latest/">Documentation</a> + <li><a href="/documentation/in-progress/">Documentation</a> </li> <li class="dropdown"> <a class="dropdown-toggle" data-toggle="dropdown" href="#">Get Involved <span class="caret"></span></a> http://git-wip-us.apache.org/repos/asf/yetus/blob/1a20466f/index.html ---------------------------------------------------------------------- diff --git a/index.html b/index.html index 4b7e5da..e9efc4f 100644 --- a/index.html +++ b/index.html @@ -50,7 +50,7 @@ <div class="navbar-collapse collapse"> <ul class="nav navbar-nav"> <li><a href="/downloads/">Downloads</a> - <li><a href="/documentation/latest/">Documentation</a> + <li><a href="/documentation/in-progress/">Documentation</a> </li> <li class="dropdown"> <a class="dropdown-toggle" data-toggle="dropdown" href="#">Get Involved <span class="caret"></span></a> http://git-wip-us.apache.org/repos/asf/yetus/blob/1a20466f/mailinglists/index.html ---------------------------------------------------------------------- diff --git a/mailinglists/index.html b/mailinglists/index.html index 7b10785..550540e 100644 --- a/mailinglists/index.html +++ b/mailinglists/index.html @@ -50,7 +50,7 @@ <div class="navbar-collapse collapse"> <ul class="nav navbar-nav"> <li><a href="/downloads/">Downloads</a> - <li><a href="/documentation/latest/">Documentation</a> + <li><a href="/documentation/in-progress/">Documentation</a> </li> <li class="dropdown"> <a class="dropdown-toggle" data-toggle="dropdown" href="#">Get Involved <span class="caret"></span></a>
