Repository: yetus Updated Branches: refs/heads/asf-site f075f2c02 -> d709aeb59
http://git-wip-us.apache.org/repos/asf/yetus/blob/d709aeb5/documentation/in-progress/precommit-smart-apply-patch/index.html ---------------------------------------------------------------------- diff --git a/documentation/in-progress/precommit-smart-apply-patch/index.html b/documentation/in-progress/precommit-smart-apply-patch/index.html index f5b2159..6f91ae3 100644 --- a/documentation/in-progress/precommit-smart-apply-patch/index.html +++ b/documentation/in-progress/precommit-smart-apply-patch/index.html @@ -118,24 +118,27 @@ under the License. --> -<h1 id="smart-apply-patch">smart-apply-patch</h1> +<h1>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> +<h1>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 + +<pre><code class="bash">$ 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 + +<pre><code class="bash">$ 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 + +<pre><code class="bash">$ smart-apply-patch --committer patch </code></pre> <p>that in addition to applying the patch will also attempt to:</p> @@ -153,7 +156,7 @@ <div class="row-fluid"> <div class="span12 text-left"> <div class="span12"> - Copyright 2008-2015 <a href="http://www.apache.org/";>Apache Software Foundation</a>. Licensed under the <a href="http://www.apache.org/licenses/";>Apache License v2.0</a>. Apache Yetus and the Apache feather logo are trademarks of The Apache Software Foundation. + Copyright 2008-2016 <a href="http://www.apache.org/";>Apache Software Foundation</a>. Licensed under the <a href="http://www.apache.org/licenses/";>Apache License v2.0</a>. Apache Yetus and the Apache feather logo are trademarks of The Apache Software Foundation. </div> </div> http://git-wip-us.apache.org/repos/asf/yetus/blob/d709aeb5/documentation/in-progress/precommit-testformats/index.html ---------------------------------------------------------------------- diff --git a/documentation/in-progress/precommit-testformats/index.html b/documentation/in-progress/precommit-testformats/index.html index a27489b..1b3cd83 100644 --- a/documentation/in-progress/precommit-testformats/index.html +++ b/documentation/in-progress/precommit-testformats/index.html @@ -118,10 +118,11 @@ under the License. --> -<h1 id="test-format-support">Test Format Support</h1> +<h1>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> + +<pre><code class="bash">add_test_format <pluginname> </code></pre> <ul> @@ -144,7 +145,7 @@ <div class="row-fluid"> <div class="span12 text-left"> <div class="span12"> - Copyright 2008-2015 <a href="http://www.apache.org/";>Apache Software Foundation</a>. Licensed under the <a href="http://www.apache.org/licenses/";>Apache License v2.0</a>. Apache Yetus and the Apache feather logo are trademarks of The Apache Software Foundation. + Copyright 2008-2016 <a href="http://www.apache.org/";>Apache Software Foundation</a>. Licensed under the <a href="http://www.apache.org/licenses/";>Apache License v2.0</a>. Apache Yetus and the Apache feather logo are trademarks of The Apache Software Foundation. </div> </div> http://git-wip-us.apache.org/repos/asf/yetus/blob/d709aeb5/documentation/in-progress/releasedocmaker/index.html ---------------------------------------------------------------------- diff --git a/documentation/in-progress/releasedocmaker/index.html b/documentation/in-progress/releasedocmaker/index.html index c196a93..9866119 100644 --- a/documentation/in-progress/releasedocmaker/index.html +++ b/documentation/in-progress/releasedocmaker/index.html @@ -118,7 +118,7 @@ under the License. --> -<h1 id="releasedocmaker">releasedocmaker</h1> +<h1>releasedocmaker</h1> <ul> <li><a href="#Purpose">Purpose</a></li> @@ -130,24 +130,25 @@ <li><a href="#Index_Mode">Index Mode</a></li> </ul> -<h1 id="purpose">Purpose</h1> +<h1>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>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> +<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> +<h1>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> + +<pre><code class="bash">$ releasedocmaker.py --project (project) --version (version) </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> @@ -156,7 +157,7 @@ <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> +<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> @@ -164,60 +165,67 @@ <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 +<p>For example, to build the release documentation for HBase v1.2.0...</p> + +<pre><code class="bash">$ 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>... 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> + +<pre><code class="xml"><!-- markdown --> remaining text </code></pre> -<h1 id="changing-the-header">Changing the Header</h1> +<h1>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> + +<pre><code class="bash">$ releasedocmaker.py --project HBASE --version 1.2.0 --projecttitle "Apache HBase" </code></pre> -<p>Now instead of “HBASE”, it will use “Apache HBASE” for some titles and headers.</p> +<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> +<h1>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 + +<pre><code class="bash">$ 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 + +<pre><code class="bash">$ 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> +<h1>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>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 +<p>The --usetoday option can be used to signify that instead of using Unreleased, releasedocmaker should use today's date.</p> + +<pre><code class="bash">$ 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> +<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> +<h1>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 +<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><code class="bash">$ 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> +<h1>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> @@ -233,7 +241,7 @@ remaining text <div class="row-fluid"> <div class="span12 text-left"> <div class="span12"> - Copyright 2008-2015 <a href="http://www.apache.org/";>Apache Software Foundation</a>. Licensed under the <a href="http://www.apache.org/licenses/";>Apache License v2.0</a>. Apache Yetus and the Apache feather logo are trademarks of The Apache Software Foundation. + Copyright 2008-2016 <a href="http://www.apache.org/";>Apache Software Foundation</a>. Licensed under the <a href="http://www.apache.org/licenses/";>Apache License v2.0</a>. Apache Yetus and the Apache feather logo are trademarks of The Apache Software Foundation. </div> </div> http://git-wip-us.apache.org/repos/asf/yetus/blob/d709aeb5/downloads/index.html ---------------------------------------------------------------------- diff --git a/downloads/index.html b/downloads/index.html index 4465b77..d062521 100644 --- a/downloads/index.html +++ b/downloads/index.html @@ -118,7 +118,7 @@ under the License. --> -<h1 id="apache-yetus-downloads">Apache Yetus Downloads</h1> +<h1>Apache Yetus Downloads</h1> <p>The Apache Yetus project publishes a single source artifact per release for all of our components as well as a convenience artifact of binaries and documentation for immediate use. You @@ -128,7 +128,7 @@ using the <a href="https://dist.apache.org/repos/dist/release/yetus/KEYS";>KEYS f <p>In addition to the artifacts below, we publish convenience artifacts in some third-party repositories (e.g. Maven Central).</p> -<h2 id="releases">Releases</h2> +<h2>Releases</h2> <ul> <li>0.1.0 @@ -148,7 +148,7 @@ third-party repositories (e.g. Maven Central).</p> <div class="row-fluid"> <div class="span12 text-left"> <div class="span12"> - Copyright 2008-2015 <a href="http://www.apache.org/";>Apache Software Foundation</a>. Licensed under the <a href="http://www.apache.org/licenses/";>Apache License v2.0</a>. Apache Yetus and the Apache feather logo are trademarks of The Apache Software Foundation. + Copyright 2008-2016 <a href="http://www.apache.org/";>Apache Software Foundation</a>. Licensed under the <a href="http://www.apache.org/licenses/";>Apache License v2.0</a>. Apache Yetus and the Apache feather logo are trademarks of The Apache Software Foundation. </div> </div> http://git-wip-us.apache.org/repos/asf/yetus/blob/d709aeb5/index.html ---------------------------------------------------------------------- diff --git a/index.html b/index.html index 5299f5f..6f511d7 100644 --- a/index.html +++ b/index.html @@ -122,7 +122,7 @@ <div class="jumbotron"> <h1>Apache Yetus</h1> <div> - <p>… is a collection of libraries and tools that enable contribution and release processes for software projects.</p> + <p>... is a collection of libraries and tools that enable contribution and release processes for software projects.</p> </div> </div> </div> @@ -146,7 +146,7 @@ of <a href="https://en.wikipedia.org/wiki/Gastropoda";>gastropods</a>.</p> <div class="row-fluid"> <div class="span12 text-left"> <div class="span12"> - Copyright 2008-2015 <a href="http://www.apache.org/";>Apache Software Foundation</a>. Licensed under the <a href="http://www.apache.org/licenses/";>Apache License v2.0</a>. Apache Yetus and the Apache feather logo are trademarks of The Apache Software Foundation. + Copyright 2008-2016 <a href="http://www.apache.org/";>Apache Software Foundation</a>. Licensed under the <a href="http://www.apache.org/licenses/";>Apache License v2.0</a>. Apache Yetus and the Apache feather logo are trademarks of The Apache Software Foundation. </div> </div> http://git-wip-us.apache.org/repos/asf/yetus/blob/d709aeb5/mailinglists/index.html ---------------------------------------------------------------------- diff --git a/mailinglists/index.html b/mailinglists/index.html index 3228c57..b0b510b 100644 --- a/mailinglists/index.html +++ b/mailinglists/index.html @@ -118,7 +118,7 @@ under the License. --> -<h1 id="community">Community</h1> +<h1>Community</h1> <div class="row-fluid"> <div class="col-lg-6"> @@ -147,7 +147,7 @@ <div class="row-fluid"> <div class="span12 text-left"> <div class="span12"> - Copyright 2008-2015 <a href="http://www.apache.org/";>Apache Software Foundation</a>. Licensed under the <a href="http://www.apache.org/licenses/";>Apache License v2.0</a>. Apache Yetus and the Apache feather logo are trademarks of The Apache Software Foundation. + Copyright 2008-2016 <a href="http://www.apache.org/";>Apache Software Foundation</a>. Licensed under the <a href="http://www.apache.org/licenses/";>Apache License v2.0</a>. Apache Yetus and the Apache feather logo are trademarks of The Apache Software Foundation. </div> </div>
